Praxis_Bot/README.md
2021-04-15 19:33:07 -04:00

48 lines
1.3 KiB
Markdown

A chatbot to help with live stream production and effects.
___
# Docker:
## Docker Info:
Currently to build the container run the following command.
`docker create -p 2501:2501 -e ISDOCKER=cat --name praxis praxis`
To start the bot with **User_Module** activated use this.
`docker exec -ti praxis python3 main.py`
# Credentials:
## Credentials Setup:
Create a json based on the templates and put them into the `/credentials/` folder.
Refer to the `/credential_templates/` folder for examples.
### For Twitch Credentials
Username = `TwitchUsername` *(Must match ***credentialsNickname*** in config)*
Helix Client ID = `https://dev.twitch.tv/console/apps`
Oauth = `https://twitchapps.com/tmi/`
V5 Client ID = `https://twitchtokengenerator.com/`
### For Database Credentials
Nickname = `Anything You Want` *(Must match ***credentialsNickname*** in config)*
Engine = `"mysql+mysqlconnector://root:password@localhost:3306/DatabaseName"`
### For Discord Credentials
Nickname = `Anything You Want` *(Must match ***credentialsNickname*** in config)*
Token = `https://discord.com/developers/`
## Credential Usage:
Place json credentials in the `/credentials/` folder.
To load them, run `load_credentials()` from `Credentials_Module` in the `credentials.py` script.
___