Skip to content

CMAPI 1.0.0

Latest
Latest

Choose a tag to compare

View all tags
@BrandonAustin01 BrandonAustin01 released this 23 Aug 03:04
· 1 commit to master since this release
v1.0.0
734689a
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

CMAPI 1.0.0

CMAPI’s first public release is here.

CMAPI is a standalone modding platform built specifically for The Planet Crafter. It provides the runtime, mod loader, public API, installer, launcher, console, diagnostics, and safety systems needed to install and run CMAPI mods.

BepInEx is not required.

Highlights

  • Standalone Planet Crafter-specific bootstrap and runtime
  • Guided installer with Install, Update, Repair, and Uninstall options
  • Dedicated CMAPI launcher and console
  • Manifest-based mod discovery and loading
  • Mod dependency and compatibility validation
  • Player, inventory, content, crafting, lifecycle, weather, environment, placement, and world-state APIs
  • Categorized console command system
  • Automatic save backups with configurable retention
  • CMAPI and mod update checking
  • Multiplayer-aware host safety
  • Per-mod configuration and private data storage
  • Main-thread scheduling and game-loop events
  • Clear compatibility checks and startup diagnostics
  • Optional experimental CMAPI Mod Menu

Compatibility

CMAPI 1.0.0 supports:

  • Windows x64
  • The Steam release of The Planet Crafter
  • The Planet Crafter 2.008
  • Assembly-CSharp build 520dcd8f-2c13-4a99-b871-44c7ad40bcc1

CMAPI checks the installed game build before loading. A future Planet Crafter update may require a CMAPI compatibility update.

Installation

  1. Download CMAPI-1.0.0-win-x64.zip.
  2. Extract the ZIP into a temporary folder.
  3. Close The Planet Crafter before continuing.
  4. Run CMAPI-Installer.exe.
  5. Select your Planet Crafter installation and choose Install CMAPI.
  6. Launch the game using CMAPI.exe.

The installer automatically detects the normal Steam installation when possible.

Installing Mods

Place each CMAPI mod inside:

The Planet Crafter\CMAPI\Mods

Each mod should have its own folder containing its manifest and mod files.

Launch the game through CMAPI.exe after installing or updating mods.

Important

  • Back up important saves before installing or changing game mods.
  • The optional CMAPI Mod Menu remains experimental and is not required to run CMAPI mods.
  • CMAPI is an unofficial community project and is not affiliated with or endorsed by Miju Games.
  • Do not install BepInEx for CMAPI. CMAPI owns its standalone runtime.

Documentation

Created by SourceNine Labs.

Assets 4
Loading