diff options
author | Gene Pasquet <dev@etenil.net> | 2025-05-18 09:53:38 +0100 |
---|---|---|
committer | Gene Pasquet <dev@etenil.net> | 2025-05-18 09:53:38 +0100 |
commit | dfaf786c1a7702f83de53d18fc5248117abfebc2 (patch) | |
tree | 27ec5f1123e0a6ab52517adf8fb3b84b4243a0dc /README.md | |
parent | e30b2a81b48f5e86474aa2c38d7034d63c0b7c4e (diff) |
Licensing etc.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 43 |
1 files changed, 41 insertions, 2 deletions
@@ -1,3 +1,42 @@ -LISP GAME JAM 2025 -================== +MACROKNIGHT +=========== +This is a game written for the [Spring Lisp Game Jam 2025](https://itch.io/jam/spring-lisp-game-jam-2025). + +## Dependencies + +This is a python game written with [Hy](https://hylang.org) and [Pygame](https://pygame.org). It requires the following to be installed: + +- Python (3.9+) +- SDL2 + +## Quickstart + +To install the python dependencies and run the game, simply type: + +``` +make +``` + +## Manual installation + +*Recommended* Create a virtual environment for the dependencies. On Debian-based distributions, you will need the package `python3-venv`. Run the following: + +``` +python3 -m venv venv +. venv/bin/activate +pip install -r requirements.txt +``` + +Then run the game with the venv active: + +``` +hy src/macroknight/game.hy +``` + + +## Credits + +- Code: Gene Pasquet +- Levels: Owen Pasquet +- Tile art: [Kenney](https://kenney.nl/assets/1-bit-pack) |