Quick Start

This quick start begins from a published release package as described in Installation. You need the package and an installed, lawfully licensed Cubism Editor.

1. Prepare safely

Windows x64 is the supported Cubism host platform. Supported Editor versions are 5.2.03, 5.3.02, and 5.3.03.
The .jar installer needs a Java 17+ runtime.
Back up the project you intend to open, or use a disposable copy.
Keep the Turboism home separate from the Cubism installation.
Do not edit Cubism JARs, DLLs, BAT files, or licensing state.

2. Download and verify

Open turboism.dev/download and choose a channel: Stable, Beta, or Nightly.
Download one package and its matching .sha256 file.

Verify the file hash, for example in PowerShell:

Get-FileHash ".\TurboismInstaller-<version>.exe" -Algorithm SHA256

Installers are unsigned, so the checksum is the integrity check you can perform yourself.

3. Install

Windows `.exe` installer

Run TurboismInstaller-<version>.exe.
Choose the installer language (English, Simplified Chinese, Japanese, or Korean).
Read the license and confirm all four required acknowledgements.
Choose Full or Lite, then choose the install directory (%LOCALAPPDATA%\Turboism by default). In Full mode you can deselect individual plugins.
Decide whether to download the optional managed GraalVM component.
When the installer opens configure_turboism.ps1, select the Cubism installations to use and save. Canceling the configurator leaves a valid framework-only install.
Start Cubism through the managed launcher for your Cubism root (launch-cubism-turboism.bat).

Cross-platform `.jar` installer

Run the installer:
```
java -jar TurboismInstaller-<version>.jar
```
Pass -language eng|chn|jpn|kor to preselect the installer language.
Complete the declarations and choose Full, Thin, or Lite, then the target directory.
On Windows, run the installed configure_turboism.ps1, select the Cubism installations, and launch through the managed launcher. On macOS, the installer covers installation and uninstall only: macOS Cubism host support is not verified and no macOS launcher is installed.

Portable ZIP

Extract the whole archive into its own folder.
Run configure_turboism.ps1 from that folder and select the Cubism installations.
Start Cubism through the generated shortcut or launch-cubism-turboism.bat.

The installer language affects only the installer. The language Turboism uses at runtime comes from the runtime locale setting, and plugin interface language follows Cubism Editor's File → Environment Settings → General → Language.

4. Verify the first run

Check that:

Cubism starts normally;
the Turboism runtime reports startup;
the runtime uses the intended Turboism home;
installed plugins appear in the plugin manager and runtime diagnostics;
unavailable host capabilities fail closed rather than crashing Cubism;
closing Cubism releases plugin scopes and framework-owned executors.

5. Add a plugin

The Full selection already installs the reviewed first-party plugin bundle. To add a local plugin JAR:

Open Turboism and choose Plugin Management.
Choose Install from JAR….
Select the local .jar file.
Confirm the dialog that marks the JAR as a local/unverified source.
Restart Cubism when the operation is shown as pending.

The JAR is staged after confirmation and applies after the restart. Plugin changes do not hot-swap the currently loaded plugin instance. Plugin JARs are separate from the Turboism installer JAR.

Manual alternative

As an advanced fallback path — for example to test a locally built JAR — you can place a plugin JAR directly:

Fully close Cubism and Turboism.
Copy the trusted plugin JAR directly into the root of <turboism.home>/plugins/.
Keep at most one JAR for each plugin ID.
Restart with the same Turboism home.
Verify the plugin state and runtime logs.

Manual installation bypasses the managed safeguards. See Plugin Management for the full procedure.

6. Find logs

Use the installed Turboism home's logs/ directory. Keep logs when reporting startup, JAR, dependency, permission, or Provider failures.

A place to create together