Beryl Engine

Free & Open Source Game Engine built for lovers of modern C#.

Warning

Beryl is a Pre-Release engine. It's API will have breaking changes.

About

Beryl is a cross-platform, MIT licensed, 3D-Focused game engine built around modern C#. It's designed to give fans of C# an engine that they'll enjoy using, no messy abstractions, no interop artifacts, and no licensing concerns.

Getting Started

Once you have a .csproj that depends on all Beryl libraries your game will use, you can start the engine through an entry-point that look a bit like this:

static void Main(string[] args)
{
    // Register all Modules our game wants to use
    ModuleManager.RegisterModule<InputModule>();
    ModuleManager.RegisterModule<AssemblyModule>();
    ModuleManager.RegisterModule<PhysicsModule>();
    ModuleManager.RegisterModule<SceneModule>();
    ModuleManager.RegisterModule<AudioModule>();
    ModuleManager.RegisterModule<GUIModule>();
    ModuleManager.RegisterModule<VirtualRealityModule>();
    ModuleManager.RegisterModule<RenderingModule>();

    Application.OnStart += () =>
    {
        // Setup a scene!
        FlyController flyController = new();
        flyController.Name = "Camera";

        DebugEntity floor = new();
        floor.Name = "Floor";
        floor.Transform.Scale = new Vector3(10, 1, 10);

        DebugEntity cube = new();
        cube.Transform.Position = new Vector3(0, 2, 0);

        ModuleManager.GetModule<SceneModule>()?.CurrentScene.StartAll();
    };

    Application.Initialize();
}

Features

Extreme Modularity

All engine subsystems have their lifecycle hooked into the Module system. Because of this, subsystems can be arbitrarily disabled, profiled, or singled out for debugging.

if (Input.PrimaryHandLeft.IsButtonPressed(VirtualRealityController.Button.ActionUp))
  if (ModuleManager.GetModule<PhysicsModule>()?.World.TryRaycast(Transform.Position, Transform.Forward, 1f, out RaycastResult result) == true)
    EngineConsole.Log(result.Body.Owner?.Name ?? "null");

Entity System

Logic is built around Entities and Components. Components are the reusable building blocks of the engine whilst Entities orchestrate their attached components to make more specific logic occur. For instance, a Button Entity would consist of MeshRenderer, RigidBody, and Collider components and contain logic that fires an output when an interaction ray hits the Collider.

Vulkan Renderer

Rendering is built on a Veldrid-based descriptor defined Vulkan-first engine with DirectX12 for compatibility. 'Descriptor Defined' means all CPU/GPU heterogeneous resources are built around a 'Descriptor' that defines their data and is then mapped to the GPU sided resource, allowing every resource to reuse buffers from eachother when possible.

Slang Shaders

import Beryl.Core;
import Beryl.Attributes;

#include "Beryl/Preprocessor.slang"

SHADER_ATTRIBUTES(
    [ShaderPass("Opaque")]
)

SHADER_PARAMETERS(
    [DefaultFloat3(0, 1, 1)]
    float3 Color;
)


[Shader("vertex")]
VertexOutput Vertex(VertexInput i)
{
    VertexOutput o;

    float4 world = mul(Object.ModelMatrix, float4(i.Position, 1));
    float4 view = mul(Camera.ViewMatrix, world);

    o.Position = mul(Camera.ProjectionMatrix, view);

    return o;
}

[Shader("fragment")]
float4 Fragment(VertexOutput i) : SV_Target
{
    return float4(Parameters.Color, 1);
}

Modern C#

Beryl has been written to be C# 14-first. Extensive use of properties, nullability, attributes, and abstraction means code can be more explicit and less based in guess work.