c972c62ee1
* Improve Logging for moderation * Address Review comments * image logging |
||
---|---|---|
.github/workflows | ||
src | ||
.dockerignore | ||
.eslintrc.json | ||
.gitignore | ||
Dockerfile | ||
LICENSE | ||
README.md | ||
env.json | ||
package.json | ||
tsconfig.json | ||
yarn.lock |
README.md
Setting Up Discord
Create server in Discord.
Create text channel for logs.
Create roles Admins
and Moderators
.
Invite Bot to your Server (see Creating a Bot User below).
Make bot a Moderator.
Install & Dependencies
Install Node.js and Yarn.
Install forever (task scheduler).
yarn global add forever
Clone repository and install package dependencies.
git clone https://github.com/citra-emu/discord-bot.git
cd discord-bot
yarn
Create new JSON file for bot config with the following contents in the directory specified below:
For Development: ./config/development.json
For Production: ./config/production.json
{
"logChannel": "",
"clientLoginToken": ""
}
To get logChannel
, type \#YOUR_CHANNEL_NAME
in your Discord server chat.
Copy string of numbers after #
into "logChannel": ""
Copy App Bot User token to "clientLoginToken": ""
Running Bot
For Production
First yo need to build the project by running yarn build
.
./start.sh
Requires a config/production.json file.
For Development
yarn serve
Requires a config/development.json file.
License
GNU General Public License v2.0
Creating a Bot User.
First you need to go to discord developers and click "New Application"
Now give your bot a name and a picture, a description isn't necessary.
Click "Create Application". On the next page scroll down until you see "Create a bot user", click that. Also click yes do it.
Now you can get your bot's token, by using the "click to reveal button" in the app bot user section. Remember to uncheck Public Bot
There's your token! Now its time to invite your bot to your server. Don't worry about your bot being started for this next step. Change the client_id
in the URL to your Client ID under App Details, then go to this url https://discordapp.com/oauth2/authorize?&client_id=YOUR_CLIENT_ID_HERE&scope=bot&permissions=0
Now select your sever, then click authorize.
That's it! Now you can start your bot.