README.md (1384B)
1 # Untitled Game 2 3 This is an in-development 2D platformer. 4 5 It currently supports these platforms: 6 7 - Windows 8 - Linux 9 - Chrome and Firefox ([playable here][3]) 10 11 Inspired by [Handmade Hero][4] and similar projects, I'm programming the game 12 largely from scratch. 13 14 15 ## Controls 16 17 - Move: Arrow keys 18 - Jump: S 19 20 21 ## Cloning 22 23 A git submodule is currently used to store the versioned game assets. 24 25 ``` 26 git clone --recurse-submodules https://git.amin.space/a-game/ 27 ``` 28 29 30 ## Compiling 31 32 ### Compile on Linux 33 34 - Install clang and glfw3 with your system's package manager. 35 - `make run` to compile and run the release build. 36 37 38 ### Compile on Windows 39 40 - Install and set up clang. The sanest set of instructions I've found is 41 [here][1]. 42 - Download the latest 64-bit Windows pre-compiled binary package from [here][2]. 43 - Unzip it and copy the `include` and `lib-vc2019` folders into 44 `lib/glfw_windows/`. The folder structure should look like this: 45 46 ``` 47 lib/glfw_windows/ 48 |-- include 49 | +-- GLFW 50 | |-- glfw3.h 51 | +-- glfw3native.h 52 +-- lib-vc2019 53 |-- glfw3.dll 54 |-- glfw3dll.lib 55 +-- glfw3.lib 56 ``` 57 58 - `.\build.bat && .\out\release\a-game.exe` to compile and run the release 59 build. 60 61 62 [1]: https://gist.github.com/InNoHurryToCode/955d63db0d79699fed63fe18eeebf17e 63 [2]: https://www.glfw.org/download.html 64 [3]: https://www.amin.space/bin/a_game/ 65 [4]: https://handmadehero.org/