vylbot-app/README.md
Vylpes 1b1a070cfd
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
2022-04-09 14:11:06 +01:00

1,018 B

VylBot App

Discord bot for Vylpes' Den Discord Server.

Installation

Download the latest version from the releases page.

Copy the config template file and fill in the strings.

Requirements

  • NodeJS v16
  • Yarn

Usage

Install the dependencies and build the app:

yarn install
yarn build

Setup the database (Recommended to use the docker-compose file)

docker-compose up -d

Copy and edit the settings files

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

yarn start

Alternatively, you can start the bot in development mode using:

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.