Tutorial: Getting Started

antara-gaming-sdk

Antara Gaming Software Development Kit

Prerequisites

Below is the list of prerequisites to use the antara-gaming-sdk on your machine:

  • CMake 3.14 minimum

  • clang-8 minimum (Windows/Linux/Osx)

  • Optional emscripten latest (Web)

  • Optional Visual Studio 2019

  • Optional Clang VS Toolset (installable through visual studio installer)

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

See deployment for notes on how to deploy the project on a live system.

Build

To build the project please follow the instructions below:

mkdir build ## bash or powershell
cd build ## bash or powershell

## Release or Debug are available
cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_CXX_COMPILER=your_path_to_your_clang++ ../ #Linux / Osx
cmake -DCMAKE_BUILD_TYPE=Debug -G "Visual Studio 16 2019" -A x64 -T "ClangCl" -DCMAKE_CXX_COMPILER="C:/Program Files/LLVM/bin/clang-cl.exe" ../ #Windows

## Build (Debug / Release available)
cmake --build . --config Debug

Installing

You do not need to install the gaming sdk, just use the CMake fetch_content command to use the project

Running the tests

Once you have compiled the sdk gaming with the option to enable unit tests.

They are located in the bin/unit_tests (Linux/Osx) or bin/unit_tests/%CMAKE_BUILD_TYPE% (Windows) folder

Deployment

construction

Built With

  • doctest - The fastest feature-rich C++11/14/17/20 single-header testing framework for unit tests and TDD http://bit.ly/doctest-docs

  • doom-st - C++ implementation of strong types

  • EnTT - Gaming meets modern C++ - a fast and reliable entity-component system (ECS).

  • refl-cpp A compile-time reflection library for modern C++ 🔥

  • range-v3 Range library for C++14/17/20, basis for C++20’s std::ranges

  • expected C++11/14/17 std::expected with functional-style extensions https://tl.tartanllama.xyz

  • (optional)SFML Simple and Fast Multimedia Library http://www.sfml-dev.org/

Code of Conduct

Before any contribution please read our CODE OF CONDUCT.

Contributing

Please read CONTRIBUTING.md, contain the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Roman Sztergbaum - Co-Creator & Lead Dev - Milerius

  • Tolga Ay - Co-Creator - naezith

See also the list of contributors who participated in this project.

Acknowledgments

  • Viktor Kirilov onqtam for the awesome doctest framework.

  • Michele Caini skypjack for the awesome EnTT framework and his help.

Badges

Apps

Badges

Github Actions CI (Windows/Osx/Linux)

 Build Status

License

Creative Commons License
This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

LGTM (Security C++) Alerts

 Total alerts

LGTM (Security C++) Quality

 Language grade: C/C++

Issues

 GitHub issues

Report CI (Linux/Osx/Windows/Emscripten)

 badge

Coverage (Codecov)

 codecov

Docs

 Documentation Status

HitCount

 HitCount

Line Of Code

Conventional Commit

 Conventional Commits