Maiden-Trivia

About

This agent provides a simple trivia game for players in a chat channel. It also allows players to create, edit, and manage the existing questions in the system. Unfortunately, due to it being seemingly impossible to find a machine-readable, high-quality, free set of trivia questions on the internet, no standard set of questions is included in this library.

How To

Start a new trivia game by selecting a set of categories for the questions to use.

::start trivia game science technology

It should not show a first question. If someone in the channel answers the question correctly, they will be awarded points, and the next question is shown. If they are quick enough, they get a time bonus. If nobody manages to answer the question correctly, you can request a hint.

::hint answer

Not all questions include a hint however, and not all hints may be sufficiently indicative of the correct answer. You can also skip the question entirely.

::skip question

Finally, the game ends when all questions have been answered, or when it is ended explicitly.

:end trivia game

At the end the winner is announced.

See the rest of the commands on how to manage the questions.

Package Index

MAIDEN-TRIVIA (ORG.SHIRAKUMO.MAIDEN.AGENTS.TRIVIA)

class
ADD-CATEGORIES
```
 
```
class
ADD-QUESTION
```
 
```

class

`CHANNEL`

Object representing a channel on a remote system somewhere.

Channels are virtual "rooms" over which one or more users may
communicate with each other.

Channels have a name and a number of users that inhabit it.
Additional properties are not guaranteed, but may be provided by a
client.

See CLIENT-ENTITY
See USERS

class
END
```
 
```

class

`GAME`

This class represents a trivia game.

It holds all necessary state information for a game to be
played.

See CHANNEL
See QUESTIONS
See QUESTION-TIME
See QUESTION-LIMIT
See SCORES
See START
See END
See ANSWER
See SKIP
See WINNER
See HINT
See MAKE-GAME

class
HINT
```
 
```

class

`QUESTION`

Class to represent a trivia question.

A question contains a question text and a list of possible answers.
It may also include an optional hint to help players find an answer.
Each question gets a unique ID to identify it by.

See TEXT
See ANSWERS
See HINT
See ID
See ADD-QUESTION
See UPDATE-QUESTION
See REMOVE-QUESTION

class
REMOVE-CATEGORIES
```
 
```
class
REMOVE-QUESTION
```
 
```
class
SKIP
```
 
```
class
START
```
 
```
class
TRIVIA
```
Provides a standard trivia game.
```
class
UPDATE-QUESTION
```
 
```

accessor (

`ANSWERS`

OBJECT)

Accessor to the list of accepted answers for the question.

Each answer should represent a substring that a potential answer
must contain in order for it to be accepted as an answer to the
question. This is done to reduce the potential for speech artefacts
marking correct questions as invalid.

See QUESTION

accessor (

`CHANNEL`

OBJECT)

Accessor to the channel that the game is being played on.

See MAIDEN-CLIENT-ENTITIES:CHANNEL
See GAME

accessor (

`HINT`

OBJECT)

Accessor to the potential hint the question has to its solution.

May be a string or NIL.

See QUESTION

accessor (

`ID`

OBJECT)

Accessor to the IDentity of an entity.

By default this is initialised to a fresh UUIDv4 string.

See ENTITY

accessor (

`QUESTION`

ID)

Accessor to the question instance of the given ID.

See *QUESTIONS*
See QUESTION

accessor (

`QUESTION-LIMIT`

OBJECT)

Accessor to the number of seconds players have to answer a question and get bonus points for.

See GAME

accessor (

`QUESTION-TIME`

OBJECT)

Accessor to the universal-time that denotes when the current question was asked.

See GAME

accessor (

`QUESTIONS`

OBJECT)

Accessor to the list of questions that the game can use.

See QUESTION
See GAME

accessor (

`SCORES`

OBJECT)

Accessor to the alist of users to their scores.

See MAIDEN-CLIENT-ENTITIES:USER
See GAME

accessor (

`TEXT`

OBJECT)

Accessor to the text of the question.

See QUESTION

function (

`ADD-CATEGORY`

CATEGORY ID)

Create a new category or add a card to an existing category.

