Added readme

This commit is contained in:
G2-Games 2025-01-19 16:48:47 -06:00
parent 534b2df0bf
commit 7a52e42555

View file

@ -0,0 +1,26 @@
# Oden
Oden Music Bot (OMB) is a Discord music bot intended to be selfhosted!
## Running
Running requires using [`uv (https://docs.astral.sh/uv/)`](https://docs.astral.sh/uv/).
You also have to obtain a bot token. Follow the section of this tutorial labeled
"Creating an app" to see how to do that:
https://discord.com/developers/docs/tutorials/configuring-app-metadata-for-linked-roles#creating-an-app
After installing `uv` and obtaining a bot token, clone the repository.
```bash
git clone https://github.com/Dangoware/oden-music-bot.git
cd oden-music-bot
```
Put your bot token into an environment variable called `ODEN_DISCORD_SECRET`,
then run the bot.
```bash
uv run oden
```
Enjoy!