https://github.com/kiyoMatsui/kiyosGameEngine

KiyoGameEngine is a small header only C++17 library, that provides boilerplate code for a small to medium sized games
https://github.com/kiyoMatsui/kiyosGameEngine

Last synced: 3 months ago
JSON representation

KiyoGameEngine is a small header only C++17 library, that provides boilerplate code for a small to medium sized games

• Host: GitHub
• URL: https://github.com/kiyoMatsui/kiyosGameEngine
• Owner: kiyoMatsui
• License: apache-2.0
• Created: 2019-01-28T20:02:12.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-04T02:14:47.000Z (7 months ago)
• Last Synced: 2024-05-02T16:37:46.576Z (6 months ago)
• Language: C++
• Homepage:
• Size: 261 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• AwesomeCppGameDev - kiyosGameEngine

README

        
# kiyosGameEngine

kiyoGameEngine (kge) is a small header only C++17 library, that provides boilerplate code for a small to medium sized games. Currently kge includes a main game loop with a state stack, a simple point class and an entity component system. Each header is independent and only requires the STL and C++17 compatible compiler. It is designed to be used with your favourite graphics/sound library. Current examples build on Windows, Linux and deploy to the web with Emscripten (WebAssembly).

## Install

Just include the kge header files in your project to use kge. Examples and tests build on Ubuntu 20.04 and Windows 10 using Visual Studio. The example requires SFML and CMake. The easiest way to build on windows is to use Conan so it can pull in SFML when using CMake. One way of doing this is to install Chocolatey on Windows and then use Powershell to install CMake and Python, then use Python to install Conan (Make sure Visual Studio installs MSVC).

For the web, install emscripten and then read and run the ./tools/emscriptenBuild.sh script. This builds all the assets for the index.html that will display a working example. Your hosting web server now needs the following headers set to play the sample (as of Dec 2021) but taking out multithreading may change things(let me know!).

Cross-Origin-Embedder-Policy: require-corp

Cross-Origin-Opener-Policy: same-origin

## To use 

Just look at the examples to get up and running with kge, the header files are small and simple and are independent of each other. The templates are digestible, so it shouldn't take too long to work out what's going on.