TourneyBot

Usage

Hosting Instructions

Want to host TourneyBot? That's great! Here's how you do it.

Installation

1. Install NodeJS and MongoDB's community server.
2. Clone the repository.
3. In a terminal, enter $npm install.
4. Edit credentials.js.TEMPLATE. You will need accounts on these sites.
   • Discord API token: Go to "My Apps", create a new app, and add a bot user. Use the token under "App Bot User".
   • Challonge API token: Go to "Settings", "Developer API", and generate an API key. Use that.
5. TODO: db initialization (mongoose)

Running the bot

After installing, to actually run TourneyBot you will need to do a couple things.

1. Run MongoDB on your computer. For instructions, click here, select the installation guide for your OS and scroll down to "Run MongoDB".
2. Make a link to add Tourneybot to servers.
   1. Get your Client ID. Visit the Discord API site, go to "My Apps", click on the app, and under "App Details" copy the Client ID.
   2. Open this permissions calculator.
   3. Where it says "Insert Client ID here", insert your client ID.
   4. Check the boxes for THESE PERMISSIONS (TODO).
3. In a terminal, enter $npm run start.
4. Open or share the link you created to add the bot to whatever servers you wish.

Deployment

TODO

Contribute

Thank you!! Please see CONTRIBUTE.md.

License

TODO