edunad / rawrbox

PSX..ish game engine made with DiligentCore

RawrBox - PSX..ish game engine

         

Features - Libs - Building - Samples

Why PSXish?

This engine started as a C++ training project, with hopes of being applied in upcoming games. Don't expect it to rival big players like Unity, Unreal or Godot; it's not geared towards advanced rendering techniques such as anti-aliasing or ray-tracing. Rather, it's tailored for crafting straightforward, PlayStation 1-style games. Surprisingly, it runs on Vulkan/DirectX12, keeping it somewhat modern despite its retro inspiration.

FEATURES

Module	Features
Engine	- Tick based system - Limit FPS and TPS
Animation	- Skeleton data support - Blendshapes support - Multiple armature animation support - Vertex animation
Data	- File formats:     - Meshes (using assimp):         - glTF/GLB          - OBJ          - FBX          - DAE          - 3DS          - MD5mesh     - Images:         - PNG, JPEG, BMP, TGA, GIF (using stb)         - SVG (using lunasvg)         - WEBP (using libwebp)         - WEBM (video only) (using libwebp)     - Fonts:         - TTF (using stb)     - Audio (using BASS):         - OGG         - MP4         - MP3         - WAV         - Supports url audio     - JSON (using glaze)
Math	- Vectors, colors, matrices & quaternions support - Bezier curve & easing - Packing support (float16, etc)
Physics	- 3D multi-threaded physics (using JoltPhysics) - 2D physics support (using Muli)
Rendering	- Vulkan & DirectX 12 support using (Diligent) - Material system similar to unity - Window & Input callbacks (using GLFW) - Clustered rendering :         - Decals (WIP)         - Lights (point / spot/ directional) - Linux (steamdeck) support - Bindless rendering - Post-processing support - 2D rendering - Custom rendering plugins - GPU Picking - GPU Particle system
Network	- HTTP / HTTPS requests (using libcpr) - Packet network implementation - NetVar & NetArray support for snapshot implementation - Simple socket implementation
Scripting	- Scripting / modding support with LUAU (using luabridge3 + luau)
Other	- I18N (internationalization) support - Settings support - Steamworks support - Custom UI - DEV Console with support for custom commands & scripts - Timer utils (based on GMOD's timers) - File watcher implementation - Threading utilities

SAMPLES

001-stencil	002-generated-models	003-light
004-instancing	005-post-process	006-decals
007-particle-system	008-ui	009-assimp
010-bass-audio	011-physics-3D	012-physics-2D
013-webm	014-scripting	015-gpu-picking
016-steamworks

BUILDING

WINDOWS

REQUIRED SOFTWARE

• GIT or something similar to GIT
• CMAKE at least > 3.16.3
• Download and install C++ Build Tools (2022 is recommended)
  
  • 
• Download and install a IDE, Visual Code is recommended.
• Download and setup ninja (make sure it's in the enviroment path)
  
  • pip install ninja if you have python3 installed

IDE SETUP (Visual Code)

1. Open the workspace file (.code-workspace) and install the recommended extensions (at least C++ & CMAKE)
2. Run cmake configure
3. Select [Visual Studio Build Tools <version> Release - amd64] on the kit popup (for all of the projects)
4. Run the compiler by hitting F5

LINUX

REQUIRED SOFTWARE

• PODMAN or DOCKER

SETUP

1. Build the container : podman build -t rawrbox .
2. Run the container : podman run -ti rawrbox /bin/bash
3. Run cmake_rawrbox (ALIAS) to prepare the cmake rawrbox
4. Run build_rawrbox (ALIAS) to build rawrbox

LIBS

LIB	DESCRIPTION	USAGE	DEPENDENCIES
RAWRBOX.RENDER	Rendering lib (aka, contains window, stencil, etc)	Contains window, stencil, model / texture loading. Basically anything related to rendering	ENGINE & MATH
RAWRBOX.MATH	Math lib	Contains vector, color and other math related classes
RAWRBOX.BASS	Bass lib (aka sound loading)	Loads sounds using the BASS lib, supports 3D & http sound streaming	ENGINE & MATH
RAWRBOX.UTILS	Utils lib	Utils for game development
RAWRBOX.ENGINE	Engine lib (aka game loop)	The engine it self, contains the game loop mechanism	UTILS
RAWRBOX.UI	UI lib	UI components lib	RENDER & RESOURCES
RAWRBOX.RESOURCES	Resources manager lib	Resource manager. Handles loading and stores the pointers for easy access	UTILS
RAWRBOX.PHYSICS.3D	3D Physics lib	Handles 3D physics	ENGINE & MATH
RAWRBOX.PHYSICS.2D	2D Physics lib	Handles 2D physics	ENGINE & MATH
RAWRBOX.ASSIMP	Assimp lib	Handles assimp model loading	RENDER & RESOURCES
RAWRBOX.WEBM	WEBM lib	Handles webm loading	RENDER & RESOURCES
RAWRBOX.SCRIPTING	Scripting lib	Handles lua & mod loading	ENGINE & MATH
RAWRBOX.NETWORK	Networking lib	Handles networking
RAWRBOX.STEAMWORKS	Steamworks lib	Handles steamworks	UTILS

CMAKE OPTIONS

OPTION NAME	NOTE
RAWRBOX_BUILD_TESTING	Builds & enables project tests
RAWRBOX_BUILD_SAMPLES	Builds the project sample
--	--
RAWRBOX_CONTENT_FOLDER	The content folder to output assets. Default is assets
--	--
RAWRBOX_USE_WAYLAND	Enables WAYLAND compiling on LINUX
--	--
RAWRBOX_BUILD_RAWRBOX_UI	Builds and includes ui
RAWRBOX_BUILD_RAWRBOX_RESOURCES	Builds and resouces manager (aka handling and storing loaded resources)
RAWRBOX_BUILD_RAWRBOX_3D_PHYSICS	Builds the 3D physics engine
RAWRBOX_BUILD_RAWRBOX_2D_PHYSICS	Builds the 2D physics engine
RAWRBOX_BUILD_RAWRBOX_BASS	Enables BASS support. ⚠️ BASS IS ONLY FREE FOR OPEN SOURCE PROJECTS ⚠️
RAWRBOX_BUILD_RAWRBOX_ASSIMP	Enables assimp model loading
RAWRBOX_BUILD_RAWRBOX_WEBM	Enables WEBM loading
RAWRBOX_BUILD_RAWRBOX_NETWORK	Builds network support
--	--
RAWRBOX_BUILD_RAWRBOX_SCRIPTING	Enables lua & modding support
RAWRBOX_BUILD_RAWRBOX_SCRIPTING_UNSAFE	Enables io support on lua (loading and saving files on the data folder)
RAWRBOX_BUILD_RAWRBOX_SCRIPTING_EXCEPTION	Enables scripting throwing exceptions instead of catching them
--	--
RAWRBOX_BUILD_RAWRBOX_STEAMWORKS	Enables steamworks support
STEAMWORKS_APPID	Sets the steamworks appid
--	--
RAWRBOX_BUILD_QHULL	Builds QHull util
--	--
RAWRBOX_BUILD_MSVC_MULTITHREADED_RUNTIME	Builds libraries with MSVC Multithreaded runtime (Auto-enabled if jolt is used)
--	--
RAWRBOX_DISABLE_SUPPORT_DX12	Disable dx12 support
RAWRBOX_DISABLE_SUPPORT_VULKAN	Disable vulkan support
--	--
RAWRBOX_DEV_MODE	Enables all the modules, used for rawrbox development
--	--
RAWRBOX_TRACE_EXCEPTIONS	Enables exception tracing

INTERNAL DEPENDENCIES

EXTERNAL DEPENDENCIES

LIB	NOTE
DiligentCore	Used for vulkan / directx rendering
glfw	Used for window management
--	--
glaze	Used for JSON loading
fmt	Used for text formatting
utfcpp	Used for utf support
--	--
stb_image.h	Used for loading images (png,gif,jpeg)
stb_image_write.h	Used for writting images
stb_freetype.h	Used for loading fonts
stb_easy_font.h	Used for drawing debug text
--	--
thread-pool	Used for managing async threading
qhull	Used for calculating convex hulls from given points
assimp	Used for loading models
catch2	Used for testing
bass	Used for loading sounds
JoltPhysics	Used for managing 3D physics
muli	Used for managing 2D physics
--	--
webmlib & vpx	Used for loading webm
libwebp	Used for WEBP loading
--	--
luabridge + luau	Used for loading & managing lua scripting
curl + libcpr	Used for HTTP / HTTPS requests
lunasvg	Used for SVG loading
cpptrace	Used for easy error tracing

rawrbox's Issues

[TODO] Add missing lua wrappers to packages

• RENDERER
• UI
• PHYSICS 2D
• PHYSICS 3D
• RESOURCES
• BASS
• NETWORKING
• CONSOLE
• WEBM
• STEAMWORKS

[BUG] Vulkan is throwing validation errors on render target

RawrBox lib

• rawrbox.assimp
• rawrbox.bass
• rawrbox.engine
• rawrbox.math
• rawrbox.network
• rawrbox.physics_2d
• rawrbox.physics_3d
• rawrbox.render
• rawrbox.resources
• rawrbox.scripting
• rawrbox.ui
• rawrbox.utils
• rawrbox.webm

---

• UNKNOWN

Description

Diligent Engine: ERROR: Vulkan debug message (validation): VUID-VkImageMemoryBarrier-oldLayout-01211
                 Validation Error: [ VUID-VkImageMemoryBarrier-oldLayout-01211 ] Object 0: handle = 0x852b56000000006a, name = RawrBox::RenderTarget, type = VK_OBJECT_TYPE_IMAGE; | MessageID = 0x3e9335e3 | vkCmdPipelineBarrier(): pImageMemoryBarriers[1].oldLayout (VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) is not compatible with VkImage 0x852b56000000006a[RawrBox::RenderTarget] usage flags VK_IMAGE_USAGE_TRANSFER_SRC_BIT|VK_IMAGE_USAGE_TRANSFER_DST_BIT|VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT. The Vulkan spec states: If srcQueueFamilyIndex and dstQueueFamilyIndex define a queue family ownership transfer or oldLayout and newLayout define an image layout transition, and oldLayout or newLayout is VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL then image must have been created with VK_IMAGE_USAGE_SAMPLED_BIT or VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT (https://vulkan.lunarg.com/doc/view/1.3.275.0/windows/1.3-extensions/vkspec.html#VUID-VkImageMemoryBarrier-oldLayout-01211)
                 Object[0] (image): Handle 0x852b56000000006a, Name: 'RawrBox::RenderTarget'

[FEATURE] Shadows

Implement simple shadow map, nothing too fancy
https://github.com/DiligentGraphics/DiligentSamples/tree/master/Tutorials/Tutorial13_ShadowMap

[BUG] Vulkan / AMD

RawrBox lib

• rawrbox.render

Description

Vulkan on AMD does not support NonUniformResourceIndex well and so it creates small artifacts on those vertexes

[TODO] Add settings util

[BUG] Fix LuaJIT leaking & crashing

When

#include <sol/sol2.hpp>

on the light/base.hpp file is added, the shaders get corrupted.

[TODO] Implement .wad system

For storing files and easier CRC checking. Based on valve's format
https://developer.valvesoftware.com/wiki/WAD

[FEATURE] Particle engine

Feature Request

Description

Add particle engine using compute shaders

[TODO] Add i18n support

[TODO] Update assimp to new version

TODO

Description

Update assimp to the new version, seems to be stable again (?)
https://github.com/assimp/assimp/releases/tag/v5.4.1

Alternative ... drop assimp and add GLTF / OBJ support for a smaller lib

[FEATURE] Add bgfx encoder

Feature Request

Description

Add bgfx::Encoder for faster multi-threading? Not sure if this is required

• https://bkaradzic.github.io/bgfx/bgfx.html#id1
• https://github.com/apnkv/nncc/blob/5cea81703f2b3b451541796bd989ceafd0a6decf/src/nncc/gui/imgui_bgfx.cpp#L214C52-L214C52

[TODO] Add console commands & ui support

[FEATURE] Add SVG support

Feature Request

Description

• Add .svg loading support

https://github.com/sammycage/lunasvg

[TODO] Add cubemap skybox support

[TODO] Implement .bsp support

https://github.com/Bromvlieg/TomatoLib/blob/master/TomatoLib/TomatoLib/MapFormats/Bsp.h
https://github.com/Bromvlieg/TomatoLib/blob/master/TomatoLib/TomatoLib/MapFormats/Bsp.cpp

[TODO] Add decal system

https://github.com/diharaw/deferred-decals

[TODO] Add blend animation support

[BUG] Timer crashes when it expires in lua

Description

C++ crashes when timer expires

Reproduction Steps

1. Create a timer with timer:create
2. As soon as timer expires, c++ crashes

[TODO] Add lua library & wiki for scripting

Similar to what i did to ias

https://iaswiki.rawr.dev/docs/

[FEATURE] Blendshapes support

Description

Add blend shape support to assimp lib

[TODO] Add 2D physics module

https://github.com/Sopiro/Muli

[TODO] Deferred Shading

[TODO] Add light & instance support to particles

[TODO] Add shader compilation on cmake

Taken from https://github.com/DiligentGraphics/DiligentSamples/blob/master/Samples/Asteroids/CMakeLists.txt

set_source_files_properties(${SHADERS} PROPERTIES VS_TOOL_OVERRIDE "None")

set(COMPILED_SHADERS_DIR ${CMAKE_CURRENT_BINARY_DIR}/CompiledShaders)
file(MAKE_DIRECTORY "${COMPILED_SHADERS_DIR}")

foreach(SRC_SHADER ${SHADERS})
    get_filename_component(SHADER_NAME ${SRC_SHADER} NAME_WE)
    get_filename_component(SHADER_EXT ${SRC_SHADER} EXT)
    set(COMPILED_SHADER ${COMPILED_SHADERS_DIR}/${SHADER_NAME}.h)
    list(APPEND COMPILED_SHADERS ${COMPILED_SHADER})

    set(PROFILE vs_5_0)
    if(${SHADER_NAME} STREQUAL "asteroid_ps")
        set(PROFILE ps_5_1)
    elseif(${SHADER_EXT} STREQUAL ".psh")
        set(PROFILE ps_5_0)
    endif()

    add_custom_command(OUTPUT ${COMPILED_SHADER} # We must use full path here!
                       COMMAND fxc /T ${PROFILE} /E ${SHADER_NAME} /Vn g_${SHADER_NAME} /Fh "${COMPILED_SHADER}" "${SRC_SHADER}"
                       WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
                       COMMENT "Compiling ${SRC_SHADER}"
                       VERBATIM
    )
endforeach(SRC_SHADER)

# NB: we must use the full path, otherwise the build system will not be able to properly detect
#     changes and shader compilation custom command will run every time
set_source_files_properties(${COMPILED_SHADERS} PROPERTIES GENERATED TRUE)

[BUG] Normals and bi-normals are broken on generated meshes

• Box
• Cone
• Sphere
• Displacement
• Plane

[TODO] Add texture atlas support on non-instance models

[TODO] Improve lightning and add shadow maps

Lightning is currently veryyyyy basic. Shadow maps implementation is also missing

[TODO] Add webm support for textures

Implement sound later

[TODO] Add FOG support

[TODO] Add shader caching

Add shader caching after compiling it once on the client

https://github.com/DiligentGraphics/DiligentCore/blob/e94b36978ccf8dd6e48c759318ef1b887496a7c5/Graphics/GraphicsTools/interface/BytecodeCache.h

[FEATURE] Add netVar & netMap to network lib

[FEATURE] GPU picking

Feature Request

Description

Add GPU picking support

[TODO] Add either sol2 or julia scripting support

[TODO] Add release to CI/CD

[FEATURE] LIT Particles

Feature Request

Description

• Add lit particle support (aka lighting)

[TODO] Add networking

Possible candidates:

• https://github.com/ValveSoftware/GameNetworkingSockets
• https://github.com/pond3r/ggpo

[Improvements] Split animated textures into atlas if they are small

Description

• Split the gif / webm / webp if they are small into a atlas, then use atlasIndex to animate the texture instead of updating it

[BUG] Barrier being called too many times

RawrBox lib

• rawrbox.assimp
• rawrbox.bass
• rawrbox.engine
• rawrbox.math
• rawrbox.network
• rawrbox.physics_2d
• rawrbox.physics_3d
• rawrbox.render
• rawrbox.resources
• rawrbox.scripting
• rawrbox.ui
• rawrbox.utils
• rawrbox.webm

---

• UNKNOWN

Description

rawrbox::BindlessManager::barrier is being called too many times, need to add an ID so it doesn't queue it again if it's already queued?

293 D3D12 WARNING: ID3D12CommandList::ResourceBarrier: Called on the same subresource(s) of Resource(0x000001B18C2C5120:'RawrBox::Texture::Pack') in separate Barrier Descs which is inefficient and likely unintentional. Desc[0] and Desc[1] on (subresource : 0). [ RESOURCE_MANIPULATION WARNING #1008: RESOURCE_BARRIER_DUPLICATE_SUBRESOURCE_TRANSITIONS]

[BUG] Samplers not working

Description

setSample not working due to immutableSamplers, but disabling that requires better sampler management

[FEATURE] Move to DiligentGraphics

Feature Request

Description

Supports tessellation & geometry shaders, as well as being lightweight and having a god dam cmake

Links:

• https://github.com/DiligentGraphics/DiligentSamples
• https://github.com/DiligentGraphics/DiligentEngine

Use Case

• BGFX author is toxic as hell, no decent support, all you get is either ticket deleted or lol update graphics card
• Diligent has higher performance, specially on new DX12 & Vulkan
• No more weird shader language, it's HLSL

[TODO] Fix QHull

[BUG] FOG is acting weird away from world origin

Description

There is some weird issue with shader fog

[TODO] Improve GPUPick by copying a small area of the texture

Staging texture can then be 4x4 or smaller

 CopyTextureAttribs CopyAttribs;
    CopyAttribs.pSrcTexture = pMeshIdTexture;
    CopyAttribs.pDstTexture = pStagingTex;
    Box SrcBox{m_Params.LocationX, m_Params.LocationX + 1, m_Params.LocationY, m_Params.LocationY + 1};
    CopyAttribs.pSrcBox                  = &SrcBox;
    CopyAttribs.SrcTextureTransitionMode = RESOURCE_STATE_TRANSITION_MODE_TRANSITION;
    CopyAttribs.DstTextureTransitionMode = RESOURCE_STATE_TRANSITION_MODE_TRANSITION;
    pCtx->CopyTexture(CopyAttribs);

https://github.com/DiligentGraphics/DiligentFX/blob/master/Hydrogent/src/Tasks/HnReadRprimIdTask.cpp#L115

[TODO] Update wiki & lua lib

Update the wiki with the new diligent system & luau

[BUG] Clustered rendering sometimes crashes on the steam deck

RawrBox lib

• rawrbox.assimp
• rawrbox.bass
• rawrbox.engine
• rawrbox.math
• rawrbox.network
• rawrbox.physics_2d
• rawrbox.physics_3d
• rawrbox.render
• rawrbox.resources
• rawrbox.scripting
• rawrbox.ui
• rawrbox.utils
• rawrbox.webm

---

• UNKNOWN

Need to check the other samples, might be a AMD issue

[BUG] ASYNC randomly gets stuck

When starting, async can randomly get stuck, although this is a veryyyyy low chance of happening..