lili
/
Tlapbot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 6 Wiki Activity

Merge branch 'master' of git.kawen.site:Lili/tlapbot

This commit is contained in:
Lili (Tlapka) 2022-11-22 12:24:15 +01:00
parent 5e5e81114f f26b57fea6
commit e82ecb0784
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -23,7 +23,7 @@ Tlapbot has these basic commands:
- `!points` shows a chatter how many points they have. - `!points` shows a chatter how many points they have.
- `!name_update` is a special debug command, to be used with the user's name displays wrong in the redeem dashboard. Normally, it shouldn't have to be used at all, as display names get updated automatically when the bot is running. - `!name_update` is a special debug command, to be used with the user's name displays wrong in the redeem dashboard. Normally, it shouldn't have to be used at all, as display names get updated automatically when the bot is running.
Then, Tlapbot automatically adds a command for each redeem in the redeem file. Tlapbot also automatically adds a command for each redeem in the redeems file.
### Tlapbot redeems types ### Tlapbot redeems types
Tlapbot currently supports three different redeem types. Tlapbot currently supports three different redeem types.
#### List #### List
@ -41,12 +41,12 @@ Counter is a unique redeem type, in that it doesn't show up in the list of recen
Instead, the tlapbot dashboard keeps a number for each "counter", and each redeems adds +1 to it. Instead, the tlapbot dashboard keeps a number for each "counter", and each redeems adds +1 to it.
Counter redeems can be used to gauge interest, tally up votes, or to keep track of how many emotes should be added to the OBS scene. Counter redeems can be used to gauge interest, tally up votes, or to keep track of how many emotes should be added to an OBS scene.
### Tlapbot dashboard ### Tlapbot dashboard
All of the recent redeems and active counters are shown together in the Tlapbot dashboard. The counters are on top, along with the number of times they've been redeemed, followed by a chronological list of recent List and Note redeems. Tlapbot dashboard is a standalone page available at `/dashboard`, made to be easily viewable as an owncast external action. The Tlapbot dashboard shows all redeems and active counters.
Tlapbot dashboard is a standalone page available at `/dashboard`, made to be easily viewable as an owncast external action. Counters are at the top, followed by a chronological list of recent List and Note redeems.
Tlapbot dashboard also shows the chatter's points balance when they open it as an external action. Tlapbot dashboard also shows the chatter's points balance when they open it as an external action.
@ -66,15 +66,21 @@ Tlapbot requires Python 3, probably a fairly recent version of it too. (My live
The Python prerequisites for running tlapbot are the libraries `flask`, The Python prerequisites for running tlapbot are the libraries `flask`,
`requests` and `apscheduler`. If you follow the installation steps below, `requests` and `apscheduler`. If you follow the installation steps below,
they should automatically be installed if you don't have them. they should automatically be installed if you don't have them.
You can also run Tlapbot in a [Python virtual environment](https://flask.palletsprojects.com/en/2.2.x/installation/#virtual-environments).
### Install from git repo (as a folder) ### Install from git repo (as a folder)
1. Clone the repository. 1. Clone the repository.
2. Run `pip install -e .` in the root folder. This will install tlapbot 2. Run `pip install -e .` in the root folder. This will install tlapbot
as a package in editable more. as a package in editable more.
3. Initialize the database: 3. Set the `FLASK_APP` environment variable.
```bash
export FLASK_APP=tlapbot
```
4. Initialize the database:
```bash ```bash
python -m flask init-db python -m flask init-db
``` ```
4. Create a `instance/config.py` file and fill it in as needed. 5. Create a `instance/config.py` file and fill it in as needed.
Default values are included in `tlapbot/default_config`, and values in Default values are included in `tlapbot/default_config`, and values in
`config.py` overwrite them. (The database also lives in the instance folder `config.py` overwrite them. (The database also lives in the instance folder
by default.) by default.)
@ -85,7 +91,7 @@ by default.)
OWNCAST_ACCESS_TOKEN # get one from owncast instance OWNCAST_ACCESS_TOKEN # get one from owncast instance
OWNCAST_INSTANCE_URL # default points to localhost owncast on default port OWNCAST_INSTANCE_URL # default points to localhost owncast on default port
``` ```
5. OPTIONAL: Create an `instance/redeems.py` file and add your custom redeems. 6. OPTIONAL: Create an `instance/redeems.py` file and add your custom redeems.
If you don't add a redeems file, the bot will initialize the default redeems from `tlapbot/default_redeems.py`. If you don't add a redeems file, the bot will initialize the default redeems from `tlapbot/default_redeems.py`.
More details on how to write the config and redeems files are written later in the readme. More details on how to write the config and redeems files are written later in the readme.