If you would like to join any of the servers associated with the project, Discord server invite links are provided below:
- This bot is written in
Discord.js 14
and requiresNode.js 16.9.0
or higher to run as perDiscord.js 14
requirements. - This bot is designed for the
Sonic Ripping Hub
Discord server and is not meant to work on other servers. - You must have a decent grasp of JavaScript, Node.js and Discord.js to be able to contribute to the project.
- Your test bot account must have all privileged gateway intents enabled to function properly.
- You must invite your test bot account to your testing server with the
bot
andapplications.commands
scopes and theAdministrator
permission via OAuth2.
- YOU NEED TO USE THE LINK GENERATED BY OAuth2 WITH THESE FLAGS TO INVITE THE TEST BOT ACCOUNT TO YOUR TESTING SERVER.
- Fork the repository.
- Run a terminal in the root directory of the project and use the
npm install
command to install all dependencies. - Create a
.env
file in the root directory of the project with the following code snippet inside:
DISCORD_TOKEN=yourtokenhere
- MAKE SURE TO REPLACE
yourtokenhere
WITH YOUR OWN TEST BOT ACCOUNT'S TOKEN. - DO NOT SHARE YOUR TEST BOT ACCOUNT'S TOKEN AS THAT WILL ALLOW OTHERS TO RUN THEIR OWN (AND VERY LIKELY MALICIOUS) CODE ON YOUR TEST BOT ACCOUNT.
- Modify the
config.json
file with your own IDs and role names. - To deploy commands run the
node deploy-commands.js
command in your terminal.
- THIS WILL REGISTER YOUR COMMANDS ONLY IN YOUR TESTING SERVER, THE ID OF WHICH YOU WILL HAVE TO PROVIDE IN THE CONFIGURATION FILE.
- To start the bot use the
node .
command in your terminal (and stop the bot by usingCtrl + C
inside your terminal).