miaisakovic/cycle-quest

Developed for UWaterloo's TechNova Hackathon '23 🥇

Cycle Quest

Cycle Quest is a game that provides teens with informative and engaging content on the menstrual cycle, making learning both fun and captivating! It won first place as the best overall project at TechNova.

For more information, visit: https://devpost.com/software/cycle-quest

Table of Contents

• Setup
  • For Linux
  • For MacOS
  • After Installing Initial Requirements
• How to Play

Setup

For Linux

If Python has not been previously installed, run the following:

$ sudo apt install python3.9
$ python3.9 --version

If pip has not been previously installed, run the following:

$ sudo apt-get install python3-pip 
$ pip3 --version

For MacOS

If Homebrew has not been previously installed, follow the instructions listed here.

If Python has not been previously installed, run the following:

$ brew install [email protected]
$ python3.9 --version

If pip has not been previously installed, run the following:

$ python3.9 -m ensurepip --upgrade
$ pip3 --version

After Installing Initial Requirements

Clone this repository:

$ git clone https://github.com/miaisakovic/cycle-quest.git

When asked to enter credentials, input your username and personal access token.

If the Pygame library has not been installed, run the following:

pip3 install pygame==2.4.0

How to Play

There are three developed mini games:

1. Phase 1: Bloody Mess
   • Use your left and right arrow keys to avoid symptoms (the yellow circles) and try to collide with the remedies (the white circles).
2. Phase 2: Hormone Party
   • Click on the corresponding myth or fact buttons for the statements on the cards. Your score is in the top right corner.
3. Phase 3: Eggscape
   • Use your space bar to avoid colliding with the incoming obstacles.

Phase 4 is under development!

Each time you would like to play Cycle Quest, run the following command:

$ python3.9 <relative path to main.py>