FAQ.md

FAQ

What format should I release?

Use .vmz for normal OrcKit releases.

Is .vmz just zip?

It is zip-compatible. Package your mod as a zip with mod.txt at the root, then rename it to .vmz.

Can users install loose folders?

Only when Developer Mode is enabled. Ship archive mods for users.

Do .pck mods support mod.txt?

OrcKit mounts .pck files, but normal mod.txt processing such as autoload declarations is skipped for .pck entries.

Why did my mod disappear when another version was installed?

Both copies probably share the same [mod] id. OrcKit deduplicates by id and keeps the preferred version.

What priority should I use?

Use 0 unless you have a reason. Compatibility patches can use higher values.

How do I make my mod load after another mod?

Set a higher priority than the other mod. Also document the dependency and use has_mod() at runtime if your code depends on it.

How do I check if another mod is loaded?

var modlib = Engine.get_meta("OrcmodLib")
if modlib.has_mod("other_mod", "1.0.0"):
	print("other_mod is available")

Should I use hooks or script overrides?

Use hooks for small behavior changes. Use script overrides when you need to replace larger script behavior.

My hook does not fire. What is the first thing to check?

Check that [hooks] declares the vanilla script and method, and that registration happens after frameworks_ready.

Can two mods replace the same script?

They can both try, but only the later-loaded one wins. Use the conflict report to confirm.

Where is the conflict report?

In Developer Mode:

user://modloader_conflicts.txt

What does frameworks_ready mean?

It means OrcKit's runtime facade and hook framework are ready. Register hooks after this signal.

Why does OrcKit restart the game?

Some resources need packs mounted early. OrcKit uses a two-pass restart to mount enabled archives and hook packs at the right time.

My mod triggers the security scanner. Is it banned?

Not automatically. But users will be warned. Remove risky APIs if possible, or clearly document why they are needed.