S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / Maintainers

Roadmap

Current post-1.0 engineering direction.

View source ↗
CMAPI 1.0.0Standalone runtimeWindows x64Tested with Planet Crafter 2.008

CMAPI roadmap

This roadmap records API candidates supported by evidence in the tested full-game assembly. It is not a promise to expose a hook before its lifecycle, authority, multiplayer behavior, and failure modes pass in-game tests.

Completed foundations

  • 0.8.0: searchable command catalog, aliases, diagnostics, teleport recovery, exact log labels, and readable configuration inspection.
  • 0.9.0: synchronized weather catalog/status/starts, world-unit and stage snapshots, day/night and water queries, installed planet definitions, a guarded full-day reset, public host-safe same-planet player placement, and optional Mod Menu 0.2.2 with reversible host-only survival, mobility, inventory, power, weather, and teleport controls.
  • 0.10.0: owner-scoped world/planet/save/weather lifecycle events; live recipe and unlock catalogs; local backpack/equipment snapshots and native content changes; matching player-facing inspection commands.
  • 0.11.0–0.13.0: CMAPI-owned standalone bootstrap/runtime, dependency-aware mod loading, stable feature discovery, per-mod storage, main-thread scheduling, and game-loop events; removal of the last BepInEx project and runtime seams.
  • 0.14.0–0.15.0: transactional Setup, ownership receipts, rollback/recovery, package manifests, negative archive gates, official update-feed validation, and pinned UnityDoorstop provenance.
  • 1.0.0: stable standalone product/public API/bootstrap contract and explicit Install, Update, Repair, and Uninstall user flows. Mod Menu 0.2.2 remains a separately versioned experimental beta.

Ongoing 1.x compatibility gates

  • Prove natural weather, rain, meteor, and asteroid starts on a disposable host save and joining client.
  • Confirm an active event ends through the game's normal cleanup and that CMAPI refuses every overlap attempt without changing it.
  • Verify stage-bound rejection on saves before and after relevant terraformation stages.
  • Verify weather/status/world/environment/planet snapshots across title screen, world entry, world exit, save switching, and every available planet.
  • Verify day_reset synchronizes on clients without changing terraformation.
  • Confirm command colors remain readable in Windows Terminal, classic console, redirected output, and screenshots with a dark background.
  • Verify CMAPI Mod Menu 0.2.2 injection/restoration lifecycle, focused-state UI regression, compact safe-area layout, mouse placement, real controller action activation, and trainer behavior across window modes/resolutions.
  • Complete clean build, packaging, checksum, documentation, and public API XML gates in TESTING.md.

Post-1.0 candidates: mod-building depth

  • IToxicityManager for network-aware cleanup progress;
  • read-only machine/storage inspection and story-event history;
  • mod configuration helpers with validation and generated documentation.

Explicitly deferred mutations

  • forced weather stop/replacement until native cleanup is proven callable;
  • raw fog, skybox, cloud, material, lighting, hue, and post-processing writes until CMAPI has owner-scoped override handles with guaranteed restoration;
  • terraformation and world-unit setters;
  • forced planet travel;
  • a public toxicity mutation API and story-event activation.

Each surface should begin read-only, add host-safe mutations only where the game has a reliable authority path, and ship with matching commands, XML summaries, examples, and release tests.

See ENVIRONMENT-API-RESEARCH.md for the full-game assembly evidence and risk classification behind these candidates.