From 8c19088640635c804bfe349b89a86ccfc63d3c2e Mon Sep 17 00:00:00 2001 From: Lili Date: Thu, 13 Jul 2023 12:44:15 +0200 Subject: [PATCH] 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 --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1207791..f2be8fe 100644 --- a/README.md +++ b/README.md @@ -323,22 +323,21 @@ 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": {"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 `"type"`, -an entry for `"price"` unless the redeem is a milestone, -and optionally `"info"` and `"category"`. -If the `"type"` is `"milestone"`, there's an additional required `"goal"` field as well. +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. +- `"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). -- `"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