Installation¶

Prerequisites¶

In order to use pygame-topdownengine, you will need the following installed:

Python 3.12.10+
pygame-ce 2.5.7+

pygame vs. pygame-ce

The pip install command will automatically install pygame-ce if you do not have it currently installed. If you already have the original pygame package installed, you MUST uninstall it before attempting to install pygame-ce or pygame-topdownengine.

Installing pygame-topdownengine¶

Resolved: Dependency Error

Prior to version 0.5.1, the pyproject.toml file was incorrectly configured to allow for pygame-ce versions below 2.5.2. However, version 2.5.2 of pygame-ce is required for typehints, and if a version below 2.5.2 is in the environment, the program will crash on import of pygame-topdownengine.

The pyproject.toml file has been fixed to only allow for pygame-ce versions above or equal to 2.5.2.

In order to install pygame-topdownengine, make sure Python and pip are both installed and in PATH. Then, run this command into your terminal:

pip install pygame-topdownengine

That's it! If everything worked properly, you should have pygame-topdownengine installed and ready to go!. If the command failed, try creating and activating a virtual machine and then running the installation command again. You can create a virtual machine using the following commands.

# Make a virtual environment called 'venv'
python -m venv venv

# Activate 'venv' on Linux or macOS
source venv/bin/activate

# Activate 'venv' on Windows Command Prompt
venv\Scripts\activate.bat

# Activate 'venv' on Windows Powershell
venv\Scripts\activate.ps1