master updates #41
31
README.md
31
README.md
@ -2,29 +2,32 @@ An evolving chatbot to help users primarily with live stream production and effe
|
||||
|
||||
___
|
||||
|
||||
# Standalone V2 Info
|
||||
# Praxis Bot
|
||||
|
||||
## Docker:
|
||||
|
||||
This bot primarily uses docker to run various services.
|
||||
### 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>
|
||||
Use the following command to setup all the images.
|
||||
|
||||
Windows: `makedockerimages.bat`<br>
|
||||
Linux: `makedockerimages.sh`
|
||||
|
||||
|
||||
### Docker-Compose Info:
|
||||
|
||||
To Start:
|
||||
`docker-compose up -d`</br>
|
||||
`docker-compose up -d`<br>
|
||||
To Stop:
|
||||
`docker-compose down`</br>
|
||||
</br>
|
||||
`docker-compose down`<br>
|
||||
<br>
|
||||
___
|
||||
|
||||
# Docker:
|
||||
|
||||
|
||||
___
|
||||
# Credentials:
|
||||
|
||||
## Credentials Setup:
|
||||
@ -32,7 +35,7 @@ ___
|
||||
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
|
||||
## For Twitch Credentials:
|
||||
Username = `TwitchUsername` *(Must match ***credentialsNickname*** in config)*
|
||||
|
||||
Helix Client ID = `https://dev.twitch.tv/console/apps`
|
||||
@ -41,12 +44,12 @@ Oauth = `https://twitchapps.com/tmi/`
|
||||
|
||||
V5 Client ID = `https://twitchtokengenerator.com/`
|
||||
|
||||
### For Database Credentials
|
||||
## For Database Credentials:
|
||||
Nickname = `Anything You Want` *(Must match ***credentialsNickname*** in config)*
|
||||
|
||||
Engine = `"mysql+mysqlconnector://root:password@localhost:3306/DatabaseName"`
|
||||
|
||||
### For Discord Credentials
|
||||
## For Discord Credentials:
|
||||
Nickname = `Anything You Want` *(Must match ***credentialsNickname*** in config)*
|
||||
|
||||
Token = `https://discord.com/developers/`
|
||||
|
||||
@ -1,2 +0,0 @@
|
||||
cd "c:\praxis"
|
||||
python "c:\praxis\standalone_user_cli.py"
|
||||
Loading…
Reference in New Issue
Block a user