Eklipse Engine

Eklipse is a game engine which tries to provide proof-of-concept solutions to the most important problems of a complex game engine (which this engine is not).

How it works ⚙

Editor - allows you to import assets, view the scene, scene hierarchy and export the project to a precompiled executable. Editor supports managing multiple projects.

eklipse_editor.mp4

Engine - uses OpenGL or Vulkan (can switch between them at runtime). Supports simple rasterization pipeline and custom Ray Tracing algorithm that uses BVH to optimize triangle intersection checks.

Script API - scriting system is a simple custom logic injection system. All scripts are written in C++. Scripts are part of a separate project that is automatically created with an editor project. Creating a new script is as simple as writing a new class that derives from the base Script class. Scripts are compiled into a shared library that is then being linked to a given executable (Editor or Runtime).

#pragma once
#include <EklipseEngine.h>

class CameraController : public EklipseEngine::Script
{
public:
    void OnCreate();
    void OnUpdate(float deltaTime);

    EK_FLOAT speed = 5.0f;
    EK_FLOAT rotationSpeed = 5.0f;
};

#include "CameraController.h"
using namespace EklipseEngine;

void CameraController::OnCreate()
{
    SetCursorMode(CursorMode::Disabled);
}

void CameraController::OnUpdate(float deltaTime)
{
    // movement
    auto& transform = GetComponent<Transform>();
    if (Input::IsKeyDown(KeyCode::W))
    {
        transform.Translate(transform.GetForward() * speed * deltaTime);
    }
    if (Input::IsKeyDown(KeyCode::S))
    {
        transform.Translate(transform.GetForward() * -speed * deltaTime);
    }
    if (Input::IsKeyDown(KeyCode::A))
    {
        transform.Translate(transform.GetRight() * -speed * deltaTime);
    }
    if (Input::IsKeyDown(KeyCode::D))
    {
        transform.Translate(transform.GetRight() * speed * deltaTime);
    }
    if (Input::IsKeyDown(KeyCode::Space))
    {
        transform.Translate(transform.GetUp() * speed * deltaTime);
    }
    if (Input::IsKeyDown(KeyCode::LeftShift))
    {
        transform.Translate(transform.GetUp() * -speed * deltaTime);
    }

    // rotation
    glm::vec2 mouseDelta = Input::GetMouseDelta();
    auto mouseDeltaX = mouseDelta.x;
    auto mouseDeltaY = mouseDelta.y;

    if (mouseDeltaX != 0 || mouseDeltaY != 0)
    {
        transform.Rotate(glm::vec3{ 0, -mouseDeltaX * rotationSpeed * deltaTime, 0 });
        transform.Rotate(glm::vec3{ -mouseDeltaY * rotationSpeed * deltaTime, 0, 0 });
    }
}

Runtime - editor can build every project as a standalone app. Runtime is the precompiled executable that links to engine library, scripts API library and project library containing all scripts. It copies all the assets from editor project and loads them as raw files (no binary archive).

Disclaimer ⚠

This project has been written in Visual Studio 2022 on Windows and this is the only target setup that is supported for now.

How to build 🛠

1. Clone the repo with all of it's submodules

git clone --recursive https://github.com/tomtar00/Eklipse.git

2. Go to Eklipse directory

cd Eklipse

3. Go to Eklipse\vendor\_projects\spirv_tools and uncomment the prebuildcommands section of the spirv_tools.lua file.

prebuildcommands
{
    get_gen_core_tables_cmd("unified1"),
    get_gen_enum_string_mapping_cmd("unified1"),
    get_gen_opencl_tables_cmd("unified1"),
    get_gen_glsl_tables_cmd("unified1"),

    get_gen_vendor_table_cmd("debuginfo", ""),
    get_gen_vendor_table_cmd("opencl.debuginfo.100", "CLDEBUG100_"),
    get_gen_vendor_table_cmd("nonsemantic.shader.debuginfo.100", "SHDEBUG100_"),
    get_gen_vendor_table_cmd("spv-amd-gcn-shader", ""),
    get_gen_vendor_table_cmd("spv-amd-shader-ballot", ""),
    get_gen_vendor_table_cmd("spv-amd-shader-explicit-vertex-parameter", ""),
    get_gen_vendor_table_cmd("spv-amd-shader-trinary-minmax", ""),
    get_gen_vendor_table_cmd("nonsemantic.clspvreflection", ""),

    get_gen_registry_file_cmd(),
    get_gen_build_version_cmd()
}

This guarantees that the additional source files are genereted for SPIRV. After the first build of SPIRV comment out this section again to prevent the compiler from recompiling the SPIRV library on every build.

4. Go to Eklipse\vendor\_projects\glslang and uncomment the prebuildcommands section of the glslang.lua file.

prebuildcommands
{
    "cd " .. glslang .. "&& python3 build_info.py ./ -i build_info.h.tmpl -o glslang/build_info.h",
    "cd " .. glslang .. "&& python3 gen_extension_headers.py -i ./glslang/ExtensionHeaders -o ./glslang/glsl_intrinsic_header.h"
}

Again, after the first build of glslang comment out this section to prevent the compiler from recompiling the glslang library on every build.

5. Create project files using premake5

premake5 vs2022

6. Open the project with Visual Studio 2022 and press F5 to compile the editor. The prebuildcommands from premake scripts will try to run python3 scripts on your machine. For that to work, make sure that you have installed python.

Dependencies

• GLFW
• GLM
• Dear ImGui
• entt
• spdlog
• GLAD
• VulkanSDK
• Vulkan Memory Allocator
• yaml-cpp
• nativefiledialog
• ImGuizmo
• glslang
• SPIRV-Tools
• SPIRV-Headers
• shaderc
• filewatch
• dylib
• stb_image
• tinyobjloader

---

Huge thanks to @TheCherno for creating his Game Engine Series on YouTube, which this project is based upon.