kaliber/README.md

2.6 KiB

Kaliber

A simple, cross-platform 2D game engine with OpenGL and Vulkan renderers. Supports Linux and Android platforms. This is a personal hobby project. I've published a little game on Google Play based on this engine. Full game code and assets are included in this repository.

Pre-requisites:

GN build system is required for all platforms except Android (support for APKs, Java code etc. is to be added to the GN configuration).
Building GN from source: https://gn.googlesource.com/gn/
Pre-built GN binaries: https://chrome-infra-packages.appspot.com/p/gn/gn/

Linux is the supported host platform to build Android. Gradle, Android SDK and NDK are required. If you prefer, you can install Android Studio which includes all the requirements.

Building from the command-line:

All platforms except Android:

Setup:

gn gen out/release
gn gen --args='is_debug=true' out/debug

Building and running:

ninja -C out/debug
./out/debug/hello_world
./out/debug/demo

Android:

cd build/android
./gradlew :app:installDebug

Third-party libraries:

glew, jsoncpp, minimp3, oboe, stb, texture-compressor, minizip, glslang, spirv-reflect, vma, vulkan-sdk, volk

Hello World example:

Shows a smoothly rotating "Hello Wolrd!".

class HelloWorld final : public eng::Game {
 public:
  ~HelloWorld() final = default;

  bool Initialize() final {
    eng::Engine::Get().SetImageSource(
        "hello_world_image",
        std::bind(&eng::Engine::Print, &eng::Engine::Get(), "Hello World!",
                  base::Vector4f(1, 1, 1, 0)));

    hello_world_.Create("hello_world_image").SetVisible(true);
    animator_.Attach(&hello_world_);
    animator_.SetRotation(base::PI2f, 3,
                          std::bind(base::SmootherStep, std::placeholders::_1));
    animator_.Play(eng::Animator::kRotation, true);
    return true;
  }

 private:
  eng::ImageQuad hello_world_;
  eng::Animator animator_;
};

GAME_FACTORIES{GAME_CLASS(HelloWorld)};