A basic 2D game with no current ideas for story, setting, etc.
Before setting up the virtual environment, we first need to install virtualenv,
python -m pip install virtualenv
then you need to create a virtual environment. First navigate to the directory that you would like to create the virtual environment at. It is recommended not to create this in the thegame/ directory as this may cause some issues if running black .
python -m virtualenv venv
In order to activate the virtual environment that was created, run
venv\Scripts\activate.bat
Once this has been run, before your pwd, (venv) should appear before it.
To deactivate this virtual env, run
deactivate
In order to activate the virtual environment that was created, run
source venv/bin/activate
Once this has been run, before your pwd, (venv) should appear before it.
To deactivate this virtual env, run
deactivate
To install the requirements for this project, please run
pip install -r requirements.txt
pip install -r requirements-dev.txt
This project also uses pre-commit, this means after installing, you should run:
pre-commit install
This should cause the pre-commit hooks to run.
This project uses pytest as its unit test manager. In order to run the unit tests, please run
pytest
This should manage running all of the tests.
Because this project is designed with modules, it must be run as
python -m thegame
Running this from the root directory will cause it to run the game with a main menu.
For testing purposes, running the project as
python -m thegame -m
will run the game with an initial map.