Praxis Bot

Praxis Bot is software that focuses on improving communication and management between people, processes, and services. This bot aims to assist and enhance live streams, digital exhibits, chat rooms, and other countless spaces or venues.

The bot provides and assists with several things like custom commands, channel rewards, stream sources, digital or practical effects, and moderation support, especially across multiple platforms and systems simultaneously.

Table of Contents:

• Requirements
• Docker
• User TTS Speaker
• Dashboard
• Credentials

---

Requirements:

• Docker (For the Standalone Containers)
• Python (Min Version > 3.7 for TTS Speaker)
  (After install remember to use: pip install -r requirements.txt)

---

Docker:

This bot primarily uses docker to run various services. To install Docker for windows visit: https://www.docker.com/get-started

Image Setup:

Use the following command in the terminal to setup all the images after you make the credentials.

Windows: setup.bat
Linux / macOS: setup.sh

Docker-Compose Info:

Use the following command to start up all the standalone containers based on the images you just created after you clone the repository.

To Start:

Windows: start.bat
Linux / macOS: start.sh

To Stop:

Windows: stop.bat
Linux / macOS: stop.sh

---

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
Linux / macOS: praxis-tts-speaker.sh
(Modify these to match the correct directory! Or no work for YOU!!!)
(Also be sure to have requirements setup!!!)

---

Dashboard:

Once Praxis Bot is setup, to access the Dashboard visit localhost:42808(NGINX) or localhost:8000(Django) in your browser.

---

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:

Twitch IRC Chat 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/

Twitch PubSub Credentials:

pubsub_client_id = https://dev.twitch.tv/console/apps Set url to http://localhost:17563
pubsub_secret = ^Look at Instructions Above^

pubsub_AccessToken = Generate by using: python twitch_generate_credentials.py
pubsub_RefreshToken = ^Look at Instructions Above^

For Database Credentials:

Nickname = Anything You Want (Must match credentialsNickname in config)

Engine Example = "postgresql://user:password@ipAddress/DB_NAME_HERE"

For Discord Credentials:

Nickname = Anything You Want (Must match credentialsNickname in config)

Token = https://discord.com/developers/

Phue Credentials:

The lights module will only be able to establish and generate credentials if the button on the bridge is pressed prior to running the script via: python lights_module.py

After running a credential file will be created in the user's home directory on their operating system called .python_hue this can then be moved into the credentials folder.

Credential Usage:

Place json credentials in the /credentials/ folder. To load them, run load_credentials() from Credentials_Module in the credentials.py script.

---

Praxis Bot Development and Technical Support:

If you want to get in on the action and join the conversations that affect this project's long-term development, create cool modules, or have questions join our discord!

Server Link: The Curious Nerd Discord Server

To preview the bot you can check it out on my stream thecuriousnerd.tv This project is used heavily on my stream and is often worked upon during them.

---

Support The Project:

If you wish to support the project, one of the easiest ways to do so is via my patreon or by sending either BTC or Eth

Patreon: https://www.patreon.com/Thecuriousnerd
Bitcoin: 1BFQTkb43bGMSNJjsQtiqai5eQjF5CLcAG
Ethereum: 0x34DE0330ba2CD4030bBbFE9B46D31DeFeE1ffa54

---