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 2021-05-13 15:20:04 -04:00
parent 00aca55237
commit ea1a4a4b83
2 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -2,29 +2,32 @@ An evolving chatbot to help users primarily with live stream production and effe
___ ___
# Standalone V2 Info # Praxis Bot
## Docker: ## Docker:
This bot primarily uses docker to run various services.
### Image Setup: ### Image Setup:
Use these commands to build the images.</br> Use the following command to setup all the images.
`docker build --file Dockerfile_standalone_command --tag standalone_command .`</br>
`docker build --file Dockerfile_standalone_channelRewards --tag standalone_channelrewards .`</br> Windows: `makedockerimages.bat`<br>
`docker build --file Dockerfile_standalone_lights --tag standalone_lights .`</br> Linux: `makedockerimages.sh`
`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: ### Docker-Compose Info:
To Start: To Start:
`docker-compose up -d`</br> `docker-compose up -d`<br>
To Stop: To Stop:
`docker-compose down`</br> `docker-compose down`<br>
</br> <br>
___ ___
# Docker:
___
# Credentials: # Credentials:
## Credentials Setup: ## Credentials Setup:
@ -32,7 +35,7 @@ ___
Create a json based on the templates and put them into the `/credentials/` folder. Create a json based on the templates and put them into the `/credentials/` folder.
Refer to the `/credential_templates/` folder for examples. Refer to the `/credential_templates/` folder for examples.
### For Twitch Credentials ## For Twitch Credentials:
Username = `TwitchUsername` *(Must match ***credentialsNickname*** in config)* Username = `TwitchUsername` *(Must match ***credentialsNickname*** in config)*
Helix Client ID = `https://dev.twitch.tv/console/apps` Helix Client ID = `https://dev.twitch.tv/console/apps`
@ -41,12 +44,12 @@ Oauth = `https://twitchapps.com/tmi/`
V5 Client ID = `https://twitchtokengenerator.com/` V5 Client ID = `https://twitchtokengenerator.com/`
### For Database Credentials ## For Database Credentials:
Nickname = `Anything You Want` *(Must match ***credentialsNickname*** in config)* Nickname = `Anything You Want` *(Must match ***credentialsNickname*** in config)*
Engine = `"mysql+mysqlconnector://root:password@localhost:3306/DatabaseName"` Engine = `"mysql+mysqlconnector://root:password@localhost:3306/DatabaseName"`
### For Discord Credentials ## For Discord Credentials:
Nickname = `Anything You Want` *(Must match ***credentialsNickname*** in config)* Nickname = `Anything You Want` *(Must match ***credentialsNickname*** in config)*
Token = `https://discord.com/developers/` Token = `https://discord.com/developers/`

2
praxis-user.bat
View File

@ -1,2 +0,0 @@
cd "c:\praxis"
python "c:\praxis\standalone_user_cli.py"