SMMODS
Active WIP

Starminer modding is not fully stable yet. Use SMMODS and mod packages at your own risk, and bring questions to the official Starminer Discord in modding-discussions.

For modders

Build Starminer mods

The framework repo owns the SDK, manifest schema, package layout, examples, and validation. SMMODS turns a validated package into a public catalog entry.

Read getting started Download framework Template script Upload availability API contract

Publishing flow

From local mod to public catalog record

01

Start from the template

Use the framework template and work against a copied Starminer install while testing.

02

Validate the package

Check manifest shape, safe paths, dependencies, entrypoints, target build, and hashes.

03

Submit a version

Accounts and real upload storage are disabled until the production backend is deployed.

Package contract

Publishable mods need manager-readable metadata.

Every installable mod needs a stable id, semantic version, target game build, entrypoints, dependency declarations, a versioned ZIP, and SHA256 metadata. Framework-based Lua mods should depend on starminer.framework.

Manifest docs Validation docs
Getting started Framework source Framework template script Manifest schema Framework examples Hello Lua sample source Object Catalog Export sample source Manager source Manager API contract Upload availability Moderation states