What is Godot-Router?

What is Godot-Router?

Godot-Router brings file-based routing to Godot, inspired by SvelteKit. It lets you organize your project by folder and file names, making navigation between scenes simple and your project structure easy to follow.

Below is an example folder structure for a Godot project using Godot-Router. You can expand the (menu) and (game) group folders to see the routes:

You will notice two consistent file names in the above example: +page.tscn and +layout.tscn. In short, +page.tscn files are the actual scene routes, and +layout.tscn files are scenes that wrap all routes within its folder.

Why Is This Useful?

Without Godot-Router, managing multiple related scenes (like audio, gameplay, and controls settings) often means creating one big scene and writing scripts to show or hide each part. This can get complicated and tightly coupled.

With Godot-Router, you simply create a folder and a +page.tscn for each setting. Each page is independent. A +layout.tscn in the folder can add shared UI, like a tab bar, and use Router.goto() to switch between pages. This keeps your project organized and your code simple.

Ready to Dive In?

Head over to the Quick Start section to start using Godot-Router quickly.

OR

Explore the rest of the documentation to see Godot-Router's options and capabilities.