Compare commits

...

36 Commits

Author SHA1 Message Date
Lili (Tlapka) afd0a0d0a3 another readme update
because im nervous
2024-03-10 18:04:19 +01:00
Lili (Tlapka) 2a6aa58ced readme updates -- better description of what tlapbot does
some small fixes
2024-02-26 17:36:06 +01:00
Lili (Tlapka) 2284fb3a00 1.2.2 release 2024-02-11 20:17:17 +01:00
Lili (Tlapka) 3fe454d35c promote to alpha 2 2024-02-10 15:00:35 +01:00
Lili (Tlapka) f1a57c16e4 style corrections 2024-02-10 13:38:26 +01:00
Lili (Tlapka) 7da002eb00 remove unused imports, variables 2024-02-10 13:33:09 +01:00
Lili (Tlapka) 5e7810eb9f another list_redeems fix
dont use list_redeems
2024-02-10 12:21:29 +01:00
Lili (Tlapka) 61d318f418 fix and improve LIST_REDEEMS 2024-02-10 11:57:57 +01:00
Lili (Tlapka) ba30c96c01 warning improvement 2024-02-10 11:49:09 +01:00
Lili (Tlapka) 6d3a4671cc fix dictionary iteration in redeems 2024-02-10 11:31:51 +01:00
Lili (Tlapka) 384ca03e23 rewrite space warning 2024-02-06 20:16:54 +01:00
Lili (Tlapka) 7722bdf608 add redeem name warning to init 2024-02-06 20:15:58 +01:00
Lili (Tlapka) 7dfc8faae7 add warning about spaces 2024-02-06 20:12:12 +01:00
Lili (Tlapka) 8e4d21c02f clarify positivity of integer 2024-02-06 19:11:53 +01:00
Lili (Tlapka) 571aa47aab make zero points not redeemable 2024-02-06 19:10:37 +01:00
Lili (Tlapka) 433564bddf only one debug log for terminal needed 2024-02-06 19:06:00 +01:00
Lili (Tlapka) 1abab80da4 promote to 1.2.2a1 2024-02-06 18:21:38 +01:00
Lili (Tlapka) 894ff175a6 remove redundant line ends 2024-02-06 18:18:15 +01:00
Lili (Tlapka) 6641121ca3 add <br>s to help message construction 2024-02-04 18:09:47 +01:00
Lili (Tlapka) 7ffb1a15b0 change webhook to use rawBody instead of body when reading msg
remove_emoji function is now unused, as shortcodes get scrubbed in rawBody now
2024-02-04 18:09:36 +01:00
Lili (Tlapka) e5e88bf520 Merge branch 'master' of github.com:SleepyLili/tlapbot into develop 2024-02-04 11:28:51 +01:00
Lili (Tlapka) b4a6c4e41c html/jinja formatting improvements
thanks chat
2024-02-03 18:47:42 +01:00
Lili (Tlapka) 8c19088640 readme: reword milestone "goal" and "price"
should hopefully suggest more clearly that milestones need goal
and everything else needs price
also changed the example to list goal first
2023-07-13 12:44:15 +02:00
Lili (Tlapka) 5316f7e205 improve default_redeems
list milestone "goal" first in the redeems dictionary
2023-07-13 12:42:46 +02:00
Lili (Tlapka) 31426fd851 promote to 1.2.1 2023-07-10 11:16:44 +02:00
Lili (Tlapka) 8d5a3cda42 update readme for 1.2.1 2023-07-10 11:13:31 +02:00
Lili (Tlapka) e237e7f885 declare alpha version 1.2.1a1 2023-07-03 12:56:03 +02:00
Lili (Tlapka) 80037593a9 fix redeem handler for redeems with no price
milestone needs to be handled first
2023-07-03 12:27:45 +02:00
Lili (Tlapka) d484a0a363 fix reset_milestone 2023-07-03 12:18:29 +02:00
Lili (Tlapka) 348e674f74 make price tab in dashboard blank for milestones 2023-07-03 11:02:09 +02:00
Lili (Tlapka) ca9aa6d79d add reset and hard-reset command to init 2023-07-03 10:46:35 +02:00
Lili (Tlapka) ae42a052de add true/false fail checks to click commands
previously click would print stuff like "X done succesfully" after error
now it'll be more clear that a failure has occured
2023-06-26 13:40:26 +02:00
Lili (Tlapka) d1416d3706 add reset-milestone and hard-reset-milestone
commands to click
2023-06-26 13:28:34 +02:00
Lili (Tlapka) f66b125ac3 remove unused start_milestone function 2023-06-26 13:12:28 +02:00
Lili (Tlapka) 6f6fc10d0f remove minimum bid for #15 2023-06-20 14:39:19 +02:00
Lili (Tlapka) bf68f518da add error handling and response check to requests 2023-06-20 13:41:22 +02:00
13 changed files with 238 additions and 135 deletions

