1
Fork 0
mirror of https://github.com/wlinator/luminara.git synced 2024-10-02 18:23:12 +00:00

Update README.md

This commit is contained in:
wlinator 2024-03-19 13:08:55 +00:00
parent 15cc4b91a6
commit 44dda03123

View file

@ -1,25 +1,11 @@
# Racu v2
# You can invite me with [this link](https://discord.com/oauth2/authorize?client_id=1038050427272429588&permissions=8&scope=bot). Thanks for using Racu!
## ⚠️ Important Information
![Racu art](art/mothra.png)
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).
## Self host
**The next part of this README explains how to self-host Racu, this allows you to host your own version of my code and create a personalized Discord bot.**
## 🎨 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
### 📲 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](.env.template) and installing **Python 3.11** with the [required pip packages](requirements.txt). **Note: I won't explain how to do this. Figure it out on your own.**
@ -40,9 +26,12 @@ docker compose up -d --build
- `TOKEN`: your Discord Bot Token, you can get this [here](https://discord.com/developers/applications).
- `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.
- `XP_GAIN_PER_MESSAGE`: how much XP should be awarded to a user per message.
- `XP_GAIN_COOLDOWN`: XP earning cooldown time in seconds.
- 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)