Lumin is a general purpose Twitch bot that specializes in a more interactive chat experience.
Lumin currently supports chat integration for the following games:
- Valorant - Special thanks to Henrik for the ValorantAPI
- osu! - Special thanks to Tillerino for the ppAddictAPI & thanks to Mr HeliX for the huismetbenenAPI
with many more being planned.
In addition to game integration, Lumin offers a range of non-game related features to enhance your Twitch channel:
- Custom Commands
- Watchstreaks
- Firsts
Feel free to explore these features and customize Lumin to create an engaging and interactive experience for your Twitch community!
- Python 3.10+
Library requirements can be installed with:
pip install -r requirements.txt
Make sure you have added and configured your .env file
# Twitch Authorization
TWITCH_NICK=LuminBotTV
TWITCH_TOKEN=
TWITCH_CLIENTID=
TWITCH_CLIENTSECRET=
# Osu Authorization
# Can be left blank if not needed, but osu.py will stop functioning
PP_ADDICT_APIKEY=
OSU_V1_APIKEY=
# HenrikDev (valorant) Authorization
# Can be left blank, and will still allow 30 requests per minute.
HENRIK_DEV_APIKEY=
# Do you want people to be able to add your bot to their channel with !register
BOT_PUBLIC=true
The bot can then be run with the command:
python main.py
We welcome contributions to enhance Lumin and make it even more powerful! To contribute, follow these steps:
- Clone the repository:
git clone https://github.com/IanRockwell/LuminBot.git
-
Make your changes in the local repository.
-
Add, commit, and push your changes:
git add .
git commit -m "Description of your changes"
git push
- Create a pull request on the Lumin GitHub repository to submit your changes.
Thank you for your contribution! 🎉