Praxis_Bot/README.md
2021-04-22 13:56:48 -04:00

1.9 KiB

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)
pip install -r requirements.txt

python standalone_command.py
python standalone_twitch_script.py
python standalone_discord_script.py

Docker:

Image Setup:

Use these commands to build the images.
docker build --file Dockerfile_standalone_command --tag standalone_command .
docker build --file Dockerfile_standalone_TwitchScript --tag twitchscript_standalone .
docker build --file Dockerfile_standalone_DiscordScript --tag discordscript_standalone .

Docker-Compose Info:

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


# 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.