dragid10 / lazarus-bot

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status

Lazarus Discord Bot

A discord bot that automatically unarchives threads as soon as they're archived.

Install link

Usage

Use Lazarus Bot in discord

  1. Invite the bot to the channel in which you'd like it to revive threads

  2. Ensure the bot has the Manage Messages and Threads permission in the channel

  3. Use /keeepalive-on inside of a thread if you'd like Lazarus Bot to automatically revive threads

  4. Use /keeepalive-off inside of a thread if you'd like Lazarus Bot to stop automatically reviving threads

Documentation

Tech Stack

Python: 3.9+

Dependency Manager: Poetry

Discord package: Py-Cord

Unit Test Runner: Pytest

Deployment

To deploy this project:

  1. Template this repo
  2. Clone and cd into the repo
  3. Run make setup to automatically install poetry
  4. Run make update && make install to update and install production dependencies
  5. Alternatively, you can run make install-dev or make install-test to install all dev dependencies or test dependencies respectively

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

  • Clone the .env-sample file and rename it .env
  • If you're using a .env file, then the environment variables will be set automatically(thanks to dotenv)
    • Otherwise you can export each of the environment variables manually
     export bot_token=<bot_token>

[Discord]

bot_token: String

[Redis]

redis_user: String
redis_password: String
redis_host: String
redis_port: Int

About


Languages

Language:Python 94.3%Language:Dockerfile 3.8%Language:Makefile 2.0%