gloobie

A cross-platform experimental renderer for Resonite.

Legalities

This project is not affiliated with Yellow Dog Man Studios or Resonite in any way, shape, or form. Any issues encountered while using Gloobie should be reported to our issue tracker, not to them.

Disclaimer

This project is still in it's early-early stages, so we are not ready to take on external contributions yet. There's certain ways we would like things to be implemented to lay the foundation for future code that we have not documented, and external contributions on core parts would only slow us down as of now, since we very frequently do heavy refactors and rewrite large chunks of code, causing extra merge conflicts and painful review processes.

If you're interested in contributing, please get in touch and we'll let you know when we're ready for it, or if there's certain things outside of the core projects that you can help with!

Building

Dependencies

• Zig
• slang (Automatically fetched, if you're building on an unsupported host target, you're on your own to add the correct binary!)
• DXC (Optional, for D3D12/DXIL shader target. This can be acquired via the Windows SDK.)

We target a version of Zig that isn't currently available in a formal release (otherwise known as a master build), since otherwise we would have to rewrite code as Zig isn't a stable language. You can see the version of Zig we used listed at the top of the build.zig.zon file.

We recommend the zigup tool for downloading Zig master builds. On Arch Linux it's provided via the zigup-bin package, but for other operating systems like Windows it's available as a GitHub Release.

To install the correct version of Zig, you can run it like so:

# using the version of Zig from build.zig.zon...
$ zigup fetch [version]
$ zigup default [version]

Once installed, you can build the project by running zig build. By default, this will build a Debug build for your current platform. You can override this with -Doptimize= and -Dtarget= flags respectively.

Running

We recommend copying the built output in zig-out/bin directly to Resonite's folder, and then running it from there. This will use our custom bootstrapper to launch the game without having to replace the renderer.

You can also replace Renderer/Renderite.Renderer.exe with Gloobie and it will work, but this isn't recommended and won't work on Linux.

Sub-projects

Executables & Libraries

These sub-projects are home-grown by us.

• client/: The main client.
• bootstrap/: A custom bootstrapper, supporting choosing between custom renderers.
• renderite/: Code and types concerning communication with FrooxEngine.
  • renderite/generator/: Generates type definitions and (de)serialization code from the Renderite DLL file.
  • renderite/shared.zig Automatically generated types from the Renderite DLL file. This should stay in sync with engine updates.
• math/: An xr_linear based math library, with lots of extra routines sprinkled in. Taken from vrshit.
• build/: Misc build scripts.
• logger/: A basic logging system for our needs
• zinterprocess/: Zig implementation of YDMS's fork of Interprocess.

Third-party abstractions

These are Zig bindings to third-party libraries or the native libraries themselves, either our own or yoinked from somewhere.

• third-party/: Third party dependencies pulled in through submodules.
• gpu/: The low level GPU abstraction. Forked off SDL_gpu.
  • gpu/vulkan/: The Vulkan GPU backend. Primary target.
  • gpu/d3d12/: The D3D12 GPU backend, secondary target.
  • gpu/metal/: The Metal GPU backend, tertiary target.
  • gpu/hashtable/: A simple hash table implementation in C, used by the GPU backends.
• xr/: The VR abstraction layer.
  • xr/openxr/: The OpenXR backend. Primary target.
  • xr/none/: A stubbed out backend, used for platforms where no XR infrastructure is available or implemented.
• openxr/: The OpenXR wrapper.
• imgui/: An implementation of an ImGui renderer for our GPU abstraction.
• tracy/: Zig + Tracy integration