Polishing
This commit is contained in:
parent
ae3b22ff35
commit
5c214ba769
34
README.md
34
README.md
@ -1,8 +1,17 @@
|
||||
# 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)
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
<br>
|
||||
|
||||
___
|
||||
|
||||
# Requirements:
|
||||
- Docker (For the Standalone Service Containers)
|
||||
- Python (Min Version > 3.7 for TTS Speaker)<br>
|
||||
(Remember to use `pip install -r requirements.txt`)
|
||||
|
||||
<br>
|
||||
|
||||
@ -11,9 +20,11 @@ ___
|
||||
# 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 to setup all the images.
|
||||
Use the following command in the terminal to setup all the images.
|
||||
|
||||
Windows: `makedockerimages.bat`<br>
|
||||
Linux: `makedockerimages.sh`
|
||||
@ -35,14 +46,14 @@ To receive audio from standalone_tt_core.py launch standalone_tts_speaker.py.
|
||||
|
||||
or
|
||||
|
||||
windows: `praxis-tts-speaker.bat` Modify this to match the correct directory! Or no work for YOU!!!<br>
|
||||
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>
|
||||
Once Praxis_Bot is setup, to access the User Client visit `index.html` from `\user_client\v1\` in your browser.<br>
|
||||
<br>
|
||||
___
|
||||
|
||||
@ -103,9 +114,20 @@ To load them, run `load_credentials()` from `Credentials_Module` in the `credent
|
||||
|
||||
___
|
||||
|
||||
# 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!
|
||||
|
||||
`https://discord.com/invite/sNTXWn4`
|
||||
|
||||
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.
|
||||
|
||||
</br>
|
||||
|
||||
___
|
||||
# Support The Project:
|
||||
|
||||
If you wish to support the project, the easiest way to do so is by sending either BTC or Eth
|
||||
If you wish to support the project, one of the easiest ways to do so is by sending either BTC or Eth
|
||||
|
||||
Bitcoin: `1BFQTkb43bGMSNJjsQtiqai5eQjF5CLcAG`<br>
|
||||
Ethereum: `0x34DE0330ba2CD4030bBbFE9B46D31DeFeE1ffa54`
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
pynput
|
||||
twitch-python
|
||||
twitchAPI
|
||||
SQLAlchemy
|
||||
pandas
|
||||
numpy
|
||||
@ -9,4 +10,5 @@ discord.py
|
||||
psutil
|
||||
art
|
||||
phue
|
||||
flask
|
||||
flask
|
||||
requests
|
||||
@ -309,8 +309,11 @@
|
||||
<div id="About" class="">
|
||||
<div class="row bodyarea">
|
||||
<div class="col s12 center">
|
||||
<h1>Made by Alex Orid,<br> The Curious Nerd</h1>
|
||||
<h1>Praxis Bot</h1>
|
||||
<h3>Created by Alex Orid</h3><h4>The Curious Nerd</h4><br>
|
||||
<h5>Check out the project on <a href="https://github.com/TheCuriousNerd/Praxis_Bot" target="_blank">Github</a></h5>
|
||||
<h5>Need Help? Want to help out?<br><a href="https://discord.com/invite/sNTXWn4" target="_blank">Come visit my Discord</a></h5>
|
||||
<br><p>This project is licensed under AGPL</p><br>
|
||||
<p>Version:<br> A:0 D:1 O:0.8</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user