• English

      • Changelog

      Estimated reading time: 5 minutes

      This site documents maplebirch-release-v4.1.7 as the current recommended minimum framework version. Full history lives in upstream UPDATE.md.

      v4.1.7

      Release tag: maplebirch-release-v4.1.7 Recommended asset: maplebirch-0.5.10.8-v4.1.7.modpack

      Highlights

      faceStyle

      • Fixed faceStyle layer compatibility for basehead.png: 0.5.8.10 follows basehead.png, 0.5.9.8 follows base-head.png

      v4.1.6

      Release tag: maplebirch-release-v4.1.6 Recommended asset: maplebirch-0.5.10.8-v4.1.6.modpack

      Highlights

      Types Package

      • Optimized @scml-maplebirch/types package, supplemented and corrected framework public interfaces, SugarCube/global objects, and module declarations

      Desktop Pet

      • Fixed desktop pet display and rendering issues

      Time Travel Cheats

      • Fixed weather refresh after time jump — weather is now recalculated and weather events re-triggered, preventing issues like eclipses not activating

      Image Compatibility

      • Fixed display anomalies caused by image path changes in vanilla 0.5.10.x

      faceStyle

      • Added support for img/face/<facestyle>/base-head.png to replace PC head base image; falls back to vanilla img/body/base-head.png when not found

      v4.1.0

      Release tag: maplebirch-release-v4.1.0 Recommended asset: maplebirch-0.5.10.8-v4.1.0.modpack

      Highlights

      DOLP Transformation Compatibility

      • Fixed DOLP transformation compatibility issues, reducing anomalies when reading NPC/PC transformation state
      • Optimized NPC transformation and state reading logic, fixing forced errors when transformation data is uninitialized or fields are missing

      Save System

      • Optimized save reading and initialization flow, reducing old variable residuals, duplicate initialization, and page rendering anomalies after loading
      • Removed legacy :onLoadSave event; unified to :onSave and :onLoad for save-related logic
      • Improved title-screen save-load refresh handling, lowering anomaly probability from stale save data

      Time Travel Cheats

      • Improved responsive UI layout for year/month/day/hour/minute inputs and confirm button at different widths

      v4.0.2

      Release tag: maplebirch-release-v4.0.2 Recommended asset: maplebirch-0.5.10.8-v4.0.2.modpack

      Tip

      v4.0.0 accumulates changes since v3.1.14. Framework version bumped to 4.0.0, highest game version dependency updated to 0.5.10.8.

      Types & Core

      • Added publishable @scml-maplebirch/types package with maplebirch, SugarCube, and global type declarations

      Time & DateTime

      • Rewrote time/date patching logic to reduce conflicts between time progression, time events, and DoLTimeWrapperAddon—see Time events
      • Fixed TimeEvent compatibility interface and cross-passage time rollback issues

      Database

      • Fixed load hang when IndexedDB version is lower than the existing database; automatic reset on version downgrade

      Legacy Compatibility

      • Simplified legacy compatibility layer, keeping only addto and TimeEvent

      Module Management

      • Optimized registration, dependency execution, and enable/disable logic—see Module system
      • Added reset framework defaults in mod settings—see GUI control

      Food & Antique Registration

      • Added foodstuff registration (game version 0.5.9.x+) and antiques registration—see Foodstuff, Antiques

      Combat System Overhaul

      • Refactored combat buttons to maplebirch.combat.CombatAction, added effect field supporting Twine text/function injection via effectsman—see Combat actions
      • Legacy combat reaction, ejaculation, and crossdress dialogue modules no longer maintained independently

      NPC System

      • Fixed NPC descriptions, gender pronouns, and body-part descriptions
      • Optimized NPC schedule registration—see NPC schedule
      • Updated NPC clothing documentation; extra wardrobe files should use loadWardrobe—see NPC clothing
      • Fixed NPC sidebar character models, masks, and hat close-up issues—see NPC sidebar
      • Added NPC transformation—see NPC transformation
      • Added NPC fluid layers—see NPC fluids
      • Added NPC pregnancy (with race registration, per-NPC config, child birth, and transformation data)—see NPC pregnancy

      Model & Sidebar

      Time Travel Cheats

      • Added/enhanced time travel cheats with year/month/day/hour/minute jump; confirmation refreshes the current page

      SugarCube Macros

      • Refactored macro implementations; <<lanButton>>/<<lanLink>> now support class:/style: parameters—see SugarCube macros

      Utility Functions

      • Recommended prototype/static methods: source.clone(), Object.merge(), list.contains(), Math.clamp(), etc.—see Utility functions
      • Legacy global functions still mounted on window

      Audio Module

      • Split internal structures for Track, Playlist, and AudioBufferPlayer—see Audio management

      Mod Protection

      Cloud Saves

      • Added cloud save client and server examples (Go + SQLite / Cloudflare R2+WebDAV)—see Cloud saves

      Documentation

      v3.2.5

      Release tag: maplebirch-release-v3.2.5
      Recommended asset: maplebirch-0.5.9.7-v3.2.5.modpack

      Highlights

      • Fix NPC sidebar character model and related issues
      • Remove combat reaction, combat ejaculation, and crossdress dialogue from the combat module (vanilla can cover these)—see Combat reaction and Combat speech
      • Simplify Simple Frameworks compatibility on game version 0.5.9.7 (keep addto and TimeEvent)—see Getting started
      • Improve module registration and usage—see Module system
      • Fix time events on 0.5.9.7—see Time events
      • Improve NPC schedule registration—see NPC schedule
      • Add reset framework defaults in mod settings—see GUI control
      • Ship mod encryption collaboration (.modpack + maplebirch.credential)—see Mod protection
      • Add Foodstuff registration (maplebirch.tool.patch.addFoodstuff, requires game version 0.5.9.x+) and Antiques registration (maplebirch.tool.patch.addAntiques) — see Foodstuff, Antiques
      • Refactor maplebirch.tool.other to maplebirch.tool.patch — existing traits, location, and bodywriting API paths updated accordingly
      • boot.json framework field now supports external file references for foodstuff, antiques, and bodywriting

      Documentation

      • Mod protection — aligned with upstream README encryption flow
      • Module system — lifecycle, dependencyGraph, EXPOSED modules
      • Foodstuff — new foodstuff registration API documentation
      • Antiques — new antiques registration API documentation
      • Bodywriting — added boot.json configuration section

      Earlier releases

      See UPDATE.md for v3.1.x, v3.0.x, and older entries. This site no longer documents per-patch compatibility for those versions in the main guides.