Get the Project

Source Code

DuckQuest is fully open source and available on GitHub:

Installation

You can install DuckQuest in two ways:

Option 1 — Install via PyPI

If you only want to play the game without modifying the source and without using physical hardware, install it directly from PyPI:

This will install the game along with its platform-specific dependencies.

The PyPI version is intended for UI-only use. It does not support GPIO hardware as it lacks elevated permissions and conditional dependencies required on Raspberry Pi.

Option 2 — Manual Clone

If you want to use physical components (buttons and LEDs on Raspberry Pi), or if you plan to modify the codebase, clone the project manually.

1. Clone the repository:
   $ git clone https://github.com/LeoLeman555/Board_Game_DuckQuest.git

   $ cd Board_Game_DuckQuest
2. (Recommended) Create and activate a virtual environment:
   $ python -m venv venv

   $ source venv/bin/activate
3. Run the install script:
   $ python install.py

   The install.py script will: detect if you're on a Raspberry Pi, install Raspberry Pi-specific libraries such as RPi.GPIO and rpi_ws281x only when needed, and avoid installation errors on other platforms.

Run the Game

UI-Only Mode (No Hardware)

If you installed DuckQuest via PyPI, you can launch the game in UI-only mode with:

This mode uses simulated buttons and LEDs through a graphical interface. It works on Windows, macOS, and Linux, and does not require GPIO hardware.

The PyPI version does not support physical hardware due to limited permissions and dependency constraints.

Hardware Mode (Raspberry Pi with GPIO)

To play with the full physical setup, you'll need:

• Raspberry Pi 3B+
• Push buttons (for graph nodes)
• WS2812 RGB LED strip (for graph edges)
• External 5V power supply (for the LED strip)
• Breadboard and jumper wires

To run DuckQuest with real buttons and LED strips, you must:

1. Install the game via manual clone (see above)
2. Run it with elevated privileges:
   $ sudo -E $(which python) -m duckquest.main

   sudo is required to access GPIO and PWM devices on Raspberry Pi.

License

DuckQuest is released under the MIT license, giving you full freedom to use, modify, and share the project.