Reminder / Helper for EPIC RPG.
• Install python 3.8 or higher. I recommend the newest version (3.11).
• Install the third party libraries mentioned in requirements.txt.
• Create a Discord application with a bot user, activate the required intents and generate a bot token.
• Rename default.env to .env and set all required variables mentioned in the file.
• Rename database/default_db.db to database/navi_db.db.
• Upload all emojis in images/emojis to a private server Navi can see.
• Change all emojis in resources/emojis.py to the ones you uploaded.
• Run bot.py.
• Invite Navi to your server(s). Note the required permissions below.
• Replace all .py files.
• Upload emojis and change their ID in resources/emojis.py if there are new ones.
• Restart the bot.
• If the bot requires database changes, it will not start and tell you so. In that case, turn off the bot, BACKUP YOUR DATABASE and run database/update_database.py.
• guilds
• members
• message_content
• messages
• Send Messages
• Embed Links
• Add Reactions
• Use External Emoji
• Read Message History
Navi uses slash commands but also supports some text commands.
Default prefix for text commands is navi and is changeable in /settings server.
Use /help for an overview.
These commands provide bot admin level functionality and are restricted as follows:
• They can only be used by users set in DEV_IDS.
• They are not registered globally and only show up in the servers set in DEV_GUILDS.
• They are not listed in /help.
The following commands are available:
Shows the size of the local message cache. All user messages containing a mention of epic rpg or starting with "rpg " are cached for 1 minute to speed up command detection.
Manually triggers the tracking consolidation. This runs daily at 00:00 UTC, so you probably won't need this.
Manages global event reductions. If there is a global reduction (e.g. 25% on New Year event), you can set this here.
Always check what is actually affected before changing this, it's never all commands even when lume says otherwise. guild, daily and weekly are almost never included for example.
Allows you to send a custom message via Navi to a channel. I use this to post Navi updates.
Allows reloading of cogs and modules on the fly.
Note that you should always restart the bot when there is a breaking change, no matter what.
It's not possible to reload the following files:
• Cogs with slash command definitions. Due to Discord restrictions, you need to restart the whole thing if you change slash commands.
• The file bot.py as this is the main file that is running.
• The file tasks.py. I had mixed results with this, just restart instead.
To reload files in subfolders, use folder.file (e.g. resources.settings). Cogs don't need that, the filename is enough (e.g. adventure).
Lists all servers Navi is in by name.
Shuts down the bot. Note that if the bot is registered as a systemctl or systemd service, it will of course automatically restart.
Shows a link to the dev support server (see below).
Ignore other dev commands, they are my own test commands and might even mess up something for you.
• If you find bugs, have issues running Navi or something else, feel free to join the dev support server.