Quick Start
Install a published Turboism package, configure it, and verify the first run.
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. The current Stable release 0.67.4 supports all 20 reviewed Cubism Editor versions from 5.0.00 to 5.3.04; see Compatibility.
- The legacy Java installer is no longer published; macOS and Linux use the portable ZIP package.
- 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
.sha256file:TurboismInstaller-<version>.exe— the Windows installer (recommended on Windows).turboism-<version>.zip— the portable archive for manual setup on Windows, macOS, or Linux.
Both packages include the framework, every bundled first-party plugin, and the complete offline GraalJS engine.
-
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 the install directory (
%LOCALAPPDATA%\Turboismby default). There are no mode or plugin-selection pages: every bundled first-party plugin is installed. - Choose whether to download the optional Turboism-managed GraalVM runtime now or install it later from the configurator.
- Review the Cubism installations the installer found, or add one with Import version. If none is found, Turboism still installs and you can configure Cubism later with
configure_turboism.ps1. - On the launch-options page, keep or change the Start-menu shortcut, desktop shortcut, and official Cubism BAT integration choices. BAT integration is pre-selected so existing Cubism shortcuts load Turboism; uncheck it to leave the official BAT files untouched.
- Start Cubism through a Turboism shortcut, an existing Cubism shortcut (with BAT integration), or
launch-cubism-turboism.bat.
Portable ZIP
- Extract the whole archive (
turboism-<version>.zip) into its own folder, not into the Cubism installation directory. - Run
configure_turboism.ps1from that folder and select the Cubism installations. - Start Cubism through the generated shortcut or
launch-cubism-turboism.bat.
See Installer and Portable ZIP for the installer options and package history, including the retired Full/Thin downloads of the 0.67.0 Betas and the legacy assets of 0.44.0 and earlier.
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;
- the top menu is named Turboism (previously "插件"/Plugins);
- the Turboism menu lists: Plugin Market…, Manage Plugins…, Plugin Settings… (a dedicated two-pane window), Check for Updates, Turboism Settings…, Keybindings…, Logs…, plugin actions, and About;
- 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 or manage plugins
Every package already installs all bundled first-party plugins. To add more plugins or manage them:
- Open Cubism and click Turboism → Plugin Market… (or visit turboism.dev/plugins) to browse and install plugins.
- First-party plugins auto-update in the background after signature verification. Plugins marked hot-reload apply immediately; others apply after restarting Cubism. Users can turn off automatic plugin updates in settings.
- Enable or disable installed plugins anytime from Turboism → Manage Plugins…; changes apply after restarting Cubism.
- Configure plugin options in the dedicated two-pane window via Turboism → Plugin Settings….
Local plugin JAR installation
To install a local or third-party plugin JAR:
- Open Turboism and choose Turboism → Manage Plugins….
- Choose Install from JAR….
- Select the local
.jarfile. - 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 executable.
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, or select Turboism → Logs… in the top menu. Keep logs when reporting startup, JAR, dependency, permission, or Provider failures.