eggdrop

eggdrop is an implementation of the CS 11 24.1 MP1 Extension and CS 11 24.1 MP1 Nov05 specifications, otherwise known as Egg Roll II: Electric Boogaloo.

This documentation is autogenerated using Sphinx and reST.

Project setup

The easiest way to install the project dependencies is to use uv. Once installed, simply run:

uv sync

This will automatically create a virtual environment at .venv and install the project dependencies.

To activate the virtual environment, run uv venv. The last line of the command output should tell you how to activate the virtual environment, for example:

Using CPython 3.13.1 interpreter at: /usr/sbin/python3
Creating virtual environment at: .venv
Activate with: source .venv/bin/activate

If you prefer to use pip, run the following command (preferably in a virtual environment):

pip install -r requirements.txt

This file was generated using Python 3.12 on Arch Linux. If there are any issues, please refer to the pyproject.toml file, or switch to uv.

• How to use
  • Prerequisites
  • Running the game
• Game mechanics
• Running the test suite
  • Pytest
  • Pyright
• Generating the docs
  • Hot-reload server
• How does it work?
  • Game logic
  • Move processing
• Autodocs
  • Constants
  • Console rendering
  • Game logic
  • Leaderboard handling
  • main.py