Getting Started

First, please ensure that one of the following is set up for your corresponding system:

brew install cmake

xcode-select --install

sudo apt install cmake build-essential libwayland-dev libxkbcommon-dev ninja-build \
                 wayland-protocols extra-cmake-modules xorg-dev libasound2-dev

sudo dnf install cmake gcc-c++ libX11-devel libXcursor-devel ninja-build \
                 libXrandr-devel libXinerama-devel libXi-devel mesa-libGL-devel \
                 mesa-libGLU-devel wayland-devel libxkbcommon-devel \
                 wayland-protocols-devel extra-cmake-modules

Get cerlib#

Download cerlib and extract it.

That’s all!

Some knowledge of (modern) C++ is recommended. CMake knowledge is not required.

The Game#

cerlib provides a Python script that generates a game template for you. After extracting cerlib, simply execute and follow the instructions:

python3 cerlib/CreateGame.py

The game template consists of:

• src: Contains the game’s source code
  • Main.cpp: Implements the game
• assets: Contains the game’s asset files, such as images and sounds
• CMakeLists.txt: Sets up the game project

Let’s have a look at Main.cpp:

#include <cerlib.hpp>
#include <cerlib/Main.hpp>

using namespace cer;

int main(int /*argc*/, char* /*argv*/[]) {
    auto game   = Game("MyGame");
    auto window = game.window();
    auto img    = Image("logo.png");

    while (game.tick()) {
        auto time = game.time();

        auto imgPos = (window.sizePx() - img.size()) / 2;
        imgPos.x += sin(float(time.totalTime) * 2) * 100;

        drawSprite(img, imgPos, white);
    }

    return 0;
}

The Game class represents the central game instance and is responsible for the entire game’s lifecycle. As soon as a game instance is created, you’re able to create and load objects such as images and fonts.

The game’s tick method has to be called continuously, and as long as it returns true, the game counts as running. Within the loop, you’re able to using the game’s time property to perform game logic updates.

Finally, you can draw the game’s visuals.

Running the game#

With Visual Studio#

The CreateGame.py script should’ve opened the Visual Studio solution automatically.

If not, simply open the folder in Visual Studio, since Visual Studio has built-in support for CMake projects:

The game is then ready for development as per the usual Visual Studio workflow.

With VSCode#

Like Visual Studio, the game should be ready for development once you open its folder in VSCode or VSCodium.

Use any IDE or editor that supports CMake, such as CLion or VSCode.

If you wish to use Xcode instead, generate a project for it as follows:

# Change to the game's directory
cd MyGame

# Generate an Xcode project for the game
cmake --preset xcode

# Open the project in Xcode
open build/xcode/MyGame.xcodeproj

Use any IDE or editor that supports CMake, such as CLion or VSCode.

Or cd into the game’s directory and run CMake to configure and build the game:

# Change to the game's directory
cd MyGame

# Configure and build the game for development
cmake --workflow --preset dev

# Start the game
(cd build/dev && exec ./MyGame)

You can now see the game running:

Congratulations! You got your game running.