115 lines
3.3 KiB
Markdown
115 lines
3.3 KiB
Markdown
# Praxis Bot
|
|
|
|
Praxis_Bot is a piece of software that's primarily focusing on improving communication and management between different processes and services, in order to run commands and enhance experiences in various spaces. (ie. IRL, Live Streams, Chat Rooms, Other Digital Spaces)
|
|
|
|
This bot aims to assist and enhance live streams, digital exhibits, chat rooms, and other spaces. The bot provides and assists with several things like commands, channel rewards, stream sources, digital or practical effects, and moderation support, especially across various different platforms simultaneously.
|
|
|
|
<br>
|
|
|
|
___
|
|
|
|
# Docker:
|
|
|
|
This bot primarily uses docker to run various services.
|
|
## Image Setup:
|
|
|
|
Use the following command to setup all the images.
|
|
|
|
Windows: `makedockerimages.bat`<br>
|
|
Linux: `makedockerimages.sh`
|
|
|
|
|
|
## Docker-Compose Info:
|
|
|
|
To Start:
|
|
`docker-compose up -d`<br>
|
|
To Stop:
|
|
`docker-compose down`<br>
|
|
<br>
|
|
___
|
|
|
|
# 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` Modify this to match the correct directory! Or no work for YOU!!!<br>
|
|
linux: `praxis-tts-speaker.sh`<br>
|
|
<br>
|
|
___
|
|
|
|
# User Web Client:
|
|
|
|
To access the User Client visit `index.html` from `\user_client\v1\` in your browser.<br>
|
|
<br>
|
|
___
|
|
|
|
# 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.<br>
|
|
<br>
|
|
|
|
## 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^`<br>
|
|
<br>
|
|
|
|
## For Database Credentials:
|
|
Will be replaced soon.<br>The current `db.py` file is not being used for now.<br>
|
|
~~Nickname = `Anything You Want` *(Must match ***credentialsNickname*** in config)*~~
|
|
|
|
~~Engine = `"mysql+mysqlconnector://root:password@localhost:3306/DatabaseName"`~~<br>
|
|
<br>
|
|
|
|
## For Discord Credentials:
|
|
Nickname = `Anything You Want` *(Must match ***credentialsNickname*** in config)*
|
|
|
|
Token = `https://discord.com/developers/`<br>
|
|
<br>
|
|
|
|
## 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`<br>
|
|
|
|
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.<br>
|
|
<br>
|
|
|
|
## Credential Usage:
|
|
|
|
Place json credentials in the `/credentials/` folder.
|
|
To load them, run `load_credentials()` from `Credentials_Module` in the `credentials.py` script.
|
|
|
|
</br>
|
|
|
|
___
|
|
|
|
# Support The Project:
|
|
|
|
If you wish to support the project, the easiest way to do so is by sending either BTC or Eth
|
|
|
|
Bitcoin: `1BFQTkb43bGMSNJjsQtiqai5eQjF5CLcAG`<br>
|
|
Ethereum: `0x34DE0330ba2CD4030bBbFE9B46D31DeFeE1ffa54`
|
|
|
|
</br>
|
|
|
|
___ |