Skip to content

Documentation

godotGS

godotGS is a Godot 4.5 fork with an in-tree Gaussian Splatting module for importing, rendering, and tuning splat-based scenes in the editor and at runtime.

Alpha

Start with First Run Check Compatibility

Current Status

  • Preferred install path: Linux nightly for the fastest evaluation path, or Build from Source on Windows and macOS.
  • Release reality: public GitHub releases are currently nightly-first.
  • Binary coverage: public binaries currently cover the Linux editor only.
  • Usage fit: evaluation, prototypes, and contributor work.

Start Here

  1. Choose the current install path: Linux nightly for the fastest evaluation path, or Build from Source on other platforms.
  2. Run First Run and reach a first visible splat.
  3. Check platform status, release-channel reality, and known recurring issues.

Choose a Section

  • Start Here: evaluate the project quickly, understand the current fit, and reach a first visible result.
  • User Guide: import assets, understand runtime behavior, and tune day-to-day quality and performance.
  • Reference: look up settings, API surfaces, compatibility details, and migration notes.
  • Contribute: build the fork, run validation, understand architecture, and ship safe changes.