Vylpes
04a4a6204c
* Change rules.txt to rules.json (#31) * Migrate to yarn * Add role configs to config template * Install packges and setup typescript * Migrate entry point * Migrate about command * Migrate ban command * Migrate clear command * Migrate kick command * Migrate mute command * Migrate poll command * Migrate bunny command * Update required roles checker * Migrate role command * Migrate unmute command * Migrate warn command * Migrate eval command * Migrate help command * Migrate rules command * Migrate events to typescript * Update about command to use the PublicEmbed class * Update ErrorMessage to ChannelNotFound * Update messageDelete event to ignore bots * Feature/74 merge vylbot core (#80) * Merge VylBot-Core * Update commands to new system * Fix issue where events would not load * Feature/12 create tests (#102) * Fix tests * Update coverage * Remove unrequired mock files * Add about command test * Update about tests * Ban command tests * eval command tests * Start help command tests * Add help command tests * Add kick command tests * Mute command tests * Poll command tests * Add role command tests Signed-off-by: Ethan Lane <ethan@vylpes.com> * Add rules command tests * Add unmute command tests * Add warn command tests * Add MemberEvents tests * Add GuildMemberUpdate tests Signed-off-by: Ethan Lane <ethan@vylpes.com> * Add MessageEvents tests * Add StringTools test Signed-off-by: Ethan Lane <ethan@vylpes.com> * Add embed tests Signed-off-by: Ethan Lane <ethan@vylpes.com> * Add GitHub Actions Signed-off-by: Ethan Lane <ethan@vylpes.com> * Move to tslint Signed-off-by: Ethan Lane <ethan@vylpes.com> * Remove tslint Signed-off-by: Ethan Lane <ethan@vylpes.com> * Remove linting script Signed-off-by: Ethan Lane <ethan@vylpes.com> * Update rules with blog website and event spoilers rule" (#106) Signed-off-by: Ethan Lane <ethan@vylpes.com> * Containerise bot (#107) * Add moderator names to audit reason (#108) * Feature/48 database (#114) * Add database and default values * Add ability to save a setting to the database * Get commands and events to use database * Setup and config command * Update commands to check roles per server * Different rules per server Signed-off-by: Ethan Lane <ethan@vylpes.com> * Different prefix per server Signed-off-by: Ethan Lane <ethan@vylpes.com> * Add verification system Signed-off-by: Ethan Lane <ethan@vylpes.com> * Disabled commands per server * Add devmode for default prefix * Update embeds * Fix broken tests * Feature/66 add different commands per server (#122) * Add ability for server exclusive commands * Add MankBot server-exclusive commands * Add lobby entity to database * Add documentation * Add setup command for lobby (#123) * Update bot to discord.js v13 (#125) * Update bot to discord.js v13 * Remove debug code * 110 commandshelp about command errors which causes command to not run (#126) * Change onMessage to onMessageCreate * Fix help command * Add override for bot owner and server owner (#135) * Change help command so exclusive commands can only be seen for the server they're assigned to (#136) * Change parsing to not crash if invalid (#142) * 137 role command cannot read properties of undefined (#141) * Fix issue with bot crashing * Fix server prefix not showing * Add easy way to configure role command * Move help text to its own directory * Make role config command to use role id * Get lobby command to use IDs instead of names (#144) Co-authored-by: Vylpes <getgravitysoftware@gmail.com>
55 lines
No EOL
1,018 B
Markdown
55 lines
No EOL
1,018 B
Markdown
# VylBot App
|
|
|
|
Discord bot for Vylpes' Den Discord Server.
|
|
|
|
## Installation
|
|
|
|
Download the latest version from the [releases page](https://github.com/Vylpes/vylbot-app/releases).
|
|
|
|
Copy the config template file and fill in the strings.
|
|
|
|
## Requirements
|
|
|
|
- NodeJS v16
|
|
- Yarn
|
|
|
|
## Usage
|
|
|
|
Install the dependencies and build the app:
|
|
|
|
```bash
|
|
yarn install
|
|
yarn build
|
|
```
|
|
|
|
Setup the database (Recommended to use the docker-compose file)
|
|
|
|
```bash
|
|
docker-compose up -d
|
|
```
|
|
|
|
Copy and edit the settings files
|
|
|
|
```bash
|
|
cp .env.template .env
|
|
# Edit the .env file
|
|
|
|
cp ormconfig.json.template ormconfig.json
|
|
# Edit the ormconfig.json file
|
|
```
|
|
|
|
> **NOTE:** Make sure you do *not* check in these files! These contain sensitive information and should be treated as private.
|
|
|
|
Start the bot
|
|
|
|
```bash
|
|
yarn start
|
|
```
|
|
|
|
Alternatively, you can start the bot in development mode using:
|
|
|
|
```bash
|
|
yarn start --dev
|
|
```
|
|
|
|
> Dev mode ensures that the default prefix is different to the production mode, in case you have both running in the same server. |