Document setting overrides in Trivia list format (#5390)

Co-authored-by: Jakub Kuczys <me@jacken.men>
This commit is contained in:
Vexed 2023-03-02 14:54:51 +00:00 committed by GitHub
parent 8de6b97700
commit 2ab204438e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 63 additions and 10 deletions

View File

@ -111,11 +111,11 @@ As you've added more questions, your file should look something like this:
- Chelsea
- chelsea f.c.
How much money is a US Olympic gold medalist awarded?:
- $25,000
- 25,000
- 25k
- 25000
- $25000
- $37,500
- 37,500
- 37.5k
- 37500
- $37500
You can keep adding questions until you are satisfied, and then you can upload and
play your very own trivia! See :ref:`[p]triviaset custom <trivia-command-triviaset-custom>` for more information.
@ -123,3 +123,56 @@ play your very own trivia! See :ref:`[p]triviaset custom <trivia-command-trivias
Still stuck? Take a look at
`the core trivia lists <https://github.com/Cog-Creators/Red-DiscordBot/tree/V3/develop/redbot/cogs/trivia/data/lists>`_
for reference.
--------------------------
Optional: Custom Overrides
--------------------------
Once you've got the hang of the question-answer format,
you might want to add some custom overrides with the CONFIG key - in a similar way to the AUTHOR key.
These will override the settings set with :ref:`[p]triviaset <trivia-command-triviaset>`.
For example, with a trivia list which has questions that are quick to answer you could decrease the time limit
and require a higher score to win.
Here are all the overrides available:
.. code-block:: yaml
CONFIG:
bot_plays: true or false # bot gains points if no one answers correctly
delay: positive number # answer time limit (seconds), must be greater than or equal to 4
timeout: positive number # timeout for no responses (seconds), must be greater than delay
max_score: positive integer # points required to win
reveal_answer: true or false # reveal answer on timeout
payout_multiplier: non-negative number # payout multiplier
use_spoilers: true or false # use spoilers in answers
So, your final file might look something like this:
.. code-block:: yaml
AUTHOR: Red
CONFIG:
bot_plays: false
use_spoilers: true
delay: 20
payout_multiplier: 0.5
max_score: 20
How many days are there in a regular year?:
- 365
- three hundred and sixty five
"Who is the #1 followed user on Twitter?":
- Barack Obama
- Obama
What is the only sea without any coasts?:
- Sargasso
- Sargasso Sea
Who won the Premier League in 2015?:
- Chelsea
- chelsea f.c.
How much money is a US Olympic gold medallist awarded?:
- $37,500
- 37,500
- 37.5k
- 37500
- $37500

View File

@ -32,11 +32,11 @@ How many world records did swimmer Mark Spitz set when he won seven gold medals
- 7
- seven
How much money is a US Olympic gold medalist awarded?:
- $25,000
- 25,000
- 25k
- 25000
- $25000
- $37,500
- 37,500
- 37.5k
- 37500
- $37500
In 1998, what Major League Baseball player broke the single season home run record previously set by Roger Maris?:
- Mark McGwire
In golf, what do you call a score of 4 under par on any given hole?: