README.md

Robaki

Real-time Worms clone.

Getting started

Documentation

Documentation can be generated using Doxygen. The repository also comes with doxygen-awesome-css.

Refer to Doxyfile for configuration.

Prerequisites

The following libraries are pulled into the repository using submodules.

• bgfx,
• bimg,
• bx,
• {fmt},
• glfw3,
• glad,
• spdlog

A tool called py-cppbuild is present for building the above libraries (excluding glad) from source. There's also small batch and shell scripts present for generating dependencies. It's used internally in meson, so don't worry about it too much.

After building, the libraries will be laid out in the following way:

/deps/
├─<name of library>
│  ├─include/
│  │  ├─<headers>
│  ├─bin/
│  │  ├─<binaries>

Please refer to the meson.build configuration file for more information.

Building

This project makes use of the meson build system and a Makefile is supplied which invokes meson and its targets

Invoke the build target from command line.

$ make build

Other targets are also defined by the Makefile. Refer to it for more information.

License

This project is under the BSD 3-clause License. See LICENSE for details.