Getting Started

Quick Start

Install, enable, open the dock, and run a safe tiny test scene.

v0.9.4Godot 4.7 stable4.6.3 supportedCurrent
This page summarizes the current v0.9.4 workflow and keeps Early Access boundaries clear.

Requirements and installation

Requirements

  • Godot 4.7 stable is the current compatibility target for new projects. Godot 4.6.3 remains supported for existing 4.6.x projects.
  • A Godot project. First-time users should start in a clean test project before using Dreamcatcher inside an existing project.
  • The addons/dreamcatcher/ folder from the Dreamcatcher release.
  • No third-party Godot add-on is required by the plugin files themselves.
  • Exporting still requires the normal Godot export templates and platform-specific requirements.

Install Dreamcatcher

  1. Create or open a Godot 4.7 stable project. Godot 4.6.3 is also supported.
  2. Copy the plugin folder into your project so the path is exactly:
your_project/
├── addons/
│  └── dreamcatcher/
│    ├── plugin.cfg
│    └── plugin.gd
├── project.godot
└── ...
  1. Open the project in Godot.
  2. Go to Project → Project Settings → Plugins.
  3. Enable Dreamcatcher.
  4. Restart Godot if panels do not appear immediately.

Common mistake: double nesting. This is wrong:

addons/dreamcatcher/dreamcatcher/plugin.cfg

Correct path:

addons/dreamcatcher/plugin.cfg

Verifying installation

After enabling the plugin, check for Dreamcatcher editor surfaces such as the main Dreamcatcher / Almanac workspace, Dream Board, Dream DNA, Dream Console, Dream Inspector, Quick Play controls, and the visible editor tools. The exact layout can vary depending on Godot editor layout, enabled modules, and whether the plugin is in headless/no-autoload mode.

The plugin registers 28 autoloads unless dreamcatcher/advanced/no_autoload_mode is enabled. It also registers 113 custom node types gated by the module manifest. If something appears missing, check the Module Manager and advanced no-autoload setting before assuming the plugin is broken.

Recommended first verification checklist:

  • The plugin appears in Project Settings → Plugins and can be enabled.
  • Dreamcatcher UI panels appear after enabling or after restarting Godot.
  • No critical errors appear in the Godot output panel.
  • Quick Play controls are visible or available from the Dreamcatcher workflow.
  • A clean project can open the Dreamcatcher workspace.
  • The Module Manager shows expected modules as enabled.

What you should see after installing

  • Dreamcatcher appears in Project Settings → Plugins and can be enabled.
  • Dreamcatcher docks/tools appear once after the editor reloads.
  • New Dreamcatcher custom nodes are searchable in the Godot node dialog when their modules are enabled.
  • Autoload services appear in Project Settings → Autoload unless advanced no-autoload mode is intentionally used.
  • The Godot Output panel should not show parse errors when the plugin loads.

Your first 10 minutes

Do not try to learn all 24 tools immediately. The first 10 minutes should build orientation and confidence.

  1. Open the Dreamcatcher workspace or Almanac.
  2. Choose Universal, Platformer, or Action RPG as your first Genre DNA.
  3. Open Scene Composer and create or inspect a small scene/template.
  4. Open Generated Asset Browser so you know where generated outputs will appear.
  5. Open Content Validator so you know where warnings and readiness checks appear.
  6. Run or prepare to run Quick Play on a small test scene.

Success is not “I understand everything.” Success is “I know where to start, where generated content goes, and where to test/fix problems.”