xyter/README.md

27 lines
944 B
Markdown

# Xyter
## Installation
Rename config.json.example to config.json and fill in the fields.
_Please note that mongodb.url needs to be inside of double quotes ("YourURL")._
You can leave any of the **footer** fields empty, it will not impact the bot.
Then run **node deploy-commands.js** the first time then you can start the bot by **node src/index.js**
**Free MongoDB hosting**
- https://atlas.mongodb.com/
## Credits
**Please leave of some credits or if anyone ask about the bot, give them a link to the repository. Thanks!**
## Add it to your server
We have a official bot for this repository. [Invite bot!](https://discord.com/api/oauth2/authorize?client_id=949998000401436673&permissions=8&scope=bot%20applications.commands)
## Contribute
We require developers to sign their work with a GPG key. [How do I sign my work?](https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key)