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-04-28 03:39:37 -04:00
parent 526000d99c
commit 4cabd33b70
1 changed files with 9 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -1,46 +1,30 @@
A chatbot to help with live stream production and effects. An evolving chatbot to help users primarily with live stream production and effects.
___ ___
# Standalone V2 Info # Standalone V2 Info
## Usage:
Run the following to enable these V2 modules without Docker. (After you install requirements)</br>
`pip install -r requirements.txt`</br>
`python standalone_command.py`</br>
`python standalone_twitch_script.py`</br>
`python standalone_discord_script.py`</br>
## Docker: ## Docker:
### Image Setup: ### Image Setup:
Use these commands to build the images.</br> Use these commands to build the images.</br>
`docker build --file Dockerfile_standalone_command --tag standalone_command .`</br> `docker build --file Dockerfile_standalone_command --tag standalone_command .`</br>
`docker build --file Dockerfile_standalone_TwitchScript --tag standalone_twitchscript .`</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_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`</br> `docker-compose up -d`</br>
To Stop: To Stop:
`docker-compose down`</br> `docker-compose down`</br>
</br>
___ ___
~~# V1 Info:~~
~~## Docker:~~
~~### Docker Info:~~
~~Currently to build the container run the following command.~~
~~`docker create -p 2501:2501 -e ISDOCKER=cat --name praxis praxis`~~
___
# Credentials: # Credentials:
## Credentials Setup: ## Credentials Setup:
@ -72,4 +56,6 @@ Token = `https://discord.com/developers/`
Place json credentials in the `/credentials/` folder. Place json credentials in the `/credentials/` folder.
To load them, run `load_credentials()` from `Credentials_Module` in the `credentials.py` script. To load them, run `load_credentials()` from `Credentials_Module` in the `credentials.py` script.
</br>
___ ___