Progressive Victory Bot

Interval PVBot. Responsible for server utilities and metrics and the server-join action from filling the form

Setup

This project uses yarn as a package manager. If you don't have it installed, you can install it with npm install -g yarn.

The following instructions are to be applied in the .env file. If you don't have one, run cp .env.sample .env to create one.

1. CLIENT_ID, TOKEN are discord bot credentials. There's a simple guide available here to accomplish this.
2. TEST_GUILD is the guild ID for testing purposes, for slash commands to only appear in that server. This is an optional variable.
3. OWNERS is a comma separated list of user IDs that should have administrator access to the bot.
4. TRACKING_GUILD is the guild ID for the server that should listen to member activity for the CRM database. For testing purposes, this would probably be equivalent to whatever you'd set in TEST_GUILD.
5. TRACKING_CHANNEL is the logs channel ID, this needs to be a channel that only permits automated system join messages. Those are the kinds of messages you'll see with sticker prompts when someone joins, basically.
6. API_AUTH is the authorization token from this repo, and API_ENDPOINT should match the host for that project. You can leave them both as default if you haven't changed anything there.
7. The default for DB_URI is mongodb://localhost:27017, change as your settings are configured
8. Create a file in src/ called sme.json and make it an empty object.

Running

Run yarn dev

More Reading

For information on how the code works and a more detailed setup guide, refer to the following setup guide.

When considering contributing, refer to the contributing file!