Urpagin/gollum-izle
1
0
Fork 0
mirror of https://github.com/Urpagin/gollum-izle.git synced 2025-08-21 18:28:01 +02:00
Code Issues Projects Packages Wiki Activity
A multipurpose Python bot.
8 commits 1 branch 0 tags 181 KiB
Find a file
Exact
Urpagin 81cff4719f
 Update README.md
2025-08-16 11:37:16 +02:00
src Add custom presence 2025-07-28 01:54:43 +02:00
.dockerignore Add Docker Compose && README 2025-07-28 01:13:58 +02:00
.env.example Add custom presence 2025-07-28 01:54:43 +02:00
.gitignore Initial commit 2025-07-28 00:32:03 +02:00
docker-compose.yml Add Docker Compose && README 2025-07-28 01:13:58 +02:00
Dockerfile Add Docker Compose && README 2025-07-28 01:13:58 +02:00
LICENSE Initial commit 2025-07-28 00:24:49 +02:00
README.md Update README.md 2025-08-16 11:37:16 +02:00
requirements.txt Initial commit 2025-07-28 00:32:03 +02:00

README.md

🤖 gollum-izle

A multipurpose Python bot.

📖 Context & Explanation

This was the first Discord bot I ever wrote in Python.

This codebase is old compared to now, and I only verified it by manually testing the commands when putting the code on GitHub. Thus, many bugs or inefficiencies may be hidden in plain sight.

Concerning old and now:

  • Now: 2025-07-28
  • Oldest recorded version: 2023-01-11 14:48:20
  • Version used as base: 2023-06-26 16:12:55

✨ Features

  • /mcping <address> [hidden]: Shows information about a Minecraft server and includes a fun fact. mcping

  • /randserver [count] [only_digits] [hidden]: Returns a list of online Minecraft servers selected from the ./src/online-mc-servers.json file. [only_digits] returns only servers with bare IPv4 addresses. randserver

  • /latest <youtuber> [prior_to] [hidden]: Shows the latest [prior_to] videos from the specified <youtuber>. latest

  • /export [format(txt,csv)]: Exports the current text channel into a file. export

Arguments in angle brackets <> are mandatory. Arguments in square brackets [] are optional. The [hidden] boolean makes the response ephemeral (visible only to the command sender).

🚀 Installation

🐳 Docker Compose (recommended)

  1. Clone the repository and navigate into it:
git clone https://github.com/Urpagin/gollum-izle.git
cd gollum-izle

  1. Copy the .env.example file to .env and populate it according to the instructions within.

  2. Start the bot using Docker Compose:

sudo docker compose up -d

🐍 Python

  1. Clone the repository and navigate into it:
git clone https://github.com/Urpagin/gollum-izle.git
cd gollum-izle

  1. Copy the .env.example file to .env and populate it according to the instructions within.

  2. Install dependencies (Python >=3.11, tested on 3.13):

pip install -r requirements.txt
  1. Start the bot (ensure you are in the root directory):
python -m src.main

🛠️ To Fix / To Do

  • Use temporary files instead of saving files directly to a tangible directory.
  • Add video thumbnail in /latest command.
  • Fix /mcping favicon not working each time.