75 lines
1.9 KiB
Markdown
75 lines
1.9 KiB
Markdown
A chatbot to help with live stream production and effects.
|
|
|
|
___
|
|
|
|
# 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:
|
|
|
|
### 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_TwitchScript --tag twitchscript_standalone .`</br>
|
|
`docker build --file Dockerfile_standalone_DiscordScript --tag discordscript_standalone .`</br>
|
|
|
|
### Docker-Compose Info:
|
|
|
|
To Start:
|
|
`docker-compose up`</br>
|
|
To Stop:
|
|
`docker-compose down`</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 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.
|
|
|
|
___ |