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

Latest commit

 

History

History
99 lines (71 loc) · 3.67 KB

README.md

File metadata and controls

99 lines (71 loc) · 3.67 KB
Raw

BSZET_IT_BOT (Archived)

🚀 Why Is This Project Archived?

Our school has introduced an official app that provides real-time timetable updates, rendering this bot obsolete. While it was a helpful tool during its time, this repository will no longer be maintained or updated.

🛑 Archive Notice

As of 08.09.2024, this project is officially archived. No further updates or bug fixes will be provided. Feel free to explore the code, but please note that it might not work with the current systems in place at our school.

current username + password:

  • username: bsz-et-2324
  • password: schulleiter#23

Usage

invite the bot to your discord via https://discord.com/oauth2/authorize?client_id=1150762234620944464&permissions=8&scope=bot

and type /activate in your discord server to activate the bot

Self-Hosting with Docker-Compose

version: '3'

services:
  schulbot:
    image: ghcr.io/katze719/bszet_it_bot:latest
    restart: always
    environment:
      DISCORD_BOT_TOKEN: ${DISCORD_BOT_TOKEN}
    volumes:
      - ./settings:/settings
mkdir settings
docker-compose up -d

Activate the Bot with the command /activate

Updating the Bot

docker-compose down
docker pull ghcr.io/katze719/bszet_it_bot:latest
docker-compose up -d

Commands

Admin Commands

Command Description
/activate Activates the bot
/deactivate Deactivates the bot
/deactivate_experimental_features Deactivates experimental features
/activate_experimental_features Activates experimental features
/set <variable_name> <value> Sets the specified variable to the given value
/reset Resets all variables to their default values

User Commands

Command Description Requires Experimental Features to be on
/help Displays a help message false
/ping Checks the bot's responsiveness false
/plan Retrieves the current plan false
/get <variable_name> Retrieves the value of the specified variable false
/status Checks if the bot is currently active false
/feedback <message> Submits user feedback false
/print_parsed_table_experimental Displays the parsed table true
/news_experimental Retrieves the latest news true

Dev Setup

  1. Setup venv
git clone https://github.com/Katze719/BSZET_IT_BOT.git;
cd BSZET_IT_BOT;
python3 -m venv venv;
source ./venv/bin/activate;
pip install -r requirements.txt;
  1. Run the bot
export DISCORD_BOT_TOKEN="<my token>"
python3 ./bot.py