Praxis_Bot/README.md
2021-04-28 03:39:37 -04:00

61 lines
1.8 KiB
Markdown

An evolving chatbot to help users primarily with live stream production and effects.
___
# Standalone V2 Info
## Docker:
### Image Setup:
Use these commands to build the images.</br>
`docker build --file Dockerfile_standalone_command --tag standalone_command .`</br>
`docker build --file Dockerfile_standalone_channelRewards --tag standalone_channelrewards .`</br>
`docker build --file Dockerfile_standalone_lights --tag standalone_lights .`</br>
`docker build --file Dockerfile_standalone_DiscordScript --tag standalone_discordscript .`</br>
`docker build --file Dockerfile_standalone_TwitchScript --tag standalone_twitchscript .`</br>
`docker build --file Dockerfile_standalone_Twitch_Pubsub --tag standalone_twitch_pubsub .`</br>
### Docker-Compose Info:
To Start:
`docker-compose up -d`</br>
To Stop:
`docker-compose down`</br>
</br>
___
# 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.
</br>
___