meta.json says who it is, a config.json says how to run it, and your source files import each other normally. TypeScript or JavaScript, your choice; the app compiles it on load, with no build step of your own.
fs, no require, no window. Everything it does to the app goes through sdk, and anything that touches the user’s files or the network is gated by a permission they approve.
Get started
Quickstart
Create your first expansion, get it loading, see it hot-reload
Examples
A complete, open-source expansion to read
Guides
Manifest
meta.json and config.json, field by fieldModules and imports
What you can import: files, CSS, assets, JSON, the SDK
Libraries
lib/ folders, imported by name instead of a pathWriting style
Top-level, class, object or function; React class components
Lifecycle
Load, hot reload, errors, logs, disable, uninstall
Permissions
What each one allows, and how approval works
Scripting targets
Export Mechanics and GUIs to Skript, or any scripting plugin, instead of Denizen
Reference
sdk reference
Every SDK point
sdk/ui reference
Hooks and the component kit
Shipping
Publishing
Keys, trusted and untrusted, building a
.lde with compassMigrating from main.js
The old API, point by point, and what is missing
Troubleshooting
Error messages and what they mean
Versions
Lode Studio provides SDK 2.4.0. Yourmeta.json declares the range it was built for:
Declare the lowest version that has everything you use, so the expansion runs on as many app versions as possible.
An expansion the app cannot satisfy is disabled with a message saying so, rather than half-working.
What’s new in 2.1
2.1.0 only adds: nothing from 2.0.0 changed shape or was removed, so a^2.0.0 expansion keeps working. Declare ^2.1.0 once you use anything below. Every legacy main.js API point now has an SDK equivalent; see Migration.
Manifest and permissions
Manifest and permissions
- New permissions:
files,server,echo. See Permissions. meta.jsonrequires: other expansions yours needs, started first.config.jsonbackground: files for background scripts.
UI surfaces
UI surfaces
Commands, keybindings, CLI commands, context-menu entries, toolbar buttons, status bar items, side panels, app-level routes, home widgets, “Add element” entries; sidebar order, position and badges; 11 new injection slots; selectable themes; language key overlays and per-expansion strings; custom icons.
Dialogs and toasts
Dialogs and toasts
Confirm, prompt, custom dialogs, an item picker, native file open and save, progress toasts, toasts with several actions, opening links.
Projects and storage
Projects and storage
Item create, rename, duplicate, move and delete; queries and single-item reads; binary file I/O and file listing; project info and list; file watching; project config; item assets; loading textures and models; Blockbench; downloads. Key/value storage outside components, per-project storage, and a private data folder per expansion.
Export and import pipelines
Export and import pipelines
Your own exporters, item transforms, output-file transforms, extra files, running an export, listing formats. Your own importers, import transforms, drop handlers.
Editors
Editors
Item editor: module overrides, categories, conditional modules, module export to plugin configs, module validation,
useItem(). Create flow: creator compatibility, creator types on the app’s staged flow, custom stages, blueprint categories, pieces and skins, templates, Blueprint editor tools and panels. Logic editors: Skills mechanics, triggers, targeters and conditions; GUI logic steps, checks and triggers; Mechanics triggers, actions and conditions; scripting targets; GUI editor element presets. The Coder: formats, linters, previews.Events, server, Echo and more
Events, server, Echo and more
20 new app events, interceptable (vetoable) events,
events.once. Test server status, console, start and stop, reload commands, sync hooks, sync-script directives, alternative server software, SFTP push hooks. Echo context, tools and questions. Background scripts in a real Worker, and WebSocket. Services between expansions. App info, undo stacks, team presence messaging. In sdk/ui, 10 new hooks and 24 new components.sdk reference and sdk/ui reference mark everything new with 2.1.