Skip to content
This repository has been archived by the owner on Aug 28, 2024. It is now read-only.

Latest commit

 

History

History
95 lines (65 loc) · 4.4 KB

README.md

File metadata and controls

95 lines (65 loc) · 4.4 KB

Lilith Discord Bot Lilith's logo

A Discord.js bot for Diablo 4 that allows tracking events, news and more.

Discord

⚠️ Project Status: Archived

This project has been archived and is no longer actively maintained. You are welcome to fork the repository and continue development on your own, but please note that the original maintainers will not be providing support or accepting contributions.

Contributing

If you want to contribute to this project, please mind joining the Discord server first.

Installation

We recommend using our hosted version of Lilith, but if you want to host it yourself, follow the instructions below.

Requirements

Setup

  1. Clone the repository
git clone https://github.com/lilith-discord-bot/lilith.git
  1. Install dependencies
npm install
  1. Create a .env file in the root directory with the .env.template and refer to the Environment variables section for more information:
cp .env.template .env
  1. Start the bot
npm run bot:up

Other commands:

  • npm run bot:stop - Stop the bot
  • npm run bot:restart - Restart the bot
  • npm run bot:rebuild - Rebuild the bot

If you're running docker, you can just use this, but you still have to run Redis and a database, if you don't wanna bother with that, npm run bot:up sets everything up for you using compose.

docker run --name bot \
    -e TOKEN=your_token \
    -e POSTGRES_DATABASE=your_database \
    -e POSTGRES_HOST=your_host \
    -e POSTGRES_PASSWORD=your_password \
    -e POSTGRES_USER=your_user \
    -e POSTGRES_PORT=your_port \
    -e DATABASE_URL=your_database_url \
    -e REDIS_HOST=your_redis_host \
    -e REDIS_PASSWORD=your_redis_password \
    -d ghcr.io/lilith-discord-bot/lilith:main

Environment variables

Environment Variable Description Example Default
TOKEN Your Discord application bot token MODcxMTY4MgwMFA1MTExNzkzY0.YGm7oQ.AXHbbfpSxi_Cpk1B1Vz_DGV0A0i62NS_XPBCpf N\A
POSTGRES_DATABASE Postgres database name lilith N\A
POSTGRES_HOST Hostname for conneting to Postgres (empty if running with Docker) lilith N\A
POSTGRES_PASSWORD Postgres database connection password lilith N\A
POSTGRES_USER Postgres database connection user lilith N\A
POSTGRES_PORT Postgres database connection port 5432 5432
DATABASE_URL Prisma database connection URL postgresql://user:password@host:5432/database N\A
REDIS_HOST Hostname for conneting to Redis (empty if running with Docker) lilith N\A
REDIS_PASSWORD Redis database connection password lilith N\A

Issues

If you find a bug or have a feature request, please open an issue on GitHub.

License

This project is licensed under the MIT License.