Home
QuizMaster Tutorial Installation Guide QuizMasterLite Tutorial QuizMasterMini Tutorial
GitHub

Installing and Troubleshooting for QuizMaster

Installing QuizMaster

To install the repository, there are two possible ways:

Clone The Repository

To clone the repository via terminal:

git clone https://github.com/hermonochy/QuizMaster

If you want example quizzes along with it, run:

git clone --recurse-submodules https://github.com/hermonochy/QuizMaster

Then enter the directory:

cd QuizMaster

Download Zip File

This alternative way of installing QuizMaster does not require Git, but accessing the example quizzes will be more challenging.

  1. Download the Zip file from the repository.
  2. Extract the Zip file.
  3. Enter the directory.

Setup

Using The Setup Script

Run the included script:

Note: There are known issues with msys2 python conflict for Windows users who are C++ developers.

Advanced Setup (Ubuntu/Debian only)

  1. Set up a new virtual environment: python3 -m venv venv
  2. Activate the environment: source venv/bin/activate (To deactivate, type deactivate)
  3. Install tkinter: sudo apt-get install python3-tk
  4. Install packages in requirements.txt: pip3 install -r requirements.txt

Steps 1 and 2 are optional but recommended to avoid Python module conflicts.

Running QuizMaster

In a command line window, run:

Press either Play a Quiz or Make a Quiz on the homepage.

Troubleshooting Guide

Common Issues and Solutions

Python Module Conflicts

If you encounter Python module conflicts, setting up a virtual environment as described in the advanced setup section is recommended.

Windows Setup Issues

On Windows, there might be issues with msys2 python conflict. Ensure you are not running conflicting versions of Python if you are a C++ developer.

Submodule Issues

If you cloned the repository without the --recurse-submodules flag, you might not have any example quizzes. To solve this, simply run the command git submodule update --init..

Getting Help

If you need further assistance, refer to our GitHub Organization for additional tutorials and community support.