You will need node.js and npm.
First you must install all dependencies.
npm install
After that create a .env file in the root directory, and paste in the following:
DISCORD_CLIENT_ID=CHANGE_ME
DISCORD_GUILD_ID=CHANGE_ME
DISCORD_BOT_TOKEN=CHANGE_ME
You must create an application on:
https://discord.com/developers/applications
This will give you the bot token. The client id is the app id of your application which can also be found there.
The guild id is the id of your server where you test the bot. You can enable developer mode in your discord and copy it. See here:
https://support.discord.com/hc/en-us/articles/206346498
You can then right-click your server in discord and click "Copy Server Id".
Now you must configure the database connection string in config.json. If you are developing locally, its easiest to just use an sqlite file. Once you have done that you must create the database and tables:
npm run createdb
After that, you must register the chat commands at least once. If you add or change a command you must also run this first:
npm run deploycommands
Click on the Run and Debug button on the left and then at the top make sure Debug Discord Bot is selected. You
can now click on the little play button to start debugging. You can set breakpoints and step through the program.
Clicking on the stop button at the top of the screen will close the program and stop debugging.
Typically, pressing F5 will also work.
You may need the appropriate Javascript and Node plugins to do this.
To start debugging/testing with the command line you can make the bot automatically reload itself when you make changes to the code.
Type the following:
npm run dev
Before submitting a Pull Request, please run the following command and fix all errors (if any):
npm run lint
The .env file is the configuration of secrets that should never be known publicly. However we also have a lot
of settings that can just be shared publicly. For this you can change the config.json file.
By default the log level is debug. This is fine for development use. You can change the log level in config.json
"log_level": "info"
You can configure the database connectionstring in config.json by changing the connection_string entry.
There are also other connection strings in there named _a _b etc. Those are just there to easily switch. They
are not used by the program.
You must configure a database string and then run:
npm run createdb
If you want to wipe your database and recreate the tables forcefully you can use:
npm run createdb -- --wipe
WARNING: This permanently wipes the data in your database. Use only during development.
If you were using probot level up system and you want to move the levels/rank to SUDO bot, use:
npm run scrape-levels
Make sure to add this to the .env:
DISCORD_SCRAPE_CHANNEL_ID=
Then run this to import all the ranks to SUDO bot's database:
npm run import-levels