Praxis_Bot/README.md
2021-05-13 15:20:51 -04:00

1.5 KiB

An evolving chatbot to help users primarily with live stream production and effects.


Praxis Bot

Docker:

This bot primarily uses docker to run various services.

Image Setup:

Use the following command to setup all the images.

Windows: makedockerimages.bat
Linux: makedockerimages.sh

Docker-Compose Info:

To Start: docker-compose up -d
To Stop: docker-compose down


Python Scripts:

User TTS Speaker:

To receive audio from standalone_tt_core.py launch standalone_tts_speaker.py.

python standalone_tts_speaker.py

or

windows: praxis-tts-speaker.bat


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.