65 lines
2.4 KiB
Markdown
65 lines
2.4 KiB
Markdown
# Template README
|
|
|
|
<!--summary-->
|
|
Summary goes here
|
|
<!--/summary-->
|
|
|
|
## Features
|
|
|
|
<!--features-->
|
|
- Feature 1
|
|
- Feature 2
|
|
- Feature 3
|
|
<!--/features-->
|
|
|
|
## Invite
|
|
|
|
By inviting this bot to your server you agree to the [terms and conditions](#privacy-statement) laid out in the privacy section of this document.
|
|
If you agree, invite to your server with [this link](https://link-goes-here.com/).
|
|
|
|
## Setup
|
|
|
|
You can ask the bot for help with commands by typing `@bot help`
|
|
|
|
### Use case 1
|
|
|
|
`@bot command <params>`
|
|
Explanation
|
|
|
|
Example:
|
|
`@bot command example-param`
|
|
|
|
## Permissions
|
|
|
|
The bot requires certain permissions, which you are prompted for on the invite screen.
|
|
Each permission has a reason for being required, explained below.
|
|
|
|
| Permission | Reason |
|
|
|---------------|-------------------------------|
|
|
| Read messages | Detect when you use commands |
|
|
| Send messages | Respond when you use commands |
|
|
|
|
## Privacy statement
|
|
|
|
In accordance with the [Discord developer Terms of Service](https://discordapp.com/developers/docs/legal), by inviting this bot to your Discord server you agree that this bot may collect and store the relevant data needed to function, including but not limited to:
|
|
|
|
- Details about the server being joined (server name, server ID, server roles and permissions)
|
|
- Details about the users in the server (usernames, nicknames and user IDs)
|
|
- The contents of messages necessary to function (invoked commands and their parameters)
|
|
|
|
This bot will only collect data which is necessary to function.
|
|
No data collected will be shared with any third parties.
|
|
|
|
Should you wish for the data stored about your server to be removed, please contact me via [my support Discord server](https://discordapp.com/invite/SSkbwSJ) and I will oblige as soon as I am able. Please note that this will require you to remove the bot from your server.
|
|
|
|
## Want to host your own instance?
|
|
|
|
1. Clone the repository, or download and extract the zip file (preferrably from the release page)
|
|
2. Make sure you have *npm* and *git* installed
|
|
3. Run `npm install`
|
|
4. Add *token.json* in the root folder: `{ "token": "your-token-goes-here" }`
|
|
5. Run `npm start`
|
|
|
|
## Need help?
|
|
|
|
I am available for contact via my [support Discord server](https://discordapp.com/invite/SSkbwSJ). I will always do my best to respond, however I am often busy so can't always be available right away, and as this is a free service I may not always be able to resolve your query. |