mirror of
https://github.com/wlinator/luminara.git
synced 2024-10-02 18:03:12 +00:00
Update README.md
This commit is contained in:
parent
69ba2601b8
commit
203649c8d7
1 changed files with 48 additions and 3 deletions
51
README.md
51
README.md
|
@ -1,4 +1,49 @@
|
|||
This branch uses Docker and MariaDB to run Racu. It has the exact same functionality within Discord.
|
||||
There is an ".env.template" file, please copy it to `.env` and fill out the details if you want to host Racu yourself.
|
||||
# Racu Discord Bot
|
||||
|
||||
Beware that this branch is much more complicated than the main branch with sqlite3 & PM2, however it is more suitable if you plan to host Racu on a major scale with thousands or millions of Discord servers.
|
||||
## ⚠️ Important Information
|
||||
|
||||
Racu is a Discord bot originally developed for a specific server, but it can now be used anywhere as a self-hosted Python project.
|
||||
**Please note that the main Racu bot is no longer available for server invitations.**
|
||||
|
||||
|
||||
## 🎨 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 and db admin platform 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.**
|
||||
|
||||
```sh
|
||||
git clone https://github.com/Dok4440/racu && cd racu
|
||||
```
|
||||
|
||||
Copy `.env.template` to `.env` and fill out the [variables](#env-keys).
|
||||
|
||||
```sh
|
||||
docker compose up -d --build
|
||||
```
|
||||
|
||||
|
||||
## ⚙️ Environment variables
|
||||
- `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.
|
||||
- `CASH_BALANCE_NAME`: the name of your "cash", e.g. "racu coin".
|
||||
- `SPECIAL_BALANCE_NAME`: the name of the level-up currency that is exchangable for cash.
|
||||
- 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)
|
||||
|
|
Loading…
Reference in a new issue