adamant-ModpackLib

Shared runtime and immediate-mode UI toolkit for adamant modpack modules.

Lib now owns:

• managed module storage and explicit session
• storage typing and normalization
• hash/profile encoding helpers
• mutation lifecycle helpers for affectsRunData modules
• standalone hosting helpers
• immediate-mode widgets and navigation helpers

Lib does not own a declarative UI tree/runtime anymore. New module UI should be written directly in module draw functions such as internal.DrawTab(ui, session) and optional internal.DrawQuickContent(ui, session), then exposed through public.host = lib.createModuleHost(...).

Docs

• GETTING_STARTED.md First-time author guide: core concepts, file roles, and your first module.
• API.md Reference for the current public namespaces and functions.
• MODULE_AUTHORING.md How to author a module against the current immediate-mode contract.
• WIDGETS.md Widgets, nav, and storage notes for the live surface.
• UI_PERFORMANCE.md Render-path guidance for immediate-mode module UIs.
• IMGUI_LUA_REFERENCE.md Notes on the Dear ImGui Lua binding used by the stack.
• RELOAD_MODUTIL_CHALK_REFERENCE.md Stack reference for ReLoad, ModUtil, and Chalk behavior.
• CONTRIBUTING.md Contributor expectations for changing the public Lib contract.

Current Public Namespaces

• lib.config
• lib.logging
• lib.lifecycle
• lib.mutation
• lib.hashing
• lib.widgets
• lib.nav

Common top-level helpers:

• lib.createStore(...)
• lib.createModuleHost(...)
• lib.standaloneHost(...)
• lib.isModuleEnabled(...)
• lib.isModuleCoordinated(...)
• lib.resetStorageToDefaults(...)

Validation

cd adamant-ModpackLib
lua5.2 tests/all.lua

Changelog

All notable changes to this project will be documented in this file.

Unreleased

1.0.0 - 2026-04-20

Initial public release of the adamant Modpack Lib surface.

Added

• managed module storage through lib.createStore(config, definition, dataDefaults?)
• explicit staged UI state through the returned session
• host-based module wiring through lib.createModuleHost(...)
• standalone window/menu hosting through lib.standaloneHost(...)
• lifecycle helpers under lib.lifecycle.*
• mutation helpers under lib.mutation.*
• hashing and packed-bit helpers under lib.hashing.*
• immediate-mode widget helpers under lib.widgets.*
• immediate-mode navigation helpers under lib.nav.*
• shared logging helpers under lib.logging.*
• managed storage support for:
  • bool
  • int
  • string
  • packedInt
• transactional session commit/resync support for host and framework flows
• coordinated-pack enable-state support through lib.isModuleCoordinated(...) and lib.isModuleEnabled(...)
• standalone and framework-friendly module authoring contract based on:
  • public.definition
  • public.host
  • direct draw functions such as DrawTab(imgui, session)

Notes

• this release documents the current immediate-mode Lib contract
• legacy declarative UI authoring is not part of the supported public surface for this release