maksasj / bebone

☠️ game development framework/engine aimed for flexible and highly customizable game development

Bebone

Bebone - Is a framework/engine aimed for flexible and comfortable game development, written in C++. In other words Bebone is a set of useful game development libraries, written and integrated in Bebone framework ecosystem.

Bebone is not a new javascript framework btw. It is a game development one!

Cool looking widgets

Features

• Core module
  • Arena allocator & container
  • Logger
  • Types library
  • Event submodule
    • Listener system (Java style)
    • Action delegate (C# style)
  • Input system
  • Meta programming module
• Graphics module
  • OpenGL abstraction layer
  • Vulkan abstraction layer (in development)
  • Shaders
  • Window
  • Begui (Dear ImGui abstraction layer)

Build

For now there is two methods how you can use bebone is your project(build locally).

1. Build manually
   First of all requirements:

   • Cmake (At least version 3.21)
   • Ninja (At least version 1.11.1)
   • C++ compiler (Have test with Clang 15.0.5 and GCC 12.2.0)
   • Vulkan SDK (if you want to build gfx module)

   Firstly lets clone bebone locally(note that you also need to clone all bebone git submodules).

   Secondly lets configure our Cmake configuration with

   cmake -B build -G Ninja

   Finally you can simply build project with cmake

   cmake --build build

2. Using docker
   Currently the docker image is not available, but we are planning to release it towards bebone 0.2v.

Note that bebone is only a set of useful libraries/modules, some modules can be used separately.

Testing

The testing process is similar to the Building. After a successful build, all you have to do is run CTest from build\tests\unit directory.

Dependencies

For convenience, we try to reduce the use of third-party libraries, as it complicates code management and readability. At the moment, bebone is only dependent on these libraries:

• Glad (opengl function header)
• Vulkan-Headers (vulkan function header)
• GLFW (window management library)
• Glslang (SPIR-V shader compiler library)
• imgui (Debug gui library)
• omni_types (Type library)
• stb (Image management library and others)

Examples

Bebone hello world example:

#include "bebone/bebone.h"

using namespace bebone::gfx;
using namespace bebone::gfx::opengl;

int main() {
    GLFWContext::init();
    
    auto window = WindowFactory::create_window("Example", 800, 600, GfxAPI::OPENGL);

    GLContext::load_opengl();
    GLContext::set_viewport(0, 0, SCR_WIDTH, SCR_HEIGHT);

    while (!window->closing()) {
        GLContext::clear_color(0.2f, 0.2f, 0.2f, 1.0f);
        GLContext::clear(GL_COLOR_BUFFER_BIT);

        // Your game code

        GLFWContext::swap_buffers(*window);
        GLFWContext::poll_events();
        window->execute_input_actions();
    }

    GLFWContext::terminate();
    return 0;
}

You can find other examples in examples directory.

Documentation

• Core module
• GFX module

License

Bebone is free, open source game development framework. All code in this repository FOR NOW is licensed under

• MIT License (LICENSE.md or https://opensource.org/license/mit/)

bebone's Issues

Fix naming convention

Snake case: methods, functions, variables
Pascal case: Classes, Enums

IModel interface

IUniformBuffer interface

Vulkan Pipeline Manager and Textures

ISprite interface

IMesh interface

Typo in readme & rewrite readme

Get rid of singleton pattern usage

destroy() for Vulkan image tuples

Create basic sound system

• SoundEngine class
• Sound class
• Music class
• Abstract sound fx interface

SoundEngine engine;
            
class AAAA
class Sound : AAAA;
class Muisc : AAAA;
            
auto sound0 = engine.load_sound("hit0.mp3");
auto sound1 = engine.load_sound("hit1.mp3");
auto music = engine.load_music("music.mp3");
auto sound2 = engine.get("hit0.mp3");
            
sound0->play();
music1->play();
            
struct SoundComponent {
       shared_ptr<Sound> sound;
            
       SoundComponent(name) {
               sound = engine->load(name);
       }
            
       void invoke() {
               sound0->play();
       }
}

Resizing & closing window, invokes vulkan validation layer errors

Move includes in implementation files

Renderer

Todo

• Sprite interface
• Renderer interface
  • Complete OpenGL renderer implementation
  • Complete Vulkan renderer implementation
• And other interfaces...
  • Model, Mesh, Material, etc.

IProgram interface

Shader reflection

update_descriptor_set* functions move outside VulkanDescriptorPool class

ITexture interface

OpenGL Bexel example does not work

VulkanInstance move outside of VulkanDevice

Use std::tuple instead of struct Tuples in Vulkan module

Migrate omni_types into bebone

Add timers (Delta time)

Vulkan pipeline manager

Naming convention for Vulkan

Fix 2_vulkan_3d_cube example warning

[90/141] Building CXX object examples/gfx/vulkan/2_vulkan_3d_cube/CMakeFiles/Bebone_Example_Gfx_2_Vulkan_3D_Cube.dir/main.cpp.obj
D:/Projects/C++/bebone/examples/gfx/vulkan/2_vulkan_3d_cube/main.cpp:103:72: warning: unsequenced modification and access to 't' [-Wunsequenced]
103 | transform.rotation = trait_bryan_angle_yxz(Vec3f(t * 0.001f, (t++) * 0.001f, 0.0f));
|

Can be easily fixed

IIndexBuffer interface

Tests for image and image painter

Move Vulkan constructors to private, and make them visible only for VulkanDevice

Fix flappy bird crash (input system problem)

Game is crashing after clicking the LMB

The reason of crash is somewhere here

Updates:

• Crashes with Clang
• Works perfectly with MinGW

Create abstract model loader

Lets for now create just abstract class, and obj one.

Move get_view_matrix function to core/types/matrix

VulkanImage save image extent to member variables and refactor copy_buffer_to_image

Inherit VulkanPipelineManager from VulkanApi class

Create create_image_memory function to VulkanDevice class

Create utility functions for input system

• 'GetKeyDown'
• 'GetKeyUp'
  etc...

Tests for event systems

VulkanDevice manages all child vulkan objects

Plan render graph API

Before render graph we need

• Vulkan/OpenGL
  • Render passes
  • Framebuffers

Refactor Core module

move files to appropriate directories

Add destroyed flag to VulkanApi class

Rename Docs markdown files

rename

Gfx.md to GFX.md
Core.md to CORE.md

Since, README.md LICENSE.md and TODO.md, are all upper case, lets be consistant with outher markdown files as well.

Refactor and naming convention for Vulkan part

IVertexBuffer interface

Sound system

Todo

• SoundEngine class
• Abstract sound fx interface
• Sound class
• Music class

IMaterial interface

Add Vec2i variants for ImagePainter methods

Vulkan headers

I noticed that, we are using GLFW with GLFW_INCLUDE_VULKAN, do wee really need Vulkan-Headers submodule ?

Vulkan textures

Tests for memory Core submodule

GFX

Todo

• Vulkan part
  • Vulkan pipeline manager
  • Vulkan textures
• Refactor window api
  • Default values