From abbc099661a837d1f3546d525ee86da973a7803b Mon Sep 17 00:00:00 2001 From: Lili Date: Tue, 21 Mar 2023 11:46:28 +0100 Subject: [PATCH] add new default milestone update wording on "price" to mention milestone minimum bid --- README.md | 4 ++-- tlapbot/default_redeems.py | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 52f6bba..9e63390 100644 --- a/README.md +++ b/README.md @@ -307,10 +307,10 @@ REDEEMS={ `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"`. -- `"price"` value should be an integer that decides how many points the redeem will cost. +- `"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). -- `"goal"` is a required field for `"milestone"` goals. It should be an integer, deciding the amount of points required to complete the milestone. +- `"goal"` is a required field for milestone goals. It should be an integer, deciding the amount of points required to complete the milestone. - `"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 diff --git a/tlapbot/default_redeems.py b/tlapbot/default_redeems.py index 6df5bbf..bcc6f1b 100644 --- a/tlapbot/default_redeems.py +++ b/tlapbot/default_redeems.py @@ -3,5 +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} "inactive": {"price": 100, "type": "note", "info": "Example redeem that is inactive by default", "category": ["inactive"]} } \ No newline at end of file