Compare commits

..

No commits in common. "master" and "v1.1.0" have entirely different histories.

15 changed files with 246 additions and 671 deletions

114
README.md
View File

@ -2,12 +2,9 @@
Tlapbot is an [Owncast](https://owncast.online/) bot that adds channel points and Tlapbot is an [Owncast](https://owncast.online/) bot that adds channel points and
channel point redeems to your Owncast page. channel point redeems to your Owncast page.
Similar This bot is currently in-development. The goal is to have an experience similar
to [Twitch channel points](https://help.twitch.tv/s/article/viewer-channel-point-guide), Tlapbot rewards your viewers with points for watching, and allows them to spend their points on fun gimmicks, challenges, reaction requests, or whatever else you decide. to [Twitch channel points](https://help.twitch.tv/s/article/viewer-channel-point-guide) by making use of [Owncast webhooks](https://owncast.online/thirdparty/webhooks/) and
[External actions](https://owncast.online/thirdparty/actions/).
Tlapbot makes use of [Owncast webhooks](https://owncast.online/thirdparty/webhooks/) for chat interactions and
[Owncast external actions](https://owncast.online/thirdparty/actions/) to display an informative dashboard.
## Features ## Features
The bot gives points to everyone in chat -- 10 points every 10 minutes by The bot gives points to everyone in chat -- 10 points every 10 minutes by
default, but the time interval and amount of points can be changed. default, but the time interval and amount of points can be changed.
@ -15,13 +12,11 @@ default, but the time interval and amount of points can be changed.
The users in chat can then use their points on redeems -- rewards like "choose my The users in chat can then use their points on redeems -- rewards like "choose my
background music", "choose what level to play next", "react to this video" etc. background music", "choose what level to play next", "react to this video" etc.
You can configure redeems to fit your stream and the activities you're You can configure redeems to fit your stream and the activities you're
doing, and sort them into categories that can be turned on and off. doing.
The redeems then show on a "Redeems dashboard" that everyone can view The redeems then show on a "Redeems dashboard" that everyone can view
as an External Action on the Owncast stream, or at its standalone URL. as an External Action on the Owncast stream, or at its standalone URL.
This allows easy browsing of active challenges and recent redeems, without quitting the stream. This allows easy browsing of active challenges and recent redeems.
**Tlapbot currently doesn't support any automated integrations (or an API). That means no 'Crowd Control' plugin, no instant effects in OBS or VTube Studio, etc. The streamer decides how they respond to redeems or how to make them take effect.** (I'd love to support more seamless, automatic redeems in the future!)
### Tlapbot bot commands ### Tlapbot bot commands
Tlapbot has these basic commands: Tlapbot has these basic commands:
- `!help` sends a help string in the chat, explaining how tlapbot works. - `!help` sends a help string in the chat, explaining how tlapbot works.
@ -32,35 +27,8 @@ Tlapbot has these basic commands:
use the new prefix instead.) use the new prefix instead.)
Tlapbot also automatically adds a command for each redeem in the redeems file. Tlapbot also automatically adds a command for each redeem in the redeems file.
### Tlapbot dashboard
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.
Counters are at the top, followed by a list of active milestones and their progress.
Tlapbot dashboard also shows the chatter's points balance when they open it as an external action.
![Tlapbot dashboard](https://ak.kawen.space/media/f9e29757f02996f363f25226f04a97ac711a95831bfaba9dcfd42158e78831c4.png)
*Tlapbot dashboard when viewed as an external action.*
#### Redeem queue tab
The redeem queue shows a chronological list of note and list redeems with timestamps, the redeemer's username, and the note sent.
![Redeem queue tab](https://ak.kawen.space/media/a1f44cc1a4011309a08361ca7f2ce24837d5daadd045910bf33fcd40b01d0a27.png)
*Redeem queue tab.*
#### Redeems help tab
The dashboard also has a "Redeems help" tab. It shows an explanation of redeem types,
and lists all active redeems, along with their price, type and description.
### Passive mode
Tlapbot can also be run in passive mode. In passive mode, no redeems will be available, and Tlapbot will not send any messages.
However, it will still give points to viewers, and track username changes.
The Tlapbot dashboard will display a passive mode disclaimer instead of redeems.
### Tlapbot redeems types ### Tlapbot redeems types
Tlapbot currently supports four different redeem types. Each type of a redeem Tlapbot currently supports three different redeem types. Each type of a redeem
works slightly differently, and displays differently on the redeems dashboard. works slightly differently, and displays differently on the redeems dashboard.
Redeems can also optionally be sorted into "categories" that can be turned on Redeems can also optionally be sorted into "categories" that can be turned on
@ -84,19 +52,19 @@ Instead, the tlapbot dashboard keeps a number for each "counter", and each redee
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. 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.
#### Milestone ### Tlapbot dashboard
Milestone redeems are long-term goals that are reset separately from other 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.
Viewers donate variable amounts of points that add up together to fulfill the milestone goal.
Each milestone has a goal, a number of points required to send, and the points from Counters are at the top, followed by a chronological list of recent List and Note redeems.
all users add together to progress and reach the goal.
Milestones show as a progress bar on the dashboard. Tlapbot dashboard also shows the chatter's points balance when they open it as an external action.
Milestone redeems can be used as long-term community challenges, to start streamer
challenges, decide new games to play, etc.
![Tlapbot dashboard](https://ak.kawen.space/media/67c1ac6ed0d2f4efb09937c1cbfe864102182e990796853507860f50db7ff5f5.png)
*Tlapbot dashboard when viewed as an external action.*
#### Redeems help tab
The dashboard also has a "Redeems help" tab. It shows an explanation of redeem types,
and lists all active redeems, along with their price, type and description.
## License & Contributions ## License & Contributions
Tlapbot as it currently is does not come with a license. If you're a content creator, streamer, vtuber, etc. I'll be happy to give you permission to use Tlapbot, or make changes that'd fit your stream. Tlapbot as it currently is does not come with a license. If you're a content creator, streamer, vtuber, etc. I'll be happy to give you permission to use Tlapbot, or make changes that'd fit your stream.
@ -121,8 +89,8 @@ as a package in editable more.
```bash ```bash
python -m flask init-db python -m flask init-db
``` ```
5. Create an `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.py`, 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.)
@ -135,13 +103,10 @@ by default.)
6. 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.
7. If you've added any new counters or milestones, run `refresh-counters` or `refresh-milestones` commands to initialize them into the database.
This installation is fine both for just running Tlapbot as it is, but it also works as a dev setup if you want to make changes or contribute. This installation is fine both for just running Tlapbot as it is, but it also works as a dev setup if you want to make changes or contribute.
Updating should be as easy as `git pull`ing the new version. Updating should be as easy as `git pull`ing the new version.
Sometimes, if an update adds new database tables or columns, you will also need to
rerun the `init-db` CLI command.
## Owncast configuration ## Owncast configuration
In the Owncast web interface, navigate to the admin interface at `/admin`, In the Owncast web interface, navigate to the admin interface at `/admin`,
and then go to Integrations. and then go to Integrations.
@ -240,8 +205,7 @@ Tlapbot comes with a few Click CLI commands. The commands let you clear out coun
#### init-db #### init-db
The init-db command initializes the database. The init-db command initializes the database.
**This command should only be run when first installing tlapbot, **This command should only be run when first installing tlapbot.**
or when updating to a tlapbot version that changed the database schema.**
#### clear-queue #### clear-queue
The clear-queue command clears the redeem queue and resets all active counters to zero. The clear-queue command clears the redeem queue and resets all active counters to zero.
You should run this command if you're about to start a new stream, and want to start with empty counters and queue. You should run this command if you're about to start a new stream, and want to start with empty counters and queue.
@ -265,34 +229,11 @@ Does the same as `clear-queue` and `refresh-counters` together.
python -m flask clear-refresh python -m flask clear-refresh
``` ```
Run this if you're adding/removing counters, want to reset them to zero and want to clear all redeems as well. Run this if you're adding/removing counters, want to reset them to zero and want to clear all redeems as well.
#### refresh-milestones
Deletes old milestones and initializes new ones from the redeems file.
```bash
python -m flask refresh-milestones
```
Running this command shouldn't reset progress on milestones that are already in the database
and are still in the redeems file.
#### reset-milestone
Resets progress on a milestone, but only if the milestone had been completed.
```bash
python -m flask reset-milestone milestone
```
#### hard-reset-milestone
Resets progress on a milestone, regardless of completion status.
```bash
python -m flask hard-reset-milestone milestone
```
## Configuration files ## Configuration files
Configuration files should be in the instance folder. For folder installation of tlapbot,
that's `instance/` from the root of the Github repository.
Take care not to replace `tlapbot/redeems.py` with your redeems config.
`tlapbot/redeems.py` contains functions that handle redeems interactions with the db,
and not the redeems config.
### config.py ### config.py
Values you can include in `config.py` to change how the bot behaves. Values you can include in `config.py` to change how the bot behaves.
(`config.py` should be in the instance folder: `instance/config.py` for folder install.) (`config.py` should be in the instance folder: `/instance/config.py` for folder install.)
#### Mandatory #### Mandatory
Including these values is mandatory if you want tlapbot to work. Including these values is mandatory if you want tlapbot to work.
- `SECRET_KEY` is your secret key. Get one from running `python -c 'import secrets; print(secrets.token_hex())'` - `SECRET_KEY` is your secret key. Get one from running `python -c 'import secrets; print(secrets.token_hex())'`
@ -303,7 +244,6 @@ Including these values will overwrite their defaults from `/tlapbot/default_conf
- `POINTS_CYCLE_TIME` decides how often channel points are given to users in chat, - `POINTS_CYCLE_TIME` decides how often channel points are given to users in chat,
in seconds. in seconds.
- `POINTS_AMOUNT_GIVEN` decides how many channel points users receive. - `POINTS_AMOUNT_GIVEN` decides how many channel points users receive.
- `PASSIVE` if `True`, sets Tlapbot into passive mode, where no redeems are available. The bot will still track username changes and give out points.
- `LIST_REDEEMS` if `True`, all redeems will be listed after the `!help` command in chat. - `LIST_REDEEMS` if `True`, all redeems will be listed after the `!help` command in chat.
This makes the !help output quite long, so it's `False` by default. This makes the !help output quite long, so it's `False` by default.
- `GUNICORN` if `True`, sets logging to use gunicorn's logger. Only set this to True if you're using Gunicorn to run tlapbot. - `GUNICORN` if `True`, sets logging to use gunicorn's logger. Only set this to True if you're using Gunicorn to run tlapbot.
@ -322,7 +262,7 @@ ACTIVE_CATEGORIES=["gaming"]
### redeems.py ### redeems.py
`redeems.py` is a file where you define all your custom redeems. Tlapbot will work without it, but it will load a few default, generic redeems from `tlapbot/default_redeems.py`. `redeems.py` is a file where you define all your custom redeems. Tlapbot will work without it, but it will load a few default, generic redeems from `tlapbot/default_redeems.py`.
(`redeems.py` should be in the instance folder: `instance/redeems.py` for folder install.) (`redeems.py` should be in the instance folder: `/instance/redeems.py` for folder install.)
#### `default_redeems.py`: #### `default_redeems.py`:
```python ```python
REDEEMS={ REDEEMS={
@ -330,22 +270,16 @@ REDEEMS={
"lurk": {"price": 1, "type": "counter", "info": "Let us know you're going to lurk."}, "lurk": {"price": 1, "type": "counter", "info": "Let us know you're going to lurk."},
"react": {"price": 200, "type": "note", "info": "Attach link to a video for me to react to."}, "react": {"price": 200, "type": "note", "info": "Attach link to a video for me to react to."},
"request": {"price": 100, "type": "note", "info": "Request a level, gamemode, skin, etc."}, "request": {"price": 100, "type": "note", "info": "Request a level, gamemode, skin, etc."},
"go_nap": {"goal": 1000, "type": "milestone", "info": "Streamer will go nap when the goal is reached."},
"inactive": {"price": 100, "type": "note", "info": "Example redeem that is inactive by default", "category": ["inactive"]} "inactive": {"price": 100, "type": "note", "info": "Example redeem that is inactive by default", "category": ["inactive"]}
} }
``` ```
#### File format #### File format
`redeems.py` is a config file with just a `REDEEMS` key, that assigns a dictionary of redeems to it. `redeems.py` is a config file with just a `REDEEMS` key, that assigns a dictionary of redeems to it.
Each dictionary entry is a redeem, and the dictionary keys are strings that decide the chat command for the redeem. Each dictionary entry is a redeem, and the dictionary keys are strings that decides the chat command for the redeem. The value is another dictionary that needs to have entries for `"price"`, `"type"` and optionally `"info"` and `"category"`.
The redeem names shouldn't have spaces in them.
The value is another dictionary that needs to have an entry for `"type"` and
an entry for `"price"` for non-milestones or `"goal"` for milestones.
Optionally, each redeem can also have `"info"` and `"category"` entries.
- `"price"` value should be an integer that decides how many points the redeem will cost. Milestone redeems don't use the `"price"` value, they instead need to have a `"goal"`. - `"price"` value should be an integer that decides how many points the redeem will cost.
- `"goal"` is a required field for milestone goals. It should be an integer, deciding the amount of points required to complete the milestone. - `"type"` value should be either `"list"`, `"counter"` or `"note"`. This decided the redeem's type, and whether it will show up as a counter at the top of the dashboard or as an entry in the "recent redeems" chart.
- `"type"` value should be either `"list"`, `"counter"`, `"note"` or `"milestone"`. This decided the redeem's type, and whether it will show up as a counter at the top of the dashboard or as an entry in the "recent redeems" chart. - `"info"` value should be a string that describes what the command does. It's optional, but I recommend writing one for all `"list"` and `"note"` redeems (so that chatters know that they should write a note).
- `"info"` value should be a string that describes what the command does. It's optional, but I recommend writing one for all `"list"`, `"note"` and `"milestone"` redeems (so that chatters know what they're redeeming and whether they should leave a note).
- `"category"` is an optional list of strings, the categories the redeem is in. - `"category"` is an optional list of strings, the categories the redeem is in.
If a category from the list is in `ACTIVE_CATEGORIES` from `config.py`, If a category from the list is in `ACTIVE_CATEGORIES` from `config.py`,
then the redeem will be active. It will not be active if none of the categories then the redeem will be active. It will not be active if none of the categories

View File

@ -2,7 +2,7 @@ from setuptools import find_packages, setup
setup( setup(
name='tlapbot', name='tlapbot',
version='1.2.2', version='1.1.0',
packages=find_packages(), packages=find_packages(),
include_package_data=True, include_package_data=True,
install_requires=[ install_requires=[

View File

@ -3,12 +3,12 @@ import logging
from flask import Flask from flask import Flask
from apscheduler.schedulers.background import BackgroundScheduler from apscheduler.schedulers.background import BackgroundScheduler
from tlapbot.db import get_db from tlapbot.db import get_db
from tlapbot.owncast_requests import is_stream_live, give_points_to_chat from tlapbot.owncast_helpers import (is_stream_live, give_points_to_chat,
remove_inactive_redeems)
def create_app(test_config=None): def create_app(test_config=None):
app = Flask(__name__, instance_relative_config=True) app = Flask(__name__, instance_relative_config=True)
# ensure the instance folder exists # ensure the instance folder exists
try: try:
os.makedirs(app.instance_path) os.makedirs(app.instance_path)
@ -24,29 +24,27 @@ def create_app(test_config=None):
app.config.from_object('tlapbot.default_redeems') app.config.from_object('tlapbot.default_redeems')
app.config.from_pyfile('config.py', silent=True) app.config.from_pyfile('config.py', silent=True)
app.config.from_pyfile('redeems.py', silent=True) app.config.from_pyfile('redeems.py', silent=True)
app.config.from_mapping(
REDEEMS=remove_inactive_redeems(app.config['REDEEMS'],
app.config['ACTIVE_CATEGORIES'])
)
# Make logging work for gunicorn-ran instances of tlapbot. # Make logging work for gunicorn-ran instances of tlapbot.
if app.config['GUNICORN']: if app.config['GUNICORN']:
gunicorn_logger = logging.getLogger('gunicorn.error') gunicorn_logger = logging.getLogger('gunicorn.error')
app.logger.handlers = gunicorn_logger.handlers app.logger.handlers = gunicorn_logger.handlers
app.logger.setLevel(gunicorn_logger.level) app.logger.setLevel(gunicorn_logger.level)
# Check for wrong config that would break Tlapbot # Check for wrong config that would break Tlapbot
if len(app.config['PREFIX']) != 1: if len(app.config['PREFIX']) != 1:
raise RuntimeError("Prefix is >1 character. " raise RuntimeError("Prefix is >1 character. "
"Change your config to set 1-character prefix.") "Change your config to set 1-character prefix.")
# Check for spaces in redeems (they won't work)
for redeem in app.config['REDEEMS']:
if ' ' in redeem:
app.logger.warning(f"Redeem '{redeem}' has spaces in its name.")
app.logger.warning("Redeems with spaces are impossible to redeem.")
# prepare webhooks and redeem dashboard blueprints # prepare webhooks and redeem dashboard blueprints
from . import owncast_webhooks from . import owncast_webhooks
from . import tlapbot_dashboard from . import owncast_redeem_dashboard
app.register_blueprint(owncast_webhooks.bp) app.register_blueprint(owncast_webhooks.bp)
app.register_blueprint(tlapbot_dashboard.bp) app.register_blueprint(owncast_redeem_dashboard.bp)
# add db CLI commands # add db CLI commands
from . import db from . import db
@ -54,10 +52,7 @@ def create_app(test_config=None):
app.cli.add_command(db.clear_queue_command) app.cli.add_command(db.clear_queue_command)
app.cli.add_command(db.refresh_counters_command) app.cli.add_command(db.refresh_counters_command)
app.cli.add_command(db.refresh_and_clear_command) app.cli.add_command(db.refresh_and_clear_command)
app.cli.add_command(db.refresh_milestones_command)
app.cli.add_command(db.reset_milestone_command)
app.cli.add_command(db.hard_reset_milestone_command)
# scheduler job for giving points to users # scheduler job for giving points to users
def proxy_job(): def proxy_job():
with app.app_context(): with app.app_context():

View File

@ -4,8 +4,6 @@ import click
from flask import current_app, g from flask import current_app, g
from flask.cli import with_appcontext from flask.cli import with_appcontext
from tlapbot.redeems import milestone_complete
def get_db(): def get_db():
if 'db' not in g: if 'db' not in g:
@ -34,10 +32,8 @@ def insert_counters(db):
(redeem,) (redeem,)
) )
db.commit() db.commit()
except sqlite3.Error as e: except Error as e:
print("Failed inserting counters to db:", e.args[0]) print("Failed inserting counters to db:", e.args[0])
return False
return True
def init_db(): def init_db():
@ -46,8 +42,7 @@ def init_db():
with current_app.open_resource('schema.sql') as f: with current_app.open_resource('schema.sql') as f:
db.executescript(f.read().decode('utf8')) db.executescript(f.read().decode('utf8'))
if insert_counters(db): insert_counters(db)
return True
def clear_redeem_queue(): def clear_redeem_queue():
@ -61,10 +56,8 @@ def clear_redeem_queue():
"""UPDATE counters SET count = 0""" """UPDATE counters SET count = 0"""
) )
db.commit() db.commit()
except sqlite3.Error as e: except Error as e:
print("Error occured deleting redeem queue:", e.args[0]) print("Error occured deleting redeem queue:", e.args[0])
return False
return True
def refresh_counters(): def refresh_counters():
@ -73,95 +66,35 @@ def refresh_counters():
try: try:
db.execute("DELETE FROM counters") db.execute("DELETE FROM counters")
db.commit() db.commit()
except sqlite3.Error as e: except Error as e:
print("Error occured deleting old counters:", e.args[0]) print("Error occured deleting old counters:", e.args[0])
return False
if insert_counters(db):
return True
for redeem, redeem_info in current_app.config['REDEEMS'].items():
def refresh_milestones(): if redeem_info["type"] == "counter":
db = get_db() try:
# delete old milestones
try:
cursor = db.execute("SELECT name FROM milestones")
milestones = cursor.fetchall()
to_delete = []
for milestone in milestones:
milestone = milestone[0]
if milestone not in current_app.config['REDEEMS'].keys():
to_delete.append(milestone)
elif current_app.config['REDEEMS'][milestone]['type'] != "milestone":
to_delete.append(milestone)
for milestone in to_delete:
cursor.execute("DELETE FROM milestones WHERE name = ?", (milestone,))
db.commit()
except sqlite3.Error as e:
print("Failed deleting old milestones from db:", e.args[0])
return False
# add new milestones
try:
for redeem, redeem_info in current_app.config['REDEEMS'].items():
if redeem_info["type"] == "milestone":
cursor = db.execute( cursor = db.execute(
"SELECT goal FROM milestones WHERE name = ?", "INSERT INTO counters(name, count) VALUES(?, 0)",
(redeem,) (redeem,)
) )
result = cursor.fetchone() db.commit()
if result is None: except Error as e:
cursor.execute( print("Failed inserting counters to db:", e.args[0])
"INSERT INTO milestones(name, progress, goal, complete) VALUES(?, 0, ?, FALSE)",
(redeem, redeem_info['goal'])
)
# update existing milestone to new goal
elif result != redeem_info["goal"]:
cursor.execute(
"UPDATE milestones SET goal = ? WHERE name = ?",
(redeem_info["goal"], redeem)
)
db.commit()
except sqlite3.Error as e:
print("Failed inserting milestones to db:", e.args[0])
return False
return True
def reset_milestone(milestone):
if milestone not in current_app.config['REDEEMS']:
print(f"Failed resetting milestone, {milestone} not in redeems file.")
return False
try:
db = get_db()
db.execute(
"DELETE FROM milestones WHERE name = ?",
(milestone,)
)
db.execute(
"INSERT INTO milestones(name, progress, goal, complete) VALUES(?, ?, ?, FALSE)",
(milestone, 0, current_app.config['REDEEMS'][milestone]['goal'])
)
db.commit()
return True
except sqlite3.Error as e:
current_app.logger.error(f"Error occured adding a milestone: {e.args[0]}")
return False
@click.command('init-db') @click.command('init-db')
@with_appcontext @with_appcontext
def init_db_command(): def init_db_command():
"""Clear the existing data and create new tables.""" """Clear the existing data and create new tables."""
if init_db(): init_db()
click.echo('Initialized the database.') click.echo('Initialized the database.')
@click.command('clear-queue') @click.command('clear-queue')
@with_appcontext @with_appcontext
def clear_queue_command(): def clear_queue_command():
"""Remove all redeems from the redeem queue.""" """Remove all redeems from the redeem queue."""
if clear_redeem_queue(): clear_redeem_queue()
click.echo('Cleared redeem queue.') click.echo('Cleared redeem queue.')
@click.command('refresh-counters') @click.command('refresh-counters')
@ -169,45 +102,17 @@ def clear_queue_command():
def refresh_counters_command(): def refresh_counters_command():
"""Refresh counters from current config file. """Refresh counters from current config file.
(Remove old ones, add new ones.)""" (Remove old ones, add new ones.)"""
if refresh_counters(): refresh_counters()
click.echo('Counters refreshed.') click.echo('Counters refreshed.')
@click.command('clear-refresh') @click.command('clear-refresh')
@with_appcontext @with_appcontext
def refresh_and_clear_command(): def refresh_and_clear_command():
"""Refresh counters and clear queue.""" """Refresh counters and clear queue."""
if refresh_counters() and clear_redeem_queue(): refresh_counters()
click.echo('Counters refreshed and queue cleared.') clear_redeem_queue()
click.echo('Counters refreshed and queue cleared.')
@click.command('refresh-milestones')
@with_appcontext
def refresh_milestones_command():
"""Initialize all milestones from the redeems file,
delete milestones not in redeem file."""
if refresh_milestones():
click.echo('Refreshed milestones.')
@click.command('reset-milestone')
@click.argument('milestone')
def reset_milestone_command(milestone):
"""Resets a completed milestone back to zero."""
if milestone_complete(get_db(), milestone):
if reset_milestone(milestone):
click.echo(f"Reset milestone {milestone}.")
else:
click.echo(f"Could not reset milestone {milestone}, milestone not completed.")
click.echo("(You can hard-reset-milestone if you really want to reset it.)")
@click.command('hard-reset-milestone')
@click.argument('milestone')
def hard_reset_milestone_command(milestone):
"""Resets any milestone back to zero."""
if reset_milestone(milestone):
click.echo(f"Hard reset milestone {milestone}.")
def init_app(app): def init_app(app):

View File

@ -3,7 +3,6 @@ OWNCAST_ACCESS_TOKEN=''
OWNCAST_INSTANCE_URL='http://localhost:8080' OWNCAST_INSTANCE_URL='http://localhost:8080'
POINTS_CYCLE_TIME=600 POINTS_CYCLE_TIME=600
POINTS_AMOUNT_GIVEN=10 POINTS_AMOUNT_GIVEN=10
PASSIVE=False
LIST_REDEEMS=False LIST_REDEEMS=False
ACTIVE_CATEGORIES=[] ACTIVE_CATEGORIES=[]
GUNICORN=False GUNICORN=False

View File

@ -3,6 +3,5 @@ REDEEMS={
"lurk": {"price": 1, "type": "counter", "info": "Let us know you're going to lurk."}, "lurk": {"price": 1, "type": "counter", "info": "Let us know you're going to lurk."},
"react": {"price": 200, "type": "note", "info": "Attach link to a video for me to react to."}, "react": {"price": 200, "type": "note", "info": "Attach link to a video for me to react to."},
"request": {"price": 100, "type": "note", "info": "Request a level, gamemode, skin, etc."}, "request": {"price": 100, "type": "note", "info": "Request a level, gamemode, skin, etc."},
"go_nap": {"goal": 1000, "type": "milestone", "info": "Streamer will go nap when the goal is reached."},
"inactive": {"price": 100, "type": "note", "info": "Example redeem that is inactive by default", "category": ["inactive"]} "inactive": {"price": 100, "type": "note", "info": "Example redeem that is inactive by default", "category": ["inactive"]}
} }

View File

@ -1,30 +1,23 @@
from flask import current_app from flask import current_app
from tlapbot.owncast_requests import send_chat from tlapbot.owncast_helpers import send_chat
def send_help(): def send_help():
message = [] message = []
message.append("Tlapbot gives you points for being in chat, and then allows you to spend those points. <br>") message.append("Tlapbot gives you points for being in chat, and then allows you to spend those points.\n")
message.append(f"People connected to chat receive {current_app.config['POINTS_AMOUNT_GIVEN']} points every {current_app.config['POINTS_CYCLE_TIME']} seconds. <br>") message.append(f"People connected to chat receive {current_app.config['POINTS_AMOUNT_GIVEN']} points every {current_app.config['POINTS_CYCLE_TIME']} seconds.\n")
message.append("You can see your points and recent redeems in the Tlapbot dashboard. Look for a button to click under the stream window. <br>") message.append("You can see your points and recent redeems in the Tlapbot dashboard. Look for a button to click under the stream window.\n")
message.append("""Tlapbot commands: <br> message.append("""Tlapbot commands:
!help to see this help message. <br> !help to see this help message.
!points to see your points. <br>""" !points to see your points.\n"""
) )
if current_app.config['LIST_REDEEMS']: if current_app.config['LIST_REDEEMS']:
message.append("Active redeems: <br>") message.append("Active redeems:\n")
for redeem, redeem_info in current_app.config['REDEEMS'].items(): for redeem, redeem_info in current_app.config['REDEEMS'].items():
if redeem_info.get('category', None):
if not set(redeem_info['category']).intersection(set(current_app.config['ACTIVE_CATEGORIES'])):
continue
if 'type' in redeem_info and redeem_info['type'] == 'milestone':
message.append(f"!{redeem} milestone with goal of {redeem_info['goal']}.")
else:
message.append(f"!{redeem} for {redeem_info['price']} points.")
if 'info' in redeem_info: if 'info' in redeem_info:
message.append(f" {redeem_info['info']} <br>") message.append(f"!{redeem} for {redeem_info['price']} points. {redeem_info['info']}\n")
else: else:
message.append("<br>") message.append(f"!{redeem} for {redeem_info['price']} points.\n")
else: else:
message.append("Check the dashboard for a list of currently active redeems.") message.append("Check the dashboard for a list of currently active redeems.")
send_chat(''.join(message)) send_chat(''.join(message))

View File

@ -1,7 +1,32 @@
from flask import current_app from flask import current_app
import requests
from sqlite3 import Error from sqlite3 import Error
from re import sub from re import sub
# # # requests stuff # # #
def is_stream_live():
url = current_app.config['OWNCAST_INSTANCE_URL'] + '/api/status'
r = requests.get(url)
return r.json()["online"]
def give_points_to_chat(db):
url = current_app.config['OWNCAST_INSTANCE_URL'] + '/api/integrations/clients'
headers = {"Authorization": "Bearer " + current_app.config['OWNCAST_ACCESS_TOKEN']}
r = requests.get(url, headers=headers)
unique_users = set(map(lambda user_object: user_object["user"]["id"], r.json()))
for user_id in unique_users:
give_points_to_user(db,
user_id,
current_app.config['POINTS_AMOUNT_GIVEN'])
def send_chat(message):
url = current_app.config['OWNCAST_INSTANCE_URL'] + '/api/integrations/chat/send'
headers = {"Authorization": "Bearer " + current_app.config['OWNCAST_ACCESS_TOKEN']}
r = requests.post(url, headers=headers, json={"body": message})
return r.json()
# # # db stuff # # # # # # db stuff # # #
def read_users_points(db, user_id): def read_users_points(db, user_id):
@ -98,7 +123,7 @@ def add_user_to_database(db, user_id, display_name):
def change_display_name(db, user_id, new_name): def change_display_name(db, user_id, new_name):
try: try:
db.execute( cursor = db.execute(
"UPDATE points SET name = ? WHERE id = ?", "UPDATE points SET name = ? WHERE id = ?",
(new_name, user_id) (new_name, user_id)
) )
@ -108,9 +133,89 @@ def change_display_name(db, user_id, new_name):
current_app.logger.error(f"To user id: {user_id}, with display name: {new_name}") current_app.logger.error(f"To user id: {user_id}, with display name: {new_name}")
def check_counter_exists(db, counter_name):
try:
cursor = db.execute(
"SELECT count FROM counters WHERE name = ?",
(counter_name,)
)
counter = cursor.fetchone()
if counter is None:
current_app.logger.warning("Counter not found in database.")
current_app.logger.warning("Maybe you forgot to run the refresh-counters CLI command "
"after you added a new counter to the config?")
return False
return True
except Error as e:
current_app.logger.error(f"Error occured checking if counter exists: {e.args[0]}")
current_app.logger.error(f"For counter: {counter_name}")
def add_to_counter(db, counter_name):
if check_counter_exists(db, counter_name):
try:
cursor = db.execute(
"UPDATE counters SET count = count + 1 WHERE name = ?",
(counter_name,)
)
db.commit()
return True
except Error as e:
current_app.logger.error(f"Error occured adding to counter: {e.args[0]}")
current_app.logger.error(f"To counter: {counter_name}")
return False
def add_to_redeem_queue(db, user_id, redeem_name, note=None):
try:
cursor = db.execute(
"INSERT INTO redeem_queue(redeem, redeemer_id, note) VALUES(?, ?, ?)",
(redeem_name, user_id, note)
)
db.commit()
return True
except Error as e:
current_app.logger.error(f"Error occured adding to redeem queue: {e.args[0]}")
current_app.logger.error(f"To user: {user_id} with redeem: {redeem_name} with note: {note}")
return False
def all_counters(db):
try:
cursor = db.execute(
"""SELECT counters.name, counters.count FROM counters"""
)
return cursor.fetchall()
except Error as e:
current_app.logger.error(f"Error occured selecting all counters: {e.args[0]}")
def pretty_redeem_queue(db):
try:
cursor = db.execute(
"""SELECT redeem_queue.created, redeem_queue.redeem, redeem_queue.note, points.name
FROM redeem_queue
INNER JOIN points
on redeem_queue.redeemer_id = points.id"""
)
return cursor.fetchall()
except Error as e:
current_app.logger.error(f"Error occured selecting pretty redeem queue: {e.args[0]}")
def whole_redeem_queue(db):
try:
cursor = db.execute(
"SELECT * from redeem_queue"
)
return cursor.fetchall()
except Error as e:
current_app.logger.error(f"Error occured selecting redeem queue: {e.args[0]}")
def remove_duplicate_usernames(db, user_id, username): def remove_duplicate_usernames(db, user_id, username):
try: try:
db.execute( cursor = db.execute(
"""UPDATE points """UPDATE points
SET name = NULL SET name = NULL
WHERE name = ? AND NOT id = ?""", WHERE name = ? AND NOT id = ?""",
@ -122,10 +227,23 @@ def remove_duplicate_usernames(db, user_id, username):
# # # misc. stuff # # # # # # misc. stuff # # #
# This is now unused since rawBody attribute of the webhook now returns cleaned-up emotes.
def remove_emoji(message): def remove_emoji(message):
return sub( return sub(
r'<img class="emoji" alt="(:.*?:)" title=":.*?:" src="/img/emoji/.*?">', r'<img class="emoji" alt="(:.*?:)" title=":.*?:" src="/img/emoji/.*?">',
r'\1', r'\1',
message message
) )
def is_redeem_active(redeem, active_categories):
if "category" in redeem[1] and redeem[1]["category"]:
for category in redeem[1]["category"]:
if category in active_categories:
return True
return False
return True
def remove_inactive_redeems(redeems, active_categories):
return dict(filter(lambda redeem: is_redeem_active(redeem, active_categories),
redeems.items()))

View File

@ -1,8 +1,8 @@
from flask import render_template, Blueprint, request, current_app from flask import render_template, Blueprint, request, current_app
from tlapbot.db import get_db from tlapbot.db import get_db
from tlapbot.redeems import all_active_counters, all_active_milestones, all_active_redeems, pretty_redeem_queue from tlapbot.owncast_helpers import (pretty_redeem_queue, all_counters,
from tlapbot.owncast_helpers import read_all_users_with_username read_all_users_with_username)
from datetime import timezone from datetime import datetime, timezone
bp = Blueprint('redeem_dashboard', __name__) bp = Blueprint('redeem_dashboard', __name__)
@ -18,11 +18,9 @@ def dashboard():
utc_timezone = timezone.utc utc_timezone = timezone.utc
return render_template('dashboard.html', return render_template('dashboard.html',
queue=pretty_redeem_queue(db), queue=pretty_redeem_queue(db),
counters=all_active_counters(db), counters=all_counters(db),
milestones=all_active_milestones(db), redeems=current_app.config['REDEEMS'],
redeems=all_active_redeems(),
prefix=current_app.config['PREFIX'], prefix=current_app.config['PREFIX'],
passive=current_app.config['PASSIVE'],
username=username, username=username,
users=users, users=users,
utc_timezone=utc_timezone) utc_timezone=utc_timezone)

View File

@ -1,47 +0,0 @@
import requests
from flask import current_app
from tlapbot.owncast_helpers import give_points_to_user
def is_stream_live():
url = current_app.config['OWNCAST_INSTANCE_URL'] + '/api/status'
try:
r = requests.get(url)
except requests.exceptions.RequestException as e:
current_app.logger.error(f"Error occured checking if stream is live: {e.args[0]}")
return False
return r.json()["online"]
def give_points_to_chat(db):
url = current_app.config['OWNCAST_INSTANCE_URL'] + '/api/integrations/clients'
headers = {"Authorization": "Bearer " + current_app.config['OWNCAST_ACCESS_TOKEN']}
try:
r = requests.get(url, headers=headers)
except requests.exceptions.RequestException as e:
current_app.logger.error(f"Error occured getting users to give points to: {e.args[0]}")
return
if r.status_code != 200:
current_app.logger.error(f"Error occured when giving points: Response code not 200.")
current_app.logger.error(f"Response code received: {r.status_code}.")
current_app.logger.error(f"Check owncast instance url and access key.")
return
unique_users = set(map(lambda user_object: user_object["user"]["id"], r.json()))
for user_id in unique_users:
give_points_to_user(db, user_id, current_app.config['POINTS_AMOUNT_GIVEN'])
def send_chat(message):
url = current_app.config['OWNCAST_INSTANCE_URL'] + '/api/integrations/chat/send'
headers = {"Authorization": "Bearer " + current_app.config['OWNCAST_ACCESS_TOKEN']}
try:
r = requests.post(url, headers=headers, json={"body": message})
except requests.exceptions.RequestException as e:
current_app.logger.error(f"Error occured sending chat message: {e.args[0]}")
return
if r.status_code != 200:
current_app.logger.error(f"Error occured when sending chat: Response code not 200.")
current_app.logger.error(f"Response code received: {r.status_code}.")
current_app.logger.error(f"Check owncast instance url and access key.")
return
return r.json()

View File

@ -1,8 +1,7 @@
from flask import Flask, request, json, Blueprint, current_app from flask import Flask, request, json, Blueprint, current_app
from tlapbot.db import get_db from tlapbot.db import get_db
from tlapbot.owncast_requests import send_chat
from tlapbot.owncast_helpers import (add_user_to_database, change_display_name, from tlapbot.owncast_helpers import (add_user_to_database, change_display_name,
read_users_points, remove_duplicate_usernames) send_chat, read_users_points, remove_duplicate_usernames)
from tlapbot.help_message import send_help from tlapbot.help_message import send_help
from tlapbot.redeems_handler import handle_redeem from tlapbot.redeems_handler import handle_redeem
@ -31,27 +30,26 @@ def owncast_webhook():
if data["eventData"]["user"]["authenticated"]: if data["eventData"]["user"]["authenticated"]:
remove_duplicate_usernames(db, user_id, new_name) remove_duplicate_usernames(db, user_id, new_name)
elif data["type"] == "CHAT": elif data["type"] == "CHAT":
if not current_app.config['PASSIVE']: prefix = current_app.config['PREFIX']
prefix = current_app.config['PREFIX'] user_id = data["eventData"]["user"]["id"]
user_id = data["eventData"]["user"]["id"] display_name = data["eventData"]["user"]["displayName"]
display_name = data["eventData"]["user"]["displayName"] current_app.logger.debug(f'New chat message from {display_name}:')
current_app.logger.debug(f'New chat message from {display_name}:') current_app.logger.debug(f'{data["eventData"]["body"]}')
current_app.logger.debug(f'{data["eventData"]["rawBody"]}') if data["eventData"]["body"].startswith(f"{prefix}help"):
if data["eventData"]["rawBody"].startswith(f"{prefix}help"): send_help()
send_help() elif data["eventData"]["body"].startswith(f"{prefix}points"):
elif data["eventData"]["rawBody"].startswith(f"{prefix}points"): points = read_users_points(db, user_id)
points = read_users_points(db, user_id) if points is None:
if points is None: send_chat("Error reading points.")
send_chat("Error reading points.") else:
else: send_chat(f"{display_name}'s points: {points}")
send_chat(f"{display_name}'s points: {points}") elif data["eventData"]["body"].startswith(f"{prefix}name_update"):
elif data["eventData"]["rawBody"].startswith(f"{prefix}name_update"): # Forces name update in case bot didn't catch the NAME_CHANGE
# Forces name update in case bot didn't catch the NAME_CHANGE # event. Also removes saved usernames from users with same name
# event. Also removes saved usernames from users with same name # if user is authenticated.
# if user is authenticated. change_display_name(db, user_id, display_name)
change_display_name(db, user_id, display_name) if data["eventData"]["user"]["authenticated"]:
if data["eventData"]["user"]["authenticated"]: remove_duplicate_usernames(db, user_id, display_name)
remove_duplicate_usernames(db, user_id, display_name) elif data["eventData"]["body"].startswith(prefix):
elif data["eventData"]["rawBody"].startswith(prefix): handle_redeem(data["eventData"]["body"], user_id)
handle_redeem(data["eventData"]["rawBody"], user_id)
return data return data

View File

@ -1,227 +0,0 @@
from flask import current_app
from sqlite3 import Error
from tlapbot.owncast_helpers import use_points
def counter_exists(db, counter_name):
try:
cursor = db.execute(
"SELECT count FROM counters WHERE name = ?",
(counter_name,)
)
counter = cursor.fetchone()
if counter is None:
current_app.logger.warning("Counter not found in database.")
current_app.logger.warning("Maybe you forgot to run the refresh-counters CLI command "
"after you added a new counter to the config?")
return False
return True
except Error as e:
current_app.logger.error(f"Error occured checking if counter exists: {e.args[0]}")
current_app.logger.error(f"For counter: {counter_name}")
def add_to_counter(db, counter_name):
if counter_exists(db, counter_name):
try:
db.execute(
"UPDATE counters SET count = count + 1 WHERE name = ?",
(counter_name,)
)
db.commit()
return True
except Error as e:
current_app.logger.error(f"Error occured adding to counter: {e.args[0]}")
current_app.logger.error(f"To counter: {counter_name}")
return False
def add_to_redeem_queue(db, user_id, redeem_name, note=None):
try:
db.execute(
"INSERT INTO redeem_queue(redeem, redeemer_id, note) VALUES(?, ?, ?)",
(redeem_name, user_id, note)
)
db.commit()
return True
except Error as e:
current_app.logger.error(f"Error occured adding to redeem queue: {e.args[0]}")
current_app.logger.error(f"To user: {user_id} with redeem: {redeem_name} with note: {note}")
return False
def add_to_milestone(db, user_id, redeem_name, points_donated):
try:
cursor = db.execute(
"SELECT progress, goal FROM milestones WHERE name = ?",
(redeem_name,)
)
row = cursor.fetchone()
if row is None:
current_app.logger.warning("Milestone not found in database.")
current_app.logger.warning("Maybe you forgot to run the refresh-milestones CLI command "
"after you added a new milestone to the config?")
return False
progress, goal = row
if progress + points_donated > goal:
points_donated = goal - progress
if points_donated < 0:
points_donated = 0
if use_points(db, user_id, points_donated):
cursor = db.execute(
"UPDATE milestones SET progress = ? WHERE name = ?",
(progress + points_donated, redeem_name)
)
db.commit()
return True
except Error as e:
current_app.logger.error(f"Error occured updating milestone: {e.args[0]}")
return False
def milestone_complete(db, redeem_name):
try:
cursor = db.execute(
"SELECT complete FROM milestones WHERE name = ?",
(redeem_name,)
)
row = cursor.fetchone()
if row is None:
current_app.logger.warning("Milestone not found in database.")
current_app.logger.warning("Maybe you forgot to run the refresh-milestones CLI command "
"after you added a new milestone to the config?")
else:
return row[0]
except Error as e:
current_app.logger.error(f"Error occured checking if milestone is complete: {e.args[0]}")
def check_apply_milestone_completion(db, redeem_name):
try:
cursor = db.execute(
"SELECT progress, goal FROM milestones WHERE name = ?",
(redeem_name,)
)
row = cursor.fetchone()
if row is None:
current_app.logger.warning("Milestone not found in database.")
current_app.logger.warning("Maybe you forgot to run the refresh-milestones CLI command "
"after you added a new milestone to the config?")
else:
progress, goal = row
if progress == goal:
cursor = db.execute(
"UPDATE milestones SET complete = TRUE WHERE name = ?",
(redeem_name,)
)
db.commit()
return True
return False
except Error as e:
current_app.logger.error(f"Error occured applying milestone completion: {e.args[0]}")
return False
def all_milestones(db):
try:
cursor = db.execute(
"""SELECT name, progress, goal FROM milestones"""
)
return cursor.fetchall()
except Error as e:
current_app.logger.error(f"Error occured selecting all milestones: {e.args[0]}")
def all_counters(db):
try:
cursor = db.execute(
"""SELECT counters.name, counters.count FROM counters"""
)
return cursor.fetchall()
except Error as e:
current_app.logger.error(f"Error occured selecting all counters: {e.args[0]}")
def all_active_counters(db):
counters = all_counters(db)
all_active_counters = []
for name, count in counters:
if is_redeem_active(name):
all_active_counters.append((name, count))
return all_active_counters
def all_active_milestones(db):
milestones = all_milestones(db)
all_active_milestones = []
for name, progress, goal in milestones:
if is_redeem_active(name):
all_active_milestones.append((name, progress, goal))
return all_active_milestones
def all_active_redeems():
redeems = current_app.config['REDEEMS']
all_active_redeems = {}
for redeem_name, redeem_dict in redeems.items():
if redeem_dict.get('category', None):
for category in redeem_dict['category']:
if category in current_app.config['ACTIVE_CATEGORIES']:
all_active_redeems[redeem_name] = redeem_dict
break
else:
all_active_redeems[redeem_name] = redeem_dict
return all_active_redeems
def pretty_redeem_queue(db):
try:
cursor = db.execute(
"""SELECT redeem_queue.created, redeem_queue.redeem, redeem_queue.note, points.name
FROM redeem_queue
INNER JOIN points
on redeem_queue.redeemer_id = points.id"""
)
return cursor.fetchall()
except Error as e:
current_app.logger.error(f"Error occured selecting pretty redeem queue: {e.args[0]}")
def whole_redeem_queue(db):
try:
cursor = db.execute(
"SELECT * from redeem_queue"
)
return cursor.fetchall()
except Error as e:
current_app.logger.error(f"Error occured selecting redeem queue: {e.args[0]}")
def is_redeem_active(redeem_name):
"""Checks if redeem is active. Pulls the redeem by name from config."""
active_categories = current_app.config['ACTIVE_CATEGORIES']
redeem_dict = current_app.config['REDEEMS'].get(redeem_name, None)
if redeem_dict:
if "category" in redeem_dict:
for category in redeem_dict["category"]:
if category in active_categories:
return True
return False
else:
return True
return None # redeem does not exist, unknown active state
def is_redeem_from_config_active(redeem, active_categories):
"""Checks if redeem is active. `redeem` is a whole key:value pair from redeems config."""
if "category" in redeem[1] and redeem[1]["category"]:
for category in redeem[1]["category"]:
if category in active_categories:
return True
return False
return True
def remove_inactive_redeems(redeems, active_categories):
return dict(filter(lambda redeem: is_redeem_from_config_active(redeem, active_categories),
redeems.items()))

View File

@ -1,9 +1,7 @@
from flask import current_app from flask import current_app
from tlapbot.db import get_db from tlapbot.db import get_db
from tlapbot.owncast_requests import send_chat from tlapbot.owncast_helpers import (use_points, add_to_redeem_queue,
from tlapbot.redeems import (add_to_redeem_queue, add_to_counter, add_to_milestone, add_to_counter, read_users_points, send_chat, remove_emoji)
check_apply_milestone_completion, milestone_complete, is_redeem_active)
from tlapbot.owncast_helpers import use_points, read_users_points
def handle_redeem(message, user_id): def handle_redeem(message, user_id):
@ -17,36 +15,12 @@ def handle_redeem(message, user_id):
if redeem not in current_app.config['REDEEMS']: if redeem not in current_app.config['REDEEMS']:
send_chat("Can't redeem, redeem not found.") send_chat("Can't redeem, redeem not found.")
return return
if not is_redeem_active(redeem):
send_chat("Can't redeem, redeem is currently not active.")
return
db = get_db() db = get_db()
price = current_app.config['REDEEMS'][redeem]["price"]
redeem_type = current_app.config['REDEEMS'][redeem]["type"] redeem_type = current_app.config['REDEEMS'][redeem]["type"]
points = read_users_points(db, user_id) points = read_users_points(db, user_id)
# handle milestone first because it doesn't have a price
if redeem_type == "milestone":
if milestone_complete(db, redeem):
send_chat(f"Can't redeem {redeem}, that milestone was already completed!")
elif not note:
send_chat(f"Cannot redeem {redeem}, no amount of points specified.")
elif not note.isdigit():
send_chat(f"Cannot redeem {redeem}, amount of points is not a positive integer.")
elif int(note) > points:
send_chat(f"Can't redeem {redeem}, you're donating more points than you have.")
elif int(note) == 0:
send_chat(f"Can't donate zero points.")
elif add_to_milestone(db, user_id, redeem, int(note)):
send_chat(f"Succesfully donated to {redeem} milestone!")
if check_apply_milestone_completion(db, redeem):
send_chat(f"Milestone goal {redeem} complete!")
else:
send_chat(f"Redeeming milestone {redeem} failed.")
return
# handle redeems with price argument
price = current_app.config['REDEEMS'][redeem]["price"]
if not points or points < price: if not points or points < price:
send_chat(f"Can't redeem {redeem}, you don't have enough points.") send_chat(f"Can't redeem {redeem}, you don't have enough points.")
return return
@ -66,7 +40,7 @@ def handle_redeem(message, user_id):
if not note: if not note:
send_chat(f"Cannot redeem {redeem}, no note included.") send_chat(f"Cannot redeem {redeem}, no note included.")
return return
if (add_to_redeem_queue(db, user_id, redeem, note) and if (add_to_redeem_queue(db, user_id, redeem, remove_emoji(note)) and
use_points(db, user_id, price)): use_points(db, user_id, price)):
send_chat(f"{redeem} redeemed for {price} points.") send_chat(f"{redeem} redeemed for {price} points.")
else: else:

View File

@ -1,6 +1,5 @@
DROP TABLE IF EXISTS counters; DROP TABLE IF EXISTS counters;
DROP TABLE IF EXISTS redeem_queue; DROP TABLE IF EXISTS redeem_queue;
DROP TABLE IF EXISTS milestones;
CREATE TABLE IF NOT EXISTS points ( CREATE TABLE IF NOT EXISTS points (
id TEXT PRIMARY KEY, id TEXT PRIMARY KEY,
@ -8,14 +7,6 @@ CREATE TABLE IF NOT EXISTS points (
points INTEGER points INTEGER
); );
CREATE TABLE milestones (
id INTEGER PRIMARY KEY AUTOINCREMENT,
name TEXT NOT NULL,
progress INTEGER NOT NULL,
goal INTEGER NOT NULL,
complete BOOLEAN NOT NULL
);
CREATE TABLE counters ( CREATE TABLE counters (
id INTEGER PRIMARY KEY AUTOINCREMENT, id INTEGER PRIMARY KEY AUTOINCREMENT,
name TEXT NOT NULL, name TEXT NOT NULL,

View File

@ -1,26 +1,19 @@
<!DOCTYPE html> <!DOCTYPE html>
<html lang="en"> <html lang="en">
<link rel="stylesheet" href="{{ url_for('static', filename='style.css') }}"> <link rel="stylesheet" href="{{ url_for('static', filename='style.css') }}">
<head> <head>
<title>Redeems Dashboard</title> <title>Redeems Dashboard</title>
</head> </head>
<div id="script"> <div id="script">
<script src="/static/dashboard.js"></script> <script src="/static/dashboard.js"></script>
<div class="tab"> <div class="tab">
<button class="tablinks" onclick="openTab(event, 'dashboard')" , id="defaultOpen">Tlapbot dashboard</button> <button class="tablinks" onclick="openTab(event, 'dashboard')", id="defaultOpen">Tlapbot dashboard</button>
{% if not passive %}
{% if queue %}
<button class="tablinks" onclick="openTab(event, 'redeem-queue')">Redeem queue</button>
{% endif %}
<button class="tablinks" onclick="openTab(event, 'redeems-list')">Redeems help</button> <button class="tablinks" onclick="openTab(event, 'redeems-list')">Redeems help</button>
{% endif %}
</div> </div>
<div id='dashboard' class="tabcontent"> <div id='dashboard' class="tabcontent">
<body> <body>
<h3>Redeems Dashboard</h3> <h3>Redeems Dashboard</h3>
{% if (username and users ) %} {% if (username and users ) %}
@ -30,23 +23,15 @@
<th>Your points balance</th> <th>Your points balance</th>
</tr> </tr>
</thead> </thead>
<tbody>
{% for user in users %} {% for user in users %}
<tr> <tbody>
<td> {{ user[0] }} </td> <td> {{ user[0] }} </td>
<td> {{ user[1] }} </td> <td> {{ user[1] }} </td>
</tr>
{% endfor %}
</tbody> </tbody>
{% endfor %}
</table> </table>
{% endif %} {% endif %}
{% if passive %}
<h3>Tlapbot is currently in passive mode.</h3>
<p>You can't make any redeems, but you will receive points for watching.</p>
{% endif %}
{% if not passive %}
{% if counters %} {% if counters %}
<table> <table>
<thead> <thead>
@ -54,49 +39,20 @@
<th>Active counters</th> <th>Active counters</th>
</tr> </tr>
</thead> </thead>
<tbody>
{% for counter in counters %} {% for counter in counters %}
<tr>
<td> {{ counter[0] }} </td>
<td> {{ counter[1] }} </td>
</tr>
{% endfor %}
</tbody>
</table>
{% endif %}
{% if milestones %}
<table>
<thead>
<tr>
<th colspan="2">Active milestones</th>
<th>Progress</th>
</tr>
</thead>
<tbody> <tbody>
{% for milestone in milestones %} <td> {{ counter[0] }} </td>
<tr> <td> {{ counter[1] }} </td>
<td> {{ milestone[0] }} </td>
<td> <progress id="file" max={{ milestone[2] }} value={{ milestone[1] }}></progress></td>
<td> {{ milestone[1] }} / {{ milestone[2] }}</td>
</tr>
{% endfor %}
</tbody> </tbody>
{% endfor %}
</table> </table>
{% endif %} {% endif %}
{% endif %}
</body>
</div>
<div id='redeem-queue' class="tabcontent">
<body>
<h3>Redeems Queue</h3>
<p>Past redeemed redeems with timestamps and notes.</p>
{% if queue %} {% if queue %}
<table> <table>
<thead> <thead>
<tr> <tr>
<th colspan="2">Recent redeems</th> <th>Recent redeems</th>
</tr> </tr>
<tr> <tr>
<th>Time</th> <th>Time</th>
@ -105,18 +61,16 @@
<th>Note</th> <th>Note</th>
</tr> </tr>
</thead> </thead>
<tbody>
{% for row in queue %} {% for row in queue %}
<tr> <tbody>
<td>{{ row[0].replace(tzinfo=utc_timezone).astimezone().strftime("%H:%M") }}</td> <td>{{ row[0].replace(tzinfo=utc_timezone).astimezone().strftime("%H:%M") }}</td>
<td>{{ row[1] }}</td> <td>{{ row[1] }}</td>
<td>{{ row[3] }}</td> <td>{{ row[3] }}</td>
{% if row[2] %} {% if row[2] %}
<td>{{ row[2] }}</td> <td>{{ row[2] }}</td>
{% endif %} {% endif %}
</tr>
{% endfor %}
</tbody> </tbody>
{% endfor %}
</table> </table>
{% endif %} {% endif %}
</body> </body>
@ -129,10 +83,7 @@
<li><strong>Counter</strong> redeems add +1 to their counter.</li> <li><strong>Counter</strong> redeems add +1 to their counter.</li>
<li><strong>List</strong> redeems get added to the list of recent redeems (without a note).</li> <li><strong>List</strong> redeems get added to the list of recent redeems (without a note).</li>
<li><strong>Note</strong> redeems require you to send a message together with the redeem.</li> <li><strong>Note</strong> redeems require you to send a message together with the redeem.</li>
<li><strong>Milestone</strong> redeems are long-term goals to which you can donate any amount of points you
want. They will be completed once the amount of points donated reaches the goal.</li>
</ul> </ul>
<body> <body>
{% if redeems %} {% if redeems %}
<table> <table>
@ -144,22 +95,16 @@
<th>Description</th> <th>Description</th>
</tr> </tr>
</thead> </thead>
<tbody>
{% for redeem, redeem_info in redeems.items() %} {% for redeem, redeem_info in redeems.items() %}
<tr> <tbody>
<td>{{ prefix }}{{ redeem }}</td> <td>{{ prefix }}{{ redeem }}</td>
{% if redeem_info["type"] == "milestone" %} <td>{{ redeem_info["price"] }}</td>
<td></td> <td>{{ redeem_info["type"] }}</td>
{% else %} {% if redeem_info["info"] %}
<td>{{ redeem_info["price"] }}</td> <td>{{ redeem_info["info"] }}</td>
{% endif %} {% endif %}
<td>{{ redeem_info["type"] }}</td>
{% if redeem_info["info"] %}
<td>{{ redeem_info["info"] }}</td>
{% endif %}
</tr>
{% endfor %}
</tbody> </tbody>
{% endfor %}
</table> </table>
{% endif %} {% endif %}
</body> </body>
@ -172,4 +117,4 @@
</div> </div>
</html> </html>