Build instructions

Windows

1. Install CMake
2. Install Visual Studio
   • Make sure to include CMake support as part of the installation
3. Install vcpkg
4. Using vcpkg, install project dependencies: vcpkg install sdl2:x64-windows sdl2-image:x64-windows sdl2-mixer:x64-windows sdl2-ttf:x64-windows
5. Download this repo, open it up in Visual Studio, and build it
6. Optional: install the compiled binaries: Build > Install ...
7. Optional: create a zip of the compiled binaries: cpack -G ZIP --config build-x64-Release/CPackConfig.cmake

Linux

(Tested on: Arch Linux, WSL w/ Ubuntu 22.04 LTS)

1. Install development dependencies: cmake, make, git
2. Install project dependencies
   • On Arch Linux, these are: sdl2, sdl2_image, sdl2_ttf, sdl2_mixer
   • On Ubuntu 22.04 LTS, these are: libsdl2-dev, libsdl2-image-dev, libsdl2-ttf-dev, libsdl2-mixer-dev
3. Download this repository and navigate to its location in a terminal
   • Be sure to git clone --recursive or git submodule update --init in order to use https://github.com/aminosbh/sdl2-cmake-modules
4. Generate build directory: cmake -B build
5. Compile and link: cmake --build build
6. Run game: build/MyGame

Web

(Tested on Linux)

1. Install development dependencies: cmake, make, git, python3
2. Install Emscripten
3. Download this repository and navigate to its location in a terminal
4. Generate build directory: emcmake cmake -B build/
5. Compile and link: emmake cmake --build build/
   • Note: there is a good chance this will fail with something like fatal error: 'SDL2/SDL.h' file not found because some of the required ports haven't been built and for some reason Emscripten doesn't automatically build them when invoked from CMake. Explicitly build the ports first: embuilder build sdl2 sdl2_image sdl2_mixer sdl2_ttf
6. cd build
7. Run a local server: python3 -m http.server
8. Visit the served page in your browser e.g. http://localhost:8000
9. Optional: install the compiled binaries: cmake --install build/
10. Optional: create a zip of the compiled binaries: cpack -G ZIP --config build/CPackConfig.cmake