another-chill-spring
/
discord-bot-template
Template
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
1 Commit 1 Branch 0 Tags 37 KiB
TypeScript 55%
Makefile 45%
Go to file Use this template
Aymeric GUERACAGUE 86ce08bd0a
✨ init repo 		2022-07-03 15:06:52 +02:00
src ✨ init repo 2022-07-03 15:06:52 +02:00
.gitignore ✨ init repo 2022-07-03 15:06:52 +02:00
Makefile ✨ init repo 2022-07-03 15:06:52 +02:00
README.md ✨ init repo 2022-07-03 15:06:52 +02:00
config.exemple.toml ✨ init repo 2022-07-03 15:06:52 +02:00
docker-compose.yaml ✨ init repo 2022-07-03 15:06:52 +02:00
package.json ✨ init repo 2022-07-03 15:06:52 +02:00
tsconfig.json ✨ init repo 2022-07-03 15:06:52 +02:00
yarn.lock ✨ init repo 2022-07-03 15:06:52 +02:00

README.md

Discord Bot Template

Discord Bot Template for Another Child Spring server

Requirement

How to install

  1. Clone the repo
  2. Copy the config.exemple.toml and rename it config.toml
  3. Launch the docker container with make start or docker-compose up -d
  4. Go into the docker container with make shell or docker-compose exec discord-bot bash
  5. Install the dependencies: yarn install
  6. Compile typescript and run the bot with yarn dev

Notes

  • Configuration file format is TOML. It is a minimal configuration file format that's easy to read due to obvious semantics. TOML is designed to map unambiguously to a hash table. TOML should be easy to parse into data structures in a wide variety of languages. Read src/config.ts to see all possibilities.

Contributions/License

This project has an AGPLv3 license. This project use the Sheweny framework with discord.js underlying and BinaryMuse/toml-node for configuration parsing.