Skip to content

Developer Mode.md

ESTONlA edited this page May 25, 2026 · 1 revision

Developer Mode

Developer Mode is the main workflow switch for mod authors.

It enables:

  • loose folder mod loading
  • verbose loader logging
  • compatibility summary output
  • conflict report generation

Enabling Developer Mode

Open the OrcKit Mods menu and toggle Developer Mode.

When enabled, OrcKit scans folders inside:

<game folder>/mods

Example:

mods/MyLooseMod/
  mod.txt
  scripts/main.gd

When Developer Mode is disabled, folders are recorded as hidden and not loaded as mods.

Why Folder Mods Are Developer-Only

Loose folders are convenient while authoring because you can edit files directly. They are less predictable for normal users because:

  • file timestamps change often
  • stale files can remain after updates
  • users can accidentally edit or delete individual files
  • package root mistakes are easier to miss

Ship .vmz files to users.

Developer Mode Reports

Developer Mode prints a compatibility summary and writes:

user://modloader_conflicts.txt

The report includes:

  • number of loaded mods
  • conflicting resource paths
  • which mod wins each conflict
  • registered hook names and callback counts

Developer Workflow

  1. Enable Developer Mode.
  2. Create a folder mod.
  3. Add mod.txt.
  4. Add one autoload print.
  5. Confirm the mod appears.
  6. Add hooks or overrides.
  7. Check logs.
  8. Package as .vmz.
  9. Test the .vmz with Developer Mode off.

Working With Profiles

OrcKit stores enabled states and priorities per profile. This is useful for testing:

  • clean profile
  • compatibility profile
  • all mods profile
  • vanilla profile

If a mod goes missing from a profile, OrcKit can show stale entries so you know the profile references something no longer installed.

Developer Mode Tips

  • Keep one small test mod for experimenting with hook names.
  • Use explicit [hooks] entries while developing.
  • Use priority 0 until you know you need a different value.
  • Avoid testing packaged and loose copies with the same id at the same time.
  • Read the conflict report before assuming OrcKit failed.

Clone this wiki locally