Luminara/Lumi
Luminara/Lumi
1
Fork 0
mirror of https://github.com/wlinator/luminara.git synced 2024-10-02 20:23:12 +00:00
Code Activity
Mirror of the Github repository https://github.com/wlinator/luminara
195 commits 5 branches 94 tags 4.8 MiB
Python 99.8%
Dockerfile 0.2%
Find a file
wlinator c37fd0e743 Add error embeds
2024-03-17 15:18:24 +01:00
art Start bridge commands 2024-03-16 15:05:40 +01:00
config Make birthdays a global system 2024-03-08 06:16:42 -05:00
db Check for the prefix in the database (per guild) 2024-03-16 20:44:46 +01:00
handlers Fix lib/checks to check guild_config.commands_channel 2024-03-16 00:04:31 +01:00
lib Add error embeds 2024-03-17 15:18:24 +01:00
modules Add error embeds 2024-03-17 15:18:24 +01:00
services Make a custom Racu help feature 2024-03-17 13:59:13 +01:00
.env.template Integrate guild_id in XP service 2024-03-15 21:01:33 +01:00
.gitignore Update .gitignore 2024-03-07 13:19:41 -05:00
docker-compose.yml add Dozzle logger 2024-02-29 20:02:30 +00:00
Dockerfile Revert Dockerfile changes for speed 2024-03-16 20:58:39 +01:00
LICENSE init - clone from personal Git 2023-06-19 10:20:17 -04:00
main.py Add error embeds 2024-03-17 15:18:24 +01:00
README.md Update README.md 2024-03-15 23:18:13 +00:00
requirements.txt Upgrade to pycord v2.5 2024-03-16 21:09:03 +01:00
users.yml.example Add Dozzle examples 2024-03-01 12:37:13 +01:00

README.md

Racu v2

⚠️ Important Information

This branch is in development and will be unstable. The purpose of v2 is to make Racu available Discord-wide, rather than tailor-made for one server. This information below is unedited and is meant for the stable version of racu v1 (main branch).

🎨 Features

  • XP System: Earn experience points (XP) with amusing and sometimes sarcastic level-up messages (can be disabled).
  • Economy System: Engage in various economy-related activities, including:
    • Blackjack
    • Slots
    • Duels
    • Daily Rewards to keep players engaged
  • Simple Moderation Module: Manage server moderation tasks.
  • Currency and Level Stats: Track user currency and levels.
  • Server Introductions: Automatically post server introductions in a designated channel.
  • Reaction Handler: Customize bot reactions to specific messages.

📲 Installation

Racu is containerized: its core, database, database admin platform and logger run on Docker without any extra configuration. However, you CAN run it locally without Docker by hosting MariaDB on your machine with the login credentials specified in .env and installing Python 3.11 with the required pip packages. Note: I won't explain how to do this. Figure it out on your own.

git clone https://gitlab.com/wlinator/racu && cd racu

Copy .env.template to .env and fill out the variables.

Optional: copy users.yml.example to users.yml to properly configure Dozzle logs. Check the file for more information.

docker compose up -d --build

⚙️ Environment variables

  • TOKEN: your Discord Bot Token, you can get this here.
  • INSTANCE: this should always be "MAIN" unless you plan to run multiple bots (for testing purposes).
  • OWNER_ID: the Discord user ID of the person who will act as owner of this bot.
  • XP_GAIN: a comma-seperated list of XP gain values, Racu randomly picks one on each message.
  • COOLDOWN: a comma-seperated list of cooldown times, this is to prevent botting XP.
  • The values with "DBX" can be ignored unless you plan to make database backups with Dropbox. In that case enter your Dropbox API credentials.
  • MARIADB_USER: the username for your MariaDB database.
  • MARIADB_PASSWORD: the password for your database.
  • MARIADB_ROOT_PASSWORD: the root password for your database. (can be ignored unless you have a specific use for it)