A Basic QuizMaster Tutorial

Introduction

Welcome to this QuizMaster tutorial! The guide will help you understand how to use key features of the QuizMaster application, an open-source alternative to Kahoot. Please note that this guide explains how to use QuizMaster, not how to get it running. For this, we have created a seperate installation and troubleshooting guide. QuizMaster is written in Python and provides a powerful platform for creating and playing educational quizzes.

Table of Contents

• Home Screen
• Playing a Quiz
• Game Modes
• Creating a Quiz
• Preferences
• Arguments
• Conclusion

Home Screen

When you start QuizMaster, you will be greeted by the home screen. From here, you can choose to either play a quiz, create and edit quizzes and change the settings (strictly speaking, you can also use the About button, but it is fairly self-explanitory).

Click on Play a Quiz to start playing or Make a Quiz to create a new quiz.

Playing a Quiz

To play a quiz, follow these steps:

1. Click on Play a Quiz from the home screen.
2. Either:
• Type in the topic you want to play. Simply pressing enter will list every single quiz.
• Select a quiz from the list of available quizzes.
3. Or:
• Click on Random Quiz
4. Or:
• Click on General Knowledge Quiz, which takes random questions from random quizzes and merges them into one quiz.
• Choose the desired amount of questions using the slider.
5. Choose the game mode you want to play.
6. Answer the questions within the time limit (if applicable).
7. Your score (or time) will be displayed at the end of the quiz.

During the quiz, you will see a question and multiple answer options. Click on the correct answer to proceed to the next question, or type the number asociated with the answer.

If you selected the Speed Run mode, try to answer all questions correctly as quickly as possible. In Survival mode, be careful with your answers as you have a limited number of lives.

Game Modes

QuizMaster supports multiple game modes, each offering a unique experience:

• Classic: Answer questions with a countdown timer of between 10 and 20 seconds on average. Your score is recorded, and at the end, you will receive feedback based on your score.
• Classic V2: Similar to Classic, but with an absolute time limit instead of individual time limits for each question.
• Speed Run: Answer all questions correctly in the shortest time possible. Incorrect answers require redoing.
• Survival: Players have a limited number of lives. Each incorrect answer costs a life, and the game ends when all lives are lost.
• Practice: A relaxed environment to play the quiz with no time limit or score tracking. Users can opt to reveal the answer at any time.

Classic Mode

In Classic mode, you will answer a series of questions, each with a countdown timer. Follow these steps to play:

1. Choose the Classic game mode from the game mode selection screen.
2. Read each question carefully and select the correct answer before the timer runs out.
3. Your score will be calculated based on the number of correct answers and the time taken to answer each question.
4. At the end of the quiz, you will receive feedback based on your performance.

Features of Classic mode:

• Individual countdown timer for each question.
• Score calculation based on accuracy and speed.
• Feedback provided at the end of the quiz.

Classic V2 Mode

Classic V2 mode is similar to Classic mode but with an absolute time limit for the entire quiz. This game mode is normally considered the easiest. Follow these steps to play:

1. Choose the Classic V2 game mode from the game mode selection screen.
2. Answer questions as quickly as possible within the overall time limit.
3. Your score will be calculated based on the number of correct answers and the time taken to complete the quiz.
4. At the end of the quiz, you will receive feedback based on your performance.

Features of Classic V2 mode:

• Overall time limit for the entire quiz.
• Score calculation based on accuracy and speed.
• Feedback provided at the end of the quiz.

Speed Run Mode

In Speed Run mode, the goal is to answer all questions correctly as quickly as possible. Follow these steps to play:

1. Choose the Speed Run game mode from the game mode selection screen.
2. Answer questions as quickly as possible.
3. If you answer a question incorrectly, you will need to redo the question.
4. Your score will be calculated based on the time taken to answer all questions correctly.

Features of Speed Run mode:

• Focus on speed and accuracy.
• Redo incorrect answers until they are correct.
• Score calculation based on completion time.

Survival Mode

In Survival mode, you have a limited number of lives, and each incorrect answer costs a life. Follow these steps to play:

