Skip to content

README.md

Latest commit

 

History

History
71 lines (60 loc) · 1.63 KB

README.md

File metadata and controls

71 lines (60 loc) · 1.63 KB

Square Wars

Authors

JiffyRob's profile picture JiffyRob
Matiiss's profile picture Matiiss

Installation

The easiest way is to go to the itch.io page for this game, download the correct zip for your OS, extract it, and have fun!

itch.io page: jiffyrob.itch.io/square-wars


However, if you wish to build and run from source:

1. Create a virtual environment and activate it (optional, recommended)

python -m venv .venv
.venv/scripts/activate  # on Windows
source .venv/bin/activate  # on Unix systems

2. Install the SquareWars package from the GitHub repository

pip install git+https://github.com/Matiiss/SquareWars

For development use

git clone https://github.com/Matiiss/SquareWars
cd SquareWars
pip install -e .[dev]

3. Run the game

You can just type this in the terminal (while the environment you installed it in is active):

square-wars

Or run this from the root of the project:

python run.py