Getting Started

Quick Start

Learn how to set up and use Godot-Router for file-based routing in your Godot project.

Setup

  1. Install Godot-Router Addon
    2. Download or install the Godot-Router addon in your Godot project.
  2. Enable the Addon
    3. In Godot, go to Project > Project Settings > Plugins and enable Godot-Router.
  3. Create routes Folder
    4. In your project, create a routes folder if it doesn't exist.
  4. Add a Page
    5. Add a new folder inside routes (e.g., routes/main), then add a +page.tscn scene inside it. This becomes a route.
  5. Set Main Scene
    6. In Godot, go to Project > Project Settings > Run > Main Scene and set it to your new +page.tscn (e.g., routes/main/+page.tscn).

    7. Run your project. In a script, use Router.goto to navigate to another route.

    Router.goto("/main")
    .gdscript