|
|
|
|
@ -30,10 +30,27 @@ To play a game I recommend:
|
|
|
|
|
|
|
|
|
|
The Question File
|
|
|
|
|
-----------------
|
|
|
|
|
A question file is a yaml-file defining all sections and questions used in the
|
|
|
|
|
game. For an example look into `questions/template.q`. It can contain an arbitrary
|
|
|
|
|
number of sections, though five are generally recommended. Each section has exactly
|
|
|
|
|
five questions. A question can have the following keys:
|
|
|
|
|
The game needs questions to run the game. A question file is a yaml-file
|
|
|
|
|
containing either all questions or a link to the respective files containing
|
|
|
|
|
said questions.
|
|
|
|
|
|
|
|
|
|
The top-level question file contains two keys:
|
|
|
|
|
|
|
|
|
|
- Name (name of the round, displayed on top of the board)
|
|
|
|
|
- Sections (a list of question files with sections to include)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
Name: Round 2
|
|
|
|
|
Sections:
|
|
|
|
|
- test.q
|
|
|
|
|
- cpu.q
|
|
|
|
|
- extra/foo.q
|
|
|
|
|
- xkcd.q
|
|
|
|
|
|
|
|
|
|
A question file containing sections can contain an arbitrary number of sections.
|
|
|
|
|
Each section needs to have exactly five questions. A question can have the
|
|
|
|
|
following keys:
|
|
|
|
|
|
|
|
|
|
- Name (to remind you of the question number)
|
|
|
|
|
- Question (text/image/... displayed on screen)
|
|
|
|
|
@ -42,7 +59,7 @@ five questions. A question can have the following keys:
|
|
|
|
|
- Double-Jeopardy (if the question is a Double-Jeopardy, default false)
|
|
|
|
|
- Audio (for videos, if the video should have audio or not, default false)
|
|
|
|
|
|
|
|
|
|
Four *Types* of question are supported:
|
|
|
|
|
Five *Types* of question are supported:
|
|
|
|
|
|
|
|
|
|
- Text: The text is normally displayed on screen
|
|
|
|
|
- Code: The code is displayed with a monospace font, tabs are replaced with
|
|
|
|
|
@ -51,6 +68,20 @@ Four *Types* of question are supported:
|
|
|
|
|
- Music: The Question key is a path to a music file, which is played
|
|
|
|
|
- Video: The Question key is a path to a video file, which is played
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
- Section: Test
|
|
|
|
|
Questions:
|
|
|
|
|
- Name: Question 1
|
|
|
|
|
Question: This text is displayed
|
|
|
|
|
Answer: This is never displayed, only for you to remember the answer
|
|
|
|
|
Type: Text
|
|
|
|
|
|
|
|
|
|
- Name: Question 2
|
|
|
|
|
Question: path/to/test.png
|
|
|
|
|
Answer: Bar
|
|
|
|
|
Type: Image
|
|
|
|
|
...
|
|
|
|
|
|
|
|
|
|
Gamestate
|
|
|
|
|
---------
|
|
|
|
|
|
