Blitz/README.md

Blitz 🎮

Fast FPS written in C++

Prerequisites 🛠️

You will need a recent compiler supporting c++17 and xmake (version 2.8.5 or higher). xmake should download all the dependencies for you.

Client 💻

Build ⚙️

xmake [BlitzClient]

Run 🏃

xmake run [BlitzClient]

Server 🗄

Build ⚙️

xmake build BlitzServer

Run 🏃

xmake run BlitzServer [-P port]

Debug 🏗️

Switch to debug mode

xmake f -m debug

Switch to release mode

xmake f -m release

Run with debugger

xmake run -d              # Client
xmake run -d BlitzServer  # Server

Testing 🧐

Run tests :

xmake test

Run tests with verbose :

xmake test -v

Generate docs 📖

First, clone the submodule for the enhanced css :

git submodule update --init

Then, refresh the doc :

xmake doxygen

Visual Studio Code integration 🎛

Generate compile_commands.json :

xmake project -k compile_commands

Alternatively, you can install the XMake extension for VsCode.

Valgrind 🔍

We can inspect the client binary to look for memory leak.

First, switch compilation mode to valgrind :

xmake f -m valgrind

Then build and run :

xmake
xmake run

Wiki 📚

Available here