Skip to content

Horde-Of-Greg/Elsa

Repository files navigation

Elsa Avatar

Elsa

Discord Bot to save and execute tags.

Features

  • Add/Send tags that can be created by users.
  • Create JS/TS(/more?) scripts for tags. Runs in a VM. (Coming).
  • Every component of the tags are overridable by server, including banning/putting in a waiting list.
  • Granular permissions. Every action has a configurable permission level attached.
  • Not based on Discord roles, or slash commands.
  • Extensive, configurable logging with automatic log rotations.

External Dependencies

  • PostgreSQL (DB)
  • Redis/Valkey (Caching)
  • zstd (Log Compression)

Get the bot running

1. Clone the repo

git clone git@github.com:Horde-Of-Greg/Elsa-Discord-Tag-Bot.git

2. Set up a PG DB the bot can use

Use docker, figure it out. I'll explain more, mabye.

3. Copy the config templates to their respective files

find . -name '*.template' -exec sh -c 'cp "$0" "${0%.template}"' {} \;

4. Set up the configs

Edit the values in the .env (required) and config/ (required).

See docs/CONFIG.md

5. Run the bot

Production

npm ci # Clean install of dependencies
npm run build # Compile ts to js
npm start # Start the app

Development

npm i # Install dependencies
npm run dev # Start the app without compilation

About

A leveret inspired discord bot. Aims for more granular control.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages