Makai: A C++20 3D (+"2D") application & game framework library

Table of contents

• Overview
• Supported Operating Systems
• Requirements
• • Windows
• How to Use
• • Note
• Libraries Used
• Documentation
• TODO

Overview

A C++20 3D application & game framework (with support for "Pseudo-2D"), built on top of SDL2 & OpenGL.

Supported operating systems

• 64-bit Windows

No plans to support 32-bit systems.

Requirements

Windows

Important

This library does not currently support clang/LLVM!

• GCC (13+) via MinGW (MSYS (Recommended), Cygwin, TDM-GCC)
• Make

Optional packages

• 7-zip: Only required for packing library releases.

Installing via MSYS2

If using MSYS, all of them must be installed via pacman:

For toolchain (GCC): pacman -S mingw-w64-x86_64-toolchain
For make: pacman -S make

(Optionals)
For 7-zip: mingw-w64-x86_64-7zip

In a single line: pacman -S mingw-w64-x86_64-toolchain make mingw-w64-x86_64-7zip

How to use

For the old system, se the legacy-system branch.

Building from scratch

1. Clone the repository (or just download it);
2. Enter the repository via command line (whichever has GCC);
3. Run make all;
4. Done! The result is located in the generated output/ folder.

Note

Libraries used

Inclusion of these on your project are not required, and strictly forbidden (except OpenGL, which is required). Since a version of (most of) them are bundled¹, including your own version of those will cause issues.

Name	Purpose	Bundled?
SDL2	Window & Input handling	Yes (Lib file2)
GL3W	OpenGL Wrangling	Yes ("Implementation" file3)
GLAD	OpenGL Wrangling	Yes ("Implementation" file3)
OpenGL	Graphics backend	No
SDL2_Mixer	Audio backend	Yes (Lib file2)
SDL2_Net	Networking Backend	Yes (Lib file2)
stb_image	Image loading	Yes (Implementation file4)
nlohmann::jsoncpp	Multiple things	Yes (Header-only5)
cppcodec	Data encoding & decoding	Only used internally, not required
CryptoPP	Encryption, decryption, compression & decompression	Yes (Lib file2)

Documentation

The API is documented. Should be able to be generated via doxygen (TODO: figure out that).

In the meantime, you can read the headers directly.

Bugs & issues

see Issues.

TODO

See TODO.

Footnotes

1. I.E. specified bundled libraries. Located in the lib folder. ↩

2. Either the contents of .a files, or the .o file associated with it. ↩ ↩² ↩³ ↩⁴

3. A copy of the source file is located in the src/new/impl/ folder, and is compiled when all other program parts are. ↩ ↩²

4. Implementation part of header-only libraries. Implementations are located under src/new/impl/. ↩

5. "Pure" header-only libraries. ↩