mirror of
https://gitlab.edgegamers.io/discord/ds-bot.git
synced 2025-12-06 00:22:41 -08:00
Update READEM
This commit is contained in:
30
README.md
30
README.md
@@ -3,8 +3,17 @@
|
||||
|
||||
## Setup
|
||||
1. `git clone git@ssh.gitlab.edgegamers.io:discord/ds-bot.git`
|
||||
2. `npm install`
|
||||
3. `npm run start`
|
||||
2. `mkdir configs && mkdir data`
|
||||
3. `npm install`
|
||||
4. `npm run start`
|
||||
|
||||
## Environment Variables
|
||||
May alternatively be set within the `configs/global.json` file.
|
||||
- APP_DISCORD_TOKEN
|
||||
- APP_MAUL_TOKEN
|
||||
- APP_MAUL_URL
|
||||
- APP_MAUL_IP
|
||||
- APP_MAUL_PORT
|
||||
|
||||
## Features
|
||||
### DS Reaction-Roles
|
||||
@@ -12,9 +21,20 @@ Currently only implemented color roles.
|
||||
Allows users to react to a pre-configured message to receive a role.
|
||||
|
||||
### DS Voice Channels
|
||||
Grants Dedicated Supporters granular control over their voice channels.
|
||||
Grants Dedicated Supporters granular control over their voice channels. Leadership members are granted bypasses of lists.
|
||||
|
||||
- **Resizing**, with each DS tier having a configurable max size.
|
||||
- **Renaming**.
|
||||
- **Hiding** from the public.
|
||||
- **Custom Modes** for easy access management.
|
||||
- Whitelist: Only specified users may join.
|
||||
- Blacklist: All users may join, except specified users.
|
||||
- Public: All users may join.
|
||||
- Locked: Only users currently in the channel may join.
|
||||
- **Muting and Gagging** with each DS tier having a configurable max mute/gag/white/black list size.
|
||||
|
||||
## Configuration
|
||||
All configuration is done through the guild's specific JSON file. Config files are under `/configs/guilds/{guildId}.json`
|
||||
All configuration is done through the guild's specific JSON file. Config files are under `/configs/guilds/{guildId}.json`; Global configuration is only through `/configs/global.json`.
|
||||
|
||||
Each Config is linked to a ConfigEntry.
|
||||
## Data Management
|
||||
Currently, all data is stored in a flat JSON file within the `data/guilds/{guildId}.json` directory. This is subject to change in the future.
|
||||
Reference in New Issue
Block a user