alex_orid/Praxis_Bot
2
0
Fork 0
Code Issues 1 Pull Requests Releases Wiki Activity

Updated Readme

Browse Source
This commit is contained in:
Alex Orid 2020-09-23 03:03:18 -04:00
parent 99b303958a
commit ff4c21a747
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,12 +1,15 @@
A chatbot to help with live stream production/effects. A chatbot to help with live stream production and effects.
___ ___
# Credentials Setup: # Credentials:
Create a json based on the templates and put them into the credentials folder. ## Credentials Setup:
## For Twitch Credentials 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` Username = `TwitchUsername`
Helix Client ID = `https://dev.twitch.tv/console/apps` Helix Client ID = `https://dev.twitch.tv/console/apps`
@ -15,5 +18,12 @@ Oauth = `https://twitchapps.com/tmi/`
V5 Client ID = `https://twitchtokengenerator.com/` V5 Client ID = `https://twitchtokengenerator.com/`
## For Database Credentials ### For Database Credentials
Engine = `"mysql+mysqlconnector://root:password@localhost:3306/DatabaseName"` Engine = `"mysql+mysqlconnector://root:password@localhost:3306/DatabaseName"`
## Credential Usage:
Place json credentials in the `/credentials/` folder.
To load them, run `load_credentials()` from `Credentials_Module` in the `credentials.py` script.
___