RDMAss
A Python Discord bot creating an interaction with RDM API.
Features
- Assignment Groups scheduled & instant
- RDM Status
- Clear All Quests
- Reload All Instances
Requirements
- Must be on Developemnt build of RDM
- At least Python3.6 (virtualenv optional but welcome)
- Discord Bot Token (enable presence intent, server members intent, message content intent and slash commands privilages)
Quick Setup
- Fetch repo, install packages from
requirements.txtand copyconfig.example.jsontoconfig.json - Edit
config.json - Start
main.py
Detailed Setup
1. Fetch & install
git clone https://github.com/Pupitar/RDMAss.git rdmass && \
cd rdmass && \
pip3 install -r requirements.txt && \
cp config.example.json config.json
2. Edit config file
Additonal options are available in default.json
{
"bot": {
"token": "bot_token", // Discord Bot Token
"hide_bot_message": true // Hide the bot mesage - true | false
},
"instance": {
"discord": {
"guild_id": 1234567890, // Add the Discord Guild ID for the server the bot will be run on
"output_channel": 2345678901, // A discord channel where output of scheduled jobs will be sent.
"enabled_roles": [3456789012, 4567890123] // Discord Role ID's that you authorise to use the commands.
},
"rdm": {
"api_endpoint": "http://127.0.0.1:9000", // RDM front end Endpoint
"username": "rdm_root_user", // RDM front end user (must have admin permissions)
"password": "6d9fdb16ed509488eeef6af2f842a744" // Password for the front end user
}
},
"locale": {
"date_format": "YYYY.MM.DD", // Date format
"time_format": "HH:mm:ss", // Time format
"timezone": "UTC" // Timezone (used for assignement scheduler)
}
}
3. Starting
Directly
python3 main.py
PM2
Start RDMAss in PM2 with pm2 start main.py --name RDMAss --interpreter python3 from the root folder of RDMAss
Or you can copy and paste the following code below into an existing PM2 ecosystem file or start a new one in the root of RDMAss ecosystem.config.js (remember to change the location of cwd: "/home/user/RDMAss/", to your own directory.
module.exports = {
apps: [
{
name: "RDMAss",
script: "python3 main.py",
cwd: "/home/user/rdmass/",
instances: 1,
autorestart: true,
max_memory_restart: "1G",
env_production: {
NODE_ENV: "production",
},
},
],
};
systemd
Systemd user service template. Read for details
[Unit]
Description=rdmass
After=network.target
[Service]
ExecStart=python3 main.py
WorkingDirectory=/home/user/rdmass
Restart=always
RestartSec=10
StandardOutput=syslog
StandardError=syslog
[Install]
WantedBy=default.target
1 Nov 04, 2021
55 Oct 17, 2022
18 Dec 29, 2022
1 Oct 11, 2021
2 Feb 03, 2022
4 Oct 26, 2021
0 Feb 17, 2022
4.5k Dec 30, 2022
820 Jan 02, 2023
12 Oct 27, 2022
3 Jul 06, 2022
129 Dec 10, 2022
21 Nov 18, 2022
1 Apr 01, 2021
0 Jan 20, 2022
219 Oct 03, 2022
1 Jan 25, 2022
8 Aug 23, 2021
56 Dec 30, 2022
138 Dec 15, 2022