diff --git a/README.md b/README.md index 785b195..878fe59 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,27 @@ Along the way you can damage your opponent's tower, put up shields and repair yo Be smart about which blocks you play when! It might be the difference between a win and a loss! +## Playing + +The game may be played from source or by using a pre-built Windows executable. + +The easiest way to play from source is to use the [Mu editor](https://codewith.mu/). Check out the Stacky Tower code +from this repo (or extract a zip file) to your preferred location and open `stackytower.py` in Mu. Choose PyGame Zero +from the Mode selection button and then click Play. + +If you are running on a Windows platform you may opt to use a pre-built executable (`stackytower.exe`). + +### Game Play + +The game opens to a menu. Follow the basic instructions for play within the game. + +### Custom Keyboard Layouts + +If you use a non-QWERTY keyboard layout you'll need to play from source. You can edit the key mapping at the top of +`stackytower.py` to suit your preferences. + ## Credits + This game was designed and coded by Christian Wyglendowski and Eli Wyglendowski. Most graphics were created by Eli. @@ -22,5 +42,8 @@ It uses the [PyGame Zero](https://pygame-zero.readthedocs.io/en/stable/) game fr The app was largely coded using the [Mu editor](https://codewith.mu/) and runs on [Python 3](https://www.python.org). +The EXE version was built with [Pyinstaller](https://www.pyinstaller.org/) and uses a modified PyGame Zero +[launcher recipe](https://gist.github.com/AnthonyBriggs/cac72989c2dd3c4aeb7475237079d2fb) by AnthonyBriggs. + ## License The code is released under the MIT license. \ No newline at end of file