Skip to content

reference

cheaterbob edited this page Oct 3, 2026 · 1 revision

Reference

Use the example pack index to find a working starting point, the schema index for authoritative JSON contracts, and the generated field-by-field API reference to browse every schema property. The public asset-slot catalog lists supported patch targets.

Validation and errors explains the diagnostic system, while the searchable validation/error-code catalog maps literal runtime codes to their source and message. Troubleshooting covers common author failures, and the Glossary defines project terminology.

Defaults and compatibility defines omission, fallback, migration, and save rules. Resource limits records safety ceilings. Implementation status separates working features from later work, while the v1 release checklist tracks release readiness.

Before publishing one pack, use the smaller mod-author test matrix. Project maintainers use the broader release verification runbook for a complete game release.

The Mod API changelog records public-contract changes and migration guides provide author actions when versions diverge. The authoritative implementation draft remains Docs/Modding/spec-v1.md. Use Implementation status for current capability and the Mod API v1 release checklist for unfinished verification and publication work.

Clone this wiki locally