Overview

This project is a sandbox for me to learn CMake, SDL and C/C++ better. Also, it will serve as a "minimal working example" of a game that can run as WASM or an executable (at least on a mac/linux/unix based OS, until I can actually understand how to use CMake right). I will then use this as a template so I can work on multiple similar projects without having to recreate this setup each time. It uses Adobe Open Source fonts as a submodule to improve portabililty so fonts can be loaded in with a relative path.

NOTE: Running this initial game on mobile does not run smoothly. There is a long delay between when the screen is pressed and when the "click" is able to be processed by the game. I am thinking it's probably best mainly aim to make games that work well on desktop b/c of this.

Dependencies:

• CMake
  • Docs: https://cmake.org/
  • Installation: https://github.com/Kitware/CMake?tab=readme-ov-file#unixmac-osxmingwmsyscygwin
• Emscripten
  • Docs: https://emscripten.org/
  • Source Code: https://github.com/emscripten-core/emsdk
  • Installation: https://emscripten.org/docs/getting_started/downloads.html
• SDL2
  • Docs: https://www.libsdl.org/
  • Source Code: https://github.com/libsdl-org/SDL/tree/SDL2
  • Installation: https://wiki.libsdl.org/SDL2/Installation
• adobe-fonts/source-code-pro
  • Docs: https://github.com/adobe-fonts/source-code-pro/tree/main
  • Source Code: https://github.com/adobe-fonts/source-code-pro

Helpful Resources

• https://wiki.libsdl.org/SDL2/Tutorials
• https://git-scm.com/book/en/v2/Git-Tools-Submodules

Initial Project Setup

# Clone repo and submodules:
git clone --recurse-submodules https://github.com/jude253/CGameSandbox.git

To intially setup up Emscripten:

cd include/emsdk

./emsdk install latest

./emsdk activate latest

Next, build the project for WASM one time using the instructions below.

Build Commands

Make a build (doesn't have to be named build/) directory, run cmake with relative path to project root from there, then run make. Somewhat like the unix style build, but with no configure step yet.

mkdir build

cd build

cmake ..

make

Alternatively, use this command instead of make:

cmake --build .

Build with Emscripten for WASM

Use the same commands as above, but replace cmake .. with this:

cmake -DUSE_EMSCRIPTEN=ON ..

NOTE: If you are running make for the first time since installing the emsdk, make sure the shell you run make in has not run source ./emsdk_env.sh as this makes the caching of emscripten port libraries fail. Run source ./emsdk_env.sh after running make the first time.

NOTE: If you switch back to normal building, use this command for the first time to disable the cached key:

cmake -DUSE_EMSCRIPTEN=OFF ..

Start Game WASM

Run once to enable emscripten commands in shell session:

source ./include/emsdk/emsdk_env.sh

From /build run:

emrun dist/game.html

Docs: https://emscripten.org/docs/compiling/Running-html-files-with-emrun.html#running-html-files-with-emrun

Start Game

./build/dist/game

One Line Command

Run from build directory

cmake .. && make && ./dist/game