BonEngineSharp 1.1.0

BonEngine Sharp

BonEngine is a code-based game engine designed to be simple and straightforward, with as little setup as possible. It covers 2d rendering, assets, sound effects, music, input, config files, and more.

BonEngineSharp is a C# bind of BonEngine. The APIs are nearly identical, so in this doc we'll only cover few examples and not the whole API. To view the full API you can check out the BonEngine repo.

Install

To install use nuget:

Install-Package BonEngineSharp

Or grab the latest build from releases and add reference manually.

Important - no Any CPU

SinceBonEngineSharp is a wrapper around a CPP library, your project needs to be built as either x86 or x64, but it can't be Any CPU. Same code can be used for both platforms, there's no difference in API or how you use the engine.

Platforms

BonEngineSharp is built for .net core 3.0, and it uses a CPP library compiled for Windows Desktop (x86 or x64) with VS2019 tools. If you want to build projects for different platforms, you need to build the CPP dlls yourself (from this repo).

Note that the CPP side is built with SDL and should be cross platform, but it wasn't officially tested or built for non-desktop targets.

How To Use

BonEngine is very easy to setup:

using BonEngineSharp;

/// <summary>
/// A basic example scene.
/// </summary>
class MyScene : Scene
{
    // called when scene loads
    protected override void Load()
    {
    }

    // called when scene unloads
    protected override void Unload()
    {
    }

    // called every frame to do updates
    protected override void Update(double deltaTime)
    {
    }
    
    // called every frame to draw scene
    protected override void Draw()
    {
    }

    // called every constant interval to update physics related stuff
    protected override void FixedUpdate(double deltaTime)
    {
    }
}

/// <summary>
/// Start the application.
/// </summary>
static void Main(string[] args)
{
    using (var scene = new MyScene()) {
        BonEngine.Start(scene);
    }
}

Once running, you can change your active scene:

Game.ChangeScene(newScene);

Managers

BonEngine is divided into 7 subsystems, called managers. These managers implement the vast majority of the engine's APIs, and they are:

Game

Application and global game stuff, like changing scene, exiting game, load config from file, retrieve delta time, ect.

Assets

Load and create assets - images, sound effects, music, config files, ect.

Gfx

Everything related to graphics and rendering.

Sfx

Everything related to sound effects and music.

Input

Implements user input, either by querying keyboard and mouse states or by checking "actions" which are bound to different keys.

Log

Provide basic logs.

Diagnostics

Get diagnostics and debug data, like FPS, number of draw calls, ect.

Continue Reading

To see more about BonEngineSharp, check out its git repo or online docs.