hibiscus/README.md

1.5 KiB

Hibis Game Engine

Hibis (short for Hibiscus (named after the genus of flowering plants)) is a work in progress game engine written in C++.
The goal of this game engine is to provide each module of the engine (renderer, audio, physics etc.) in seperate libraries so you can easily make your own system if need be.

Install

Pre-compiled libraries

lmao they don't exist yet chill

Compiling

Note: MSVC

MSVC (Microsoft Visual C++ Compiler) is unsupported and I cannot guarentee that Hibis will compile/run properly using it. Please use another compiler like G++ or Ninja instead.

Dependencies

To compile Hibis, you will need:

  • Meson
  • Meson-compatible compiler (recommended: Ninja or ccache + G++)
  • A few minutes of your time Each non-core library also has specific dependencies, including:
  • (RSDL) SDL2
  • (RSDL) SDL2_ttf Linux users should be able to get all of these (except time) from their package manager.
    Windows users will need to use vcpkg or similar to easily get these dependencies.

Actually Compiling

No Customising

Run compile.sh in the folder you cloned Hibis into.

Customising

In the folder you cloned Hibis into, run meson build to create a folder where the magic happens.
Move into the build directory using CD and you can now use meson configure to adjust compile options.
Once you have configured everything, run meson compile in the build directory and it should finish successfully.