STS2 Live2D

English

简体中文
日本語

English

简体中文
日本語

Appearance

STS2 Live2DUse Live2D in Slay the Spire 2

Import and manage Live2D Cubism models, play motions in menus and game scenes, tune rendering, or let other Mods control them through the public API.

Player Guide
Mod Integration

For Players

Check the requirements, import your first model, and configure its placement, scale, and actions for menus or game scenes.

Start configuring

Mod Integration

Add the compile-time API through ProjectReference or NuGet, then declare the Live2D runtime Mod dependency.

Follow the setup

Model Packs

Bundle a .live2dpack in your PCK and register its models in the central Live2D library.

Bundle models

API Reference

Find model handles, playback, transforms, filters, masks, Parameters, Parts, and main-thread dispatch APIs.

Browse the API

Version and distribution ​

Distribution scope

The STS2.Live2D NuGet package provides compile-time APIs for other Mods; the Live2D runtime Mod provides the player runtime.

  • Runtime version: 0.6.1
  • Public API: 9
  • Pack format: 1
  • Supported platform: Windows x86_64

Core capabilities ​

  • Scene integration: Manage Main Menu and in-game models independently while preserving visibility across Map, Combat, and UI transitions.
  • Model control: Update position, scale, rotation, opacity, layer, motions, expressions, Parameters, and Parts in real time.
  • Rendering control: Apply blend modes, color filters, three canvas-mask shapes, and edit them with sliders, numeric fields, color pickers, and a live canvas.
  • Clear output: Render neutral models directly and dynamically size effect-composite targets up to 8192 pixels per side.
  • Third-party extensions: Use stable handles, main-thread dispatch, coalesced high-frequency updates, and APIs for Mod-bundled model Packs.

Scope and requirements ​

STS2 Live2D loads and controls runtime-ready Live2D Cubism models. A model includes a valid .model3.json, .moc3, its textures, and every dependency referenced by the manifest.