EN / English · ZH / 简体中文 · JP / 日本語 · KR / 한국어
Turboism
Copyright and notices
Copyright © 2026 Turboism Contributors. Turboism is open source under the AGPL-3.0-only license.
This version is licensed under the GNU Affero General Public License, version 3 only (AGPL-3.0-only). Third-party components and files with separate license notices retain their respective licenses.
Turboism is an independent third-party project, not affiliated with, endorsed by, or sponsored by Live2D Inc. Live2D, Cubism and related names and marks belong to Live2D Inc. or their respective owners. Turboism does not distribute Cubism Editor or grant, replace or bypass its license; a separately installed, lawfully licensed copy is required.
Read the End User Runtime Statement and Disclaimer before installation. It does not reduce the rights granted by the AGPL-3.0-only license; its Simplified Chinese text is authoritative. The software is provided as is. Keep independent backups before using plugins or automation that change project content.
About
Turboism is a Windows-first runtime enhancement tool and plugin framework for Live2D Cubism Editor. It uses a Java agent and a public SDK to provide modeling workflow improvements, including parameter and mesh tools, PSD utilities, palette enhancements and local automation. Available features depend on the installed plugins, permissions and exact Editor version.
Supported Cubism Editor versions
| Cubism Editor | Support |
|---|
| 5.0.00 – 5.0.06 | Exact-version adapters |
| 5.1.00 – 5.1.03 | Exact-version adapters |
| 5.2.00 – 5.2.03 | Exact-version adapters |
| 5.3.00 – 5.3.04 | Exact-version adapters |
Windows x64 is the supported Cubism host platform. Unlisted Editor versions are not claimed compatible; unavailable adapters or features fail closed. Version support does not mean every plugin feature is available on every version.
On macOS and Linux, download and extract either portable ZIP archive (turboism-<version>.zip). macOS packaging is preview-only with no verified Cubism host support; Linux covers runtime behavior only and is not a supported Cubism host.
Installation
Download a package and its matching .sha256 file from the latest GitHub Release. The standard packages include every bundled first-party plugin:
- Windows installer:
TurboismInstaller-<version>.exe.
- Portable package:
turboism-<version>.zip.
Both standard packages include the complete offline GraalJS engine. A compatible GraalVM runtime is installed separately through the configurator.
Choose one installation format below. Close Cubism and back up your projects before installing or updating.
Every Turboism installer ships in English, Simplified Chinese, Japanese and Korean. Choosing a language only changes the installer's own interface; the language Turboism uses at runtime still comes from config.json (locale).
Installers are currently unsigned. The .sha256 file is published next to the download, so it detects corruption but cannot prove the release was not replaced; only the Ed25519-signed plugin catalog is independently anchored. Compare the downloaded file against its checksum before running it. For example, in PowerShell (replace <version> with the downloaded version):
Get-FileHash ".\TurboismInstaller-<version>.exe" -Algorithm SHA256
EXE — recommended on Windows
Run TurboismInstaller-<version>.exe and follow the setup wizard to choose the installation directory and launch options. All first-party plugins are included; enable or disable them through plugin management. Choose English, Simplified Chinese, Japanese or Korean before the welcome page. Use the generated Turboism shortcut afterward.
Integration with the official Cubism startup BAT is selected by default. Clear it on the launch-options page if you do not want it. It uses hash-guarded backups, and uninstall restores the original BAT files. Later user edits can prevent automatic restoration. Keep your project backups separate from these installer-managed backups.
The installer upgrades existing installations, installs the current first-party plugins and preserves existing disabledPlugins settings.
ZIP — manual setup on Windows
-
Download turboism-<version>.zip, which includes the runtime and bundled first-party plugins.
-
Extract the whole archive into a separate Turboism folder, not into the Cubism installation directory.
-
From the extracted folder, open the configurator:
powershell -NoProfile -ExecutionPolicy Bypass -File ".\configure_turboism.ps1"
The execution-policy option applies only to that PowerShell process. Select the Cubism installations and plugins you want, then save.
-
Start Cubism using the generated Turboism shortcut or launch-cubism-turboism.bat in that folder.
No release package includes managed fx runtime bytes or the development-only Turboism with fx plugin.
Development
You need Git and JDK 17. Use the repository's Gradle wrapper; no separate Gradle installation is required.
git clone https://github.com/turboism/Turboism.git
cd Turboism
./gradlew devCheck
On Windows, use gradlew.bat instead of ./gradlew. Make changes on a separate feature branch or worktree.
For plugin development, start with the demo plugin, its build configuration and plugin descriptor. Plugins depend on :sdk with compileOnly scope; do not directly depend on runtime internals or com.live2d.* classes.
Building a plugin outside this repository does not require building Turboism. Every GitHub Release ships turboism-sdk-<version>.jar and turboism-event-processor-<version>.jar (with .sha256 sidecars): copy templates/plugin-template as a standalone project, run its setup script (or drop the JARs into libs/) and follow its README. Framework contributors can also publish the SDK and the @SubscribeEvent annotation processor to the local Maven repository, then resolve dev.turboism:sdk and dev.turboism:event-processor from mavenLocal():
./gradlew :sdk:publishToMavenLocal :event-processor:publishToMavenLocal
./gradlew :plugins:demo:test :plugins:demo:jar
The demo is development-only, not part of the release bundle. Run focused tests for your changes and ./gradlew devCheck before submitting them. See the architecture for API, lifecycle, transaction and verification rules.
Documentation