1. Choose the Survival game mode from the game mode selection screen.
2. Answer questions carefully to avoid losing lives.
3. The game ends when all lives are lost or when you complete the quiz.
4. Your score will be calculated based on the number of correct answers and remaining lives.

Features of Survival mode:

• Limited number of lives.
• Each incorrect answer costs a life.
• Score calculation based on accuracy and remaining lives.

Practice

The practice mode offers a relaxed environment for users to engage with quiz questions at their own pace. Immediate feedback is provided, notifying the player if the answer was correct. Participants can opt to reveal the correct answer or end the quiz at any time. Scores are not recorded. Follow these steps to play:

1. Choose the Practice game mode from the game mode selection screen.
2. Answer questions at any pace you want.
3. Reveal the answer with the Reveal Answer button.

Creating a Quiz

To create a new quiz, follow these steps:

1. Click on Make a Quiz from the home screen or start it manually via terminal.
2. Enter the quiz title
3. Add questions by clicking on the Add button.
4. For each question, enter the question text, correct answer, and a set of incorrect answers separated by commas.
5. Save the quiz once all questions have been added. Use the Save As function from Files in the top left if creating an entirely new quiz, otherwise Save (just above Save As) will suffice.

Use the interactive GUI to manage and create quiz questions. You can add, edit, delete and duplicate questions. Many of these will have tooltips, so should be self-explanitory.

Make sure to provide clear and correct questions and answers to ensure a good quiz experience.

We welcome pull requests for both code contributions and the creation of new quizzes.

Getting a new quiz integrated

We are currently working on an even more convenient way to integrate new quizzes that won't require contributors to learn version control systems like Git or the GitHub platform. However, we highly encourage using Git, as this not only makes contributions more organized but also gives credit to the contributor, ensuring that your effort is recognized within our community.

Preferences

In the preferences window, you can change the background music, volume, and background colour of the application:

Adjust the settings to personalize your QuizMaster experience:

• Music: Choose from a selection of background music tracks to play during your quiz sessions.
• Volume: Adjust the volume of the background music to your liking.
• Background Colour: Customize the background colour of the application to create a comfortable visual experience. It uses RGB so you need to determine how much of each colour to add to the screen. If the sliders are all the way to the left the screen will be black. Vice versa, white. Currently it does not update automatically, so do not worry if nothing happens. This is a bug that will soon be fixed.

Using Arguments

The quiz.py script accepts the following arguments when starting:

• -h, --help: Displays the help message and exits.
• -q [QUIZPATH], --quizPath [QUIZPATH]: Specifies the path to a quiz file. This allows you to load a specific quiz to play.
• -g [GAMEMODE], --gameMode [GAMEMODE]: Specifies the game mode. The available game modes are:
  • classic
  • classicV2
  • speedRun
  • survival
  • practice
• -v , --volume: Sets the volume level for the game. Enter a float value between 0 and 1.

Examples

Example 1: Load a Specific Quiz

To load a specific quiz, use the -q argument followed by the path to the quiz file:

./quiz.py -q path/to/quiz.json

Example 2: Set the Game Mode

To set the game mode, use the -g argument followed by the desired game mode:

./quiz.py -q path/to/quiz.json -g classic

Note that the quiz path must be specified along with the game mode.

Example 3: Set the Volume Level

To set the volume level, use the -v argument followed by a float value between 0 and 1:

./quiz.py -v 0.5

Example 4: Combine Arguments

You can combine multiple arguments when running the script. For example, loading a harry potter quiz with the classic game mode and set the volume to 0.8:

./quiz.py -q "Quizzes/books and movies/harrypotter.json" -g classic -v 0.8

The arguments may be combined in any other way, except that the quiz must be specified for the game mode argument to be given. This may be worked on in the future.

Conclusion

By using these arguments, you can customize your QuizMaster experience to suit your preferences.

Game Mode Options

• classic
• classicV2
• speedRun
• survival
• practice

Similarly in QuizCreator, a quiz parameter can be added to the end but for obvious reasons not a game mode parameter.

Conclusion

Explore these features to get the most out of your QuizMaster experience. Whether you're playing for fun or using it as an educational tool, QuizMaster offers a variety of options to suit your needs.