TerensTare / tnt

A 2d Game Engine written in C++20.

Home Page:https://terenstare.github.io/tnt

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

The TnT Engine

Discord Gitter Subreddit subscribers

Documentation Status

TnT is a 2d Game Engine written in C++. At the time of speaking the engine uses features from the C++17 standard (because at the time of speaking there is no C++ compiler that fully supports C++20 features), but one of the goals of the engine is to use C++20 features such as modules, concepts, etc.

Build status

Windows Linux Mac OS-X
Build Status Build Status Build Status
Windows

Project Goals

The project aims to make game development easy enough for anybody that doesn't know C++. Meanwhile the engine should be powerful enough for a C++ developer.

Features

  • Fast 2d rendering.
  • Efficient Entity management.
  • Fast and easy GUI library.
  • Lightweight logging.
  • Networking support.
  • Data serialization (save into/load from file).
  • Scripting support.

Code quality

Code checker Badge
CodeFactor CodeFactor
Codacy Codacy Badge
Code Inspector

Documentation

The documentation of the engine is written on the header files of the include directory. It is built by default by CMake. Note that for building the documentation, you need to have Doxygen installed (you can get it here). The documentation will be built on build/docs folder. If you don't want to build the documentation, please run cmake -DTNT_BUILD_DOCS=OFF .. instead of cmake .. . To read the documentation, open build/docs/html/index.html on your browser.

Getting started

For instructions on how to get the binaries of the engine or to build from source, please read INSTALL.md.

Building the tests and samples

WIP

Contributors

A special thanks goes to:

  • cgyurgyik (#8)

Bugs, Support, Q&A

For any question you may have, feel free to open an issue, or describe it on: