Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pietw3lve/tuxbrain-bot
A bot for the Tuxbrain servers.
https://github.com/pietw3lve/tuxbrain-bot
discord-bot hikari-lightbulb hikari-miru hikari-py moderation music pokemon rushsite tuxbrain
Last synced: about 1 month ago
JSON representation
A bot for the Tuxbrain servers.
- Host: GitHub
- URL: https://github.com/pietw3lve/tuxbrain-bot
- Owner: PieTw3lve
- License: gpl-3.0
- Created: 2022-12-05T21:23:12.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-15T08:44:59.000Z (4 months ago)
- Last Synced: 2024-08-15T10:17:02.426Z (4 months ago)
- Topics: discord-bot, hikari-lightbulb, hikari-miru, hikari-py, moderation, music, pokemon, rushsite, tuxbrain
- Language: Python
- Homepage:
- Size: 108 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Tuxbrain Bot
Tuxbrain Bot is an open source, multi-use Discord bot written in hikari.py, a new static-typed Python API wrapper. The bot is currently still in development, so there may be some bugs. Although it was designed for Tuxbrain.org servers, the bot can be hosted and used on any server.
### Features
- Profile Customization: `profile`, `set`, `shop`!
- Economy Integration: `leaderboard`, `daily`, `pay`, and **6** more!
- Music Player: `play`, `controller`, `join`, and `leave`!
- Interactive Games: `fish`, `russian-roulette`, `rps`, `connect4`, `blackjack`, and `hangman`!
- Tuxbrain Rushsite Integration: `register`, `search`, `top`, and `strike`!
- Moderation: `broadcast`, `purge`, `translator` and **6** more!
- Fun/Useless Commands: `random`, `fact`, and `wotd`!
### Installation
1. Clone the repository to your local machine.
```
git clone https://github.com/PieTw3lve/Tuxbrain-Bot.git
```
2. Install the required dependencies.
```
pip install -r requirements.txt --no-dependencies
```
3. Set up and operate a [Lavalink](https://github.com/lavalink-devs/Lavalink) server to enable music playback.
```
cd Lavalink
java -jar Lavalink.jar
```
### How to run the Bot
> [!IMPORTANT]
> Tuxbrain Bot requires Python 3.11.0 or later to run.
1. Generate settings.json by running the bot.py file once.
2. Fill in the settings.json file with your bot token, guild ids, and other necessary information.
3. Enable all intents through the [Discord Developer Portal](https://discord.com/developers/applications).
4. Run the bot.py file again to start the bot.
```
cd src
python3.11 -O bot.py
```
### Further readings
- Hikari: https://github.com/hikari-py/hikari
- Lightbulb: https://github.com/tandemdude/hikari-lightbulb
- Miru: https://github.com/HyperGH/hikari-miru
- Lavalink: https://github.com/Devoxin/Lavalink.py
- Deep Translator: https://github.com/nidhaloff/deep-translator#chatgpt-translator
- Lingua: https://github.com/pemistahl/lingua-py