Skip to content

Latest commit

 

History

History
459 lines (263 loc) · 7.55 KB

trivia.rst

File metadata and controls

459 lines (263 loc) · 7.55 KB
Raw

Trivia

This is the cog guide for the trivia cog. You will find detailed docs about usage and commands.

[p] is considered as your prefix.

Note

To use this cog, load it by typing this:

[p]load trivia

Usage

This cog allows for playing trivia with others. You may choose to play just one category at a time or choose multiple to add variety to your game. You can even create your own lists!

Commands

Here is a list of all of the commands for this cog:

triviaset

Note

|mod-lock|

Syntax

[p]triviaset

Description

Commands for managing trivia settings.

triviaset botplays

Note

|mod-lock|

Syntax

[p]triviaset botplays <true_or_false>

Description

Sets whether the bot gains a point if nobody guesses correctly.

Arguments

  • <true_or_false> If true, the bot will gain a point if nobody guesses correctly, otherwise it will not.

triviaset maxscore

Note

|mod-lock|

Syntax

[p]triviaset maxscore <score>

Description

Sets the total points required to win.

Arguments

  • <score> The amount of points required to win.

triviaset override

Note

|mod-lock|

Syntax

[p]triviaset override <enabled>

Description

Allow/disallow trivia lists to override the settings.

Arguments

  • <enabled> Whether trivia lists should be able to override settings.

triviaset payout

Note

|mod-lock|

Syntax

[p]triviaset payout <multiplier>

Description

Sets the payout multiplier.

If a user wins trivia when at least 3 users are playing, they will receive credits; the amount received is determined by multiplying their total score by this multiplier.

Arguments

  • <multiplier> The amount to multiply the winner's score by to determine payout. This can be any positive decimal number. Setting this to 0 will disable.

triviaset revealanswer

Note

|mod-lock|

Syntax

[p]triviaset revealanswer <true_or_false>

Description

Sets whether or not the answer is revealed if the time limit for answering runs out.

Arguments

  • <true_or_false> If true, the bot will reveal the answer if there is no correct guess within the time limit.

triviaset showsettings

Note

|mod-lock|

Syntax

[p]triviaset showsettings

Description

Shows the current trivia settings.

triviaset stopafter

Note

|mod-lock|

Syntax

[p]triviaset stopafter <seconds>

Description

Sets how long the bot should wait before stopping the trivia session due to lack of response.

Arguments

  • <seconds> The number of seconds to wait before stopping the session.

triviaset timelimit

Note

|mod-lock|

Syntax

[p]triviaset timelimit <seconds>

Description

Sets the maximum time permitted to answer a question.

Arguments

  • <seconds> The number of seconds to wait for an answer.

triviaset custom

Syntax

[p]triviaset custom

Description

Manage custom trivia lists.

Tip

Looking to learn how to create your own trivia lists? See :ref:`here <guide_trivia_list_creation>` for more information.

triviaset custom upload

Syntax

[p]triviaset custom upload

Description

Upload a custom trivia list. The bot will prompt you to upload your list as an attachment in Discord.

triviaset custom list

Syntax

[p]triviaset custom list

Description

List all uploaded custom trivia lists.

triviaset custom delete

Syntax

[p]triviaset custom delete <name>

Description

Delete a custom trivia list.

Arguments

  • <name> The name of the custom list to be deleted.

trivia

Syntax

[p]trivia <categories...>

Description

Start a trivia session on the specified category.

Multiple categories can be listed, in which case the trivia session will use all of the specified lists to select questions from.

Arguments

  • <categories...> The category to play. Can be multiple.

trivia info

Syntax

[p]trivia info <category>

Description

Get information about a trivia category.

Arguments

  • <category>: The category to get the information for.

trivia leaderboard

Syntax

[p]trivia leaderboard

Description

Shows the trivia leaderboard. Defaults to the top ten in the current server, sorted by total wins. The subcommands provide more customized leaderboards.

trivia leaderboard global

Syntax

[p]trivia leaderboard global [sort_by=wins] [top=10]

Description

The global trivia leaderboard.

Arguments

  • [sort_by=wins] The method by which to sort the leaderboard (defaults to wins). Can be one of:

    • wins Total wins
    • avg Average score
    • total Total correct answers from all sessions
    • games Total games played.

  • [top=10] The number of ranks to show on the leaderboard. Defaults to 10

trivia leaderboard server

Syntax

[p]trivia leaderboard server [sort_by=wins] [top=10]

Description

The trivia leaderboard for this server.

Arguments

  • [sort_by=wins] The method by which to sort the leaderboard (defaults to wins). Can be one of:

    • wins Total wins
    • avg Average score
    • total Total correct answers from all sessions
    • games Total games played.

  • [top=10] The number of ranks to show on the leaderboard. Defaults to 10

trivia list

Syntax

[p]trivia list

Description

Lists the available trivia categories

trivia stop

Syntax

[p]trivia stop

Description

Stops an ongoing trivia session.