View File

@ -2,9 +2,12 @@
Tlapbot is an [Owncast](https://owncast.online/) bot that adds channel points and
channel point redeems to your Owncast page.
The goal is to have an experience similar
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/).
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.
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
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.
@ -12,11 +15,13 @@ 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
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
doing.
doing, and sort them into categories that can be turned on and off.
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.
This allows easy browsing of active challenges and recent redeems.
This allows easy browsing of active challenges and recent redeems, without quitting the stream.
**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 has these basic commands:
- `!help` sends a help string in the chat, explaining how tlapbot works.
@ -27,12 +32,6 @@ Tlapbot has these basic commands:
use the new prefix instead.)
Tlapbot also automatically adds a command for each redeem in the redeems file.
### 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 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.
@ -52,8 +51,16 @@ The redeem queue shows a chronological list of note and list redeems with timest
#### 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 currently supports three different redeem types. Each type of a redeem
Tlapbot currently supports four different redeem types. Each type of a redeem
works slightly differently, and displays differently on the redeems dashboard.
Redeems can also optionally be sorted into "categories" that can be turned on
@ -265,6 +272,16 @@ 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 should be in the instance folder. For folder installation of tlapbot,
that's `instance/` from the root of the Github repository.
@ -313,18 +330,22 @@ REDEEMS={
"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."},
"request": {"price": 100, "type": "note", "info": "Request a level, gamemode, skin, etc."},
"go_nap": {"price": 1, "type": "milestone", "info": "Streamer will go nap when the goal is reached.", "goal": 1000},
"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"]}
}
```
#### File format
`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 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"`. If the `"type"` is `"milestone"`, there's an additional required `"goal"` field as well.
Each dictionary entry is a redeem, and the dictionary keys are strings that decide the chat command for the redeem.
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. For milestone redeems, `"price"` determines minimum bid.
- `"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).
- `"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"`.
- `"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"`, `"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"`, `"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.
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

View File

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

View File

@ -4,11 +4,11 @@ from flask import Flask
from apscheduler.schedulers.background import BackgroundScheduler
from tlapbot.db import get_db
from tlapbot.owncast_requests import is_stream_live, give_points_to_chat
from tlapbot.redeems import remove_inactive_redeems
def create_app(test_config=None):
app = Flask(__name__, instance_relative_config=True)
# ensure the instance folder exists
try:
os.makedirs(app.instance_path)
@ -30,12 +30,18 @@ def create_app(test_config=None):
gunicorn_logger = logging.getLogger('gunicorn.error')
app.logger.handlers = gunicorn_logger.handlers
app.logger.setLevel(gunicorn_logger.level)
# Check for wrong config that would break Tlapbot
if len(app.config['PREFIX']) != 1:
raise RuntimeError("Prefix is >1 character. "
"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
from . import owncast_webhooks
from . import tlapbot_dashboard
@ -49,7 +55,9 @@ def create_app(test_config=None):
app.cli.add_command(db.refresh_counters_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
def proxy_job():
with app.app_context():

View File

@ -4,6 +4,8 @@ import click
from flask import current_app, g
from flask.cli import with_appcontext
from tlapbot.redeems import milestone_complete
def get_db():
if 'db' not in g:
@ -34,6 +36,8 @@ def insert_counters(db):
db.commit()
except sqlite3.Error as e:
print("Failed inserting counters to db:", e.args[0])
return False
return True
def init_db():
@ -42,7 +46,8 @@ def init_db():
with current_app.open_resource('schema.sql') as f:
db.executescript(f.read().decode('utf8'))
insert_counters(db)
if insert_counters(db):
return True
def clear_redeem_queue():
@ -58,6 +63,8 @@ def clear_redeem_queue():
db.commit()
except sqlite3.Error as e:
print("Error occured deleting redeem queue:", e.args[0])
return False
return True
def refresh_counters():
@ -68,7 +75,9 @@ def refresh_counters():
db.commit()
except sqlite3.Error as e:
print("Error occured deleting old counters:", e.args[0])
insert_counters(db)
return False
if insert_counters(db):
return True
def refresh_milestones():
@ -89,6 +98,7 @@ def refresh_milestones():
db.commit()
except sqlite3.Error as e:
print("Failed deleting old milestones from db:", e.args[0])
return False
# add new milestones
try:
@ -113,24 +123,45 @@ def refresh_milestones():
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')
@with_appcontext
def init_db_command():
"""Clear the existing data and create new tables."""
init_db()
click.echo('Initialized the database.')
if init_db():
click.echo('Initialized the database.')
@click.command('clear-queue')
@with_appcontext
def clear_queue_command():
"""Remove all redeems from the redeem queue."""
clear_redeem_queue()
click.echo('Cleared redeem queue.')
if clear_redeem_queue():
click.echo('Cleared redeem queue.')
@click.command('refresh-counters')
@ -138,26 +169,45 @@ def clear_queue_command():
def refresh_counters_command():
"""Refresh counters from current config file.
(Remove old ones, add new ones.)"""
refresh_counters()
click.echo('Counters refreshed.')
if refresh_counters():
click.echo('Counters refreshed.')
@click.command('clear-refresh')
@with_appcontext
def refresh_and_clear_command():
"""Refresh counters and clear queue."""
refresh_counters()
clear_redeem_queue()
click.echo('Counters refreshed and queue cleared.')
if refresh_counters() and 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,
"""Initialize all milestones from the redeems file,
delete milestones not in redeem file."""
refresh_milestones()
click.echo('Refreshed milestones.')
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):

View File

@ -3,6 +3,6 @@ REDEEMS={
"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."},
"request": {"price": 100, "type": "note", "info": "Request a level, gamemode, skin, etc."},
"go_nap": {"price": 1, "type": "milestone", "info": "Streamer will go nap when the goal is reached.", "goal": 1000},
"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"]}
}

View File

@ -4,20 +4,27 @@ from tlapbot.owncast_requests import send_chat
def send_help():
message = []
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.\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.\n")
message.append("""Tlapbot commands:
!help to see this help message.
!points to see your points.\n"""
message.append("Tlapbot gives you points for being in chat, and then allows you to spend those points. <br>")
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("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("""Tlapbot commands: <br>
!help to see this help message. <br>
!points to see your points. <br>"""
)
if current_app.config['LIST_REDEEMS']:
message.append("Active redeems:\n")
message.append("Active redeems: <br>")
for redeem, redeem_info in current_app.config['REDEEMS'].items():
if 'info' in redeem_info:
message.append(f"!{redeem} for {redeem_info['price']} points. {redeem_info['info']}\n")
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.\n")
message.append(f"!{redeem} for {redeem_info['price']} points.")
if 'info' in redeem_info:
message.append(f" {redeem_info['info']} <br>")
else:
message.append("<br>")
else:
message.append("Check the dashboard for a list of currently active redeems.")
send_chat(''.join(message))

View File

@ -2,6 +2,7 @@ from flask import current_app
from sqlite3 import Error
from re import sub
# # # db stuff # # #
def read_users_points(db, user_id):
"""Errors out if user doesn't exist."""
@ -97,7 +98,7 @@ def add_user_to_database(db, user_id, display_name):
def change_display_name(db, user_id, new_name):
try:
cursor = db.execute(
db.execute(
"UPDATE points SET name = ? WHERE id = ?",
(new_name, user_id)
)
@ -109,7 +110,7 @@ def change_display_name(db, user_id, new_name):
def remove_duplicate_usernames(db, user_id, username):
try:
cursor = db.execute(
db.execute(
"""UPDATE points
SET name = NULL
WHERE name = ? AND NOT id = ?""",
@ -121,6 +122,7 @@ def remove_duplicate_usernames(db, user_id, username):
# # # misc. stuff # # #
# This is now unused since rawBody attribute of the webhook now returns cleaned-up emotes.
def remove_emoji(message):
return sub(
r'<img class="emoji" alt="(:.*?:)" title=":.*?:" src="/img/emoji/.*?">',

View File

@ -16,17 +16,32 @@ def is_stream_live():
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)
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'])
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})
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

@ -36,22 +36,22 @@ def owncast_webhook():
user_id = data["eventData"]["user"]["id"]
display_name = data["eventData"]["user"]["displayName"]
current_app.logger.debug(f'New chat message from {display_name}:')
current_app.logger.debug(f'{data["eventData"]["body"]}')
if data["eventData"]["body"].startswith(f"{prefix}help"):
current_app.logger.debug(f'{data["eventData"]["rawBody"]}')
if data["eventData"]["rawBody"].startswith(f"{prefix}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)
if points is None:
send_chat("Error reading points.")
else:
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
# event. Also removes saved usernames from users with same name
# if user is authenticated.
change_display_name(db, user_id, display_name)
if data["eventData"]["user"]["authenticated"]:
remove_duplicate_usernames(db, user_id, display_name)
elif data["eventData"]["body"].startswith(prefix):
handle_redeem(data["eventData"]["body"], user_id)
elif data["eventData"]["rawBody"].startswith(prefix):
handle_redeem(data["eventData"]["rawBody"], user_id)
return data

View File

@ -23,7 +23,7 @@ def counter_exists(db, counter_name):
def add_to_counter(db, counter_name):
if counter_exists(db, counter_name):
try:
cursor = db.execute(
db.execute(
"UPDATE counters SET count = count + 1 WHERE name = ?",
(counter_name,)
)
@ -37,7 +37,7 @@ def add_to_counter(db, counter_name):
def add_to_redeem_queue(db, user_id, redeem_name, note=None):
try:
cursor = db.execute(
db.execute(
"INSERT INTO redeem_queue(redeem, redeemer_id, note) VALUES(?, ?, ?)",
(redeem_name, user_id, note)
)
@ -49,24 +49,6 @@ def add_to_redeem_queue(db, user_id, redeem_name, note=None):
return False
def start_milestone(db, redeem_name):
try:
cursor = db.execute(
"SELECT progress, goal FROM milestones WHERE name = ?",
(redeem_name,)
)
milestone = cursor.fetchone()
current_app.logger.error(f"Milestone: {milestone}")
if milestone is None:
cursor = db.execute(
"INSERT INTO milestones(name, progress, goal) VALUES(?, ?, ?)",
(redeem_name, 0, current_app.config['REDEEMS'][redeem_name]['goal'])
)
db.commit()
except Error as e:
current_app.logger.error(f"Error occured adding a milestone: {e.args[0]}")
def add_to_milestone(db, user_id, redeem_name, points_donated):
try:
cursor = db.execute(
@ -177,7 +159,7 @@ def all_active_milestones(db):
return all_active_milestones
def all_active_redeems(db):
def all_active_redeems():
redeems = current_app.config['REDEEMS']
all_active_redeems = {}
for redeem_name, redeem_dict in redeems.items():

View File

@ -1,9 +1,9 @@
from flask import current_app
from tlapbot.db import get_db
from tlapbot.owncast_requests import send_chat
from tlapbot.redeems import (add_to_redeem_queue, add_to_counter, add_to_milestone,
from tlapbot.redeems import (add_to_redeem_queue, add_to_counter, add_to_milestone,
check_apply_milestone_completion, milestone_complete, is_redeem_active)
from tlapbot.owncast_helpers import use_points, read_users_points, remove_emoji
from tlapbot.owncast_helpers import use_points, read_users_points
def handle_redeem(message, user_id):
@ -22,10 +22,31 @@ def handle_redeem(message, user_id):
return
db = get_db()
price = current_app.config['REDEEMS'][redeem]["price"]
redeem_type = current_app.config['REDEEMS'][redeem]["type"]
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:
send_chat(f"Can't redeem {redeem}, you don't have enough points.")
return
@ -45,27 +66,10 @@ def handle_redeem(message, user_id):
if not note:
send_chat(f"Cannot redeem {redeem}, no note included.")
return
if (add_to_redeem_queue(db, user_id, redeem, remove_emoji(note)) and
if (add_to_redeem_queue(db, user_id, redeem, note) and
use_points(db, user_id, price)):
send_chat(f"{redeem} redeemed for {price} points.")
else:
send_chat(f"Redeeming {redeem} failed.")
elif 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 an integer.")
elif int(note) < price:
send_chat(f"Can't redeem {redeem}, your donation is below the minimum bid of {price}.")
elif int(note) > points:
send_chat(f"Can't redeem {redeem}, you're donating more points than you have.")
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 {redeem} failed.")
else:
send_chat(f"{redeem} not redeemed, type of redeem not found.")

View File

@ -30,12 +30,14 @@
<th>Your points balance</th>
</tr>
</thead>
{% for user in users %}
<tbody>
<td> {{ user[0] }} </td>
<td> {{ user[1] }} </td>
</tbody>
{% for user in users %}
<tr>
<td> {{ user[0] }} </td>
<td> {{ user[1] }} </td>
</tr>
{% endfor %}
</tbody>
</table>
{% endif %}
@ -52,12 +54,14 @@
<th>Active counters</th>
</tr>
</thead>
{% for counter in counters %}
<tbody>
<td> {{ counter[0] }} </td>
<td> {{ counter[1] }} </td>
</tbody>
{% for counter in counters %}
<tr>
<td> {{ counter[0] }} </td>
<td> {{ counter[1] }} </td>
</tr>
{% endfor %}
</tbody>
</table>
{% endif %}
{% if milestones %}
@ -68,13 +72,15 @@
<th>Progress</th>
</tr>
</thead>
{% for milestone in milestones %}
<tbody>
<td> {{ milestone[0] }} </td>
<td> <progress id="file" max={{ milestone[2] }} value={{ milestone[1] }}></progress></td>
<td> {{ milestone[1] }} / {{ milestone[2] }}</td>
</tbody>
{% for milestone in milestones %}
<tr>
<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>
</table>
{% endif %}
{% endif %}
@ -99,16 +105,18 @@
<th>Note</th>
</tr>
</thead>
{% for row in queue %}
<tbody>
<td>{{ row[0].replace(tzinfo=utc_timezone).astimezone().strftime("%H:%M") }}</td>
<td>{{ row[1] }}</td>
<td>{{ row[3] }}</td>
{% if row[2] %}
<td>{{ row[2] }}</td>
{% endif %}
</tbody>
{% for row in queue %}
<tr>
<td>{{ row[0].replace(tzinfo=utc_timezone).astimezone().strftime("%H:%M") }}</td>
<td>{{ row[1] }}</td>
<td>{{ row[3] }}</td>
{% if row[2] %}
<td>{{ row[2] }}</td>
{% endif %}
</tr>
{% endfor %}
</tbody>
</table>
{% endif %}
</body>
@ -136,16 +144,22 @@
<th>Description</th>
</tr>
</thead>
{% for redeem, redeem_info in redeems.items() %}
<tbody>
<td>{{ prefix }}{{ redeem }}</td>
<td>{{ redeem_info["price"] }}</td>
<td>{{ redeem_info["type"] }}</td>
{% if redeem_info["info"] %}
<td>{{ redeem_info["info"] }}</td>
{% endif %}
</tbody>
{% for redeem, redeem_info in redeems.items() %}
<tr>
<td>{{ prefix }}{{ redeem }}</td>
{% if redeem_info["type"] == "milestone" %}
<td></td>
{% else %}
<td>{{ redeem_info["price"] }}</td>
{% endif %}
<td>{{ redeem_info["type"] }}</td>
{% if redeem_info["info"] %}
<td>{{ redeem_info["info"] }}</td>
{% endif %}
</tr>
{% endfor %}
</tbody>
</table>
{% endif %}
</body>

View File

@ -1,8 +1,8 @@
from flask import render_template, Blueprint, request, current_app
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 read_all_users_with_username
from datetime import datetime, timezone
from tlapbot.owncast_helpers import read_all_users_with_username
from datetime import timezone
bp = Blueprint('redeem_dashboard', __name__)
@ -20,7 +20,7 @@ def dashboard():
queue=pretty_redeem_queue(db),
counters=all_active_counters(db),
milestones=all_active_milestones(db),
redeems=all_active_redeems(db),
redeems=all_active_redeems(),
prefix=current_app.config['PREFIX'],
passive=current_app.config['PASSIVE'],
username=username,