ID has to be either a question's ID or a question object.

See *CATEGORIES*

function (

`ADD-QUESTION`

QUESTION ANSWERS &KEY HINT CATEGORIES)

Add a new question to the system.

See ADD-CATEGORY
See QUESTION

function (

`CATEGORIES`

&OPTIONAL ID)

Return a list of all known categories, or a list of categories for the given question.

ID has to be either NIL (for all categories), or the ID of
question, or a question object.

See *CATEGORIES*

function (

`CATEGORY`

CATEGORY)

Accessor to the list of question cards contained in the category.

If no such category is known, an error is signalled.

See *CATEGORIES*
See QUESTION

function (

`GAME`

C EV &OPTIONAL (ERROR T))

Attempt to find a suitable game instance for the given client and event.

If error is non-NIL and no game could be found, an error is signalled.

See GAMES
See TRIVIA

function (

`LOAD-QUESTIONS`

)

Load all question cards and categories from the disk storage.

See MAIDEN-STORAGE:RESTORE

function (

`MAKE-GAME`

CHANNEL CATEGORIES &KEY (LIMIT 30))

Create a new trivia game for the given channels, using questions from the specified categories.

See CATEGORIES
See GAME

function (

`REMOVE-CATEGORY`

CATEGORY &OPTIONAL ID)

Remove the category of the given name or the given card from the category.

ID has to be either NIL (for the entire category), or the
ID of a question, or a question object.

See *CATEGORIES*

function (

`REMOVE-QUESTION`

ID)

Remove the question of the given ID from the system.

This also makes sure to remove the ID references from all
categories the question was in previously.

See *CATEGORIES*
See REMQUESTION

function (

`SAVE-QUESTIONS`

)

Save all question cards and categories to the disk storage.

See MAIDEN-STORAGE:OFFLOAD

function (

`UPDATE-QUESTION`

ID &KEY QUESTION ANSWERS (HINT NIL HINT-P) (CATEGORIES NIL CAT-P))

Update an existing question with new fields.

If a question of the requested ID does not exist, an error
is signalled.

See QUESTION

generic (

`ANSWER`

USER ANSWER GAME)

Submit an answer for the current question in the game on behalf of a user.

If the answer is incorrect or the game is not running, nothing happens.
Otherwise, the scores are adjusted and the next question is made current.

See GAME
See CHECK

generic (

`CHECK`

ANSWER QUESTION)

Returns true if the answer is an accepted answer for the question.

See QUESTION
See ANSWERS

generic (
END
GAME)
```
Stop the game.

See GAME
```
generic (
SKIP
GAME)
```
Skip the current question.

See GAME
```

generic (

`START`

EVENT-DELIVERY)

Start the event delivery and make it ready to accept and deliver events.

If the delivery is already running this does nothing.

generic (

`WINNER`

GAME)

Return the winner of the game.

This only returns something if the game is not running.

See GAME
See SCORES

command (
add trivia categories
ID &REST CATEGORIES)
```
Add new categories for questions.
```

command (

`add trivia question`

QUESTION ANSWERS &KEY HINT (CATEGORIES ""))

Add a new trivia question. The answers should be a string that is comma-separated.

command

`end trivia game`

End the current trivia game. This will show the winner with the most points.

command

`hint answer`

Request a hint for the current question.

command (
remove trivia categories
ID &REST CATEGORIES)
```
Remove categories for questions.
```

command (

`remove trivia question`

ID)

Remove an existing question. You need to use the ID of the question exactly.

command
skip question
```
Skip the current question.
```

command (

`start trivia game`

&REST CATEGORIES)

Start a new trivia game. You need to specify a number of categories from which questions can be selected. Users don't have to explicitly join. Whoever replies with the correct answer first wins the point.

command (

`update trivia question`

ID &KEY QUESTION ANSWERS HINT CATEGORIES)

Update an existing question. You need to use the ID of the question exactly.

About

How To

Copyright

Package Index

MAIDEN-TRIVIA (ORG.SHIRAKUMO.MAIDEN.AGENTS.TRIVIA)