Installation

Install Turboism from a published release package without modifying a Cubism installation.

Turboism is distributed through GitHub Releases and the official download mirror at turboism.dev/download. Every package ships with a matching .sha256 checksum file. Building Turboism from source is developer and maintainer work and is not required for ordinary use.

No package modifies Cubism JARs, DLLs, licensing state, or existing projects. Official Cubism startup BAT files change only through the Windows installer's official BAT integration option, which is pre-selected, hash-guarded, and restored on uninstall.

Installers are currently unsigned. Verify the downloaded file against its checksum before running it.

Choose a package

Since 0.67.0 Stable, Turboism provides exactly two product downloads:

PackagePlatformPurpose
TurboismInstaller-<version>.exeWindowsGuided NSIS installer. Recommended on Windows.
turboism-<version>.zipWindows (manual setup), macOS, LinuxPortable archive for manual setup.

Both packages include the runtime, every bundled first-party plugin, and the complete offline GraalJS engine. Installing a GraalVM runtime remains a separate, optional step. See Installer and Portable ZIP for a comparison and the installer options.

The 0.67.0 Beta releases (0.67.0-beta.3 to 0.67.0-beta.7) temporarily used a four-download Full/Thin layout, which is retired. Releases 0.44.0 and earlier used legacy assets: a single Windows installer (TurboismInstaller-<version>.exe), a cross-platform Java installer (TurboismInstaller-<version>.jar), and portable archives (turboism-<version>-full.zip and turboism-<version>-lite.zip). The Java installer is no longer published; macOS and Linux use the portable ZIP.

All formats carry the same release version. Use the channel that provided your build: see Release Channels and the three JSON feeds under api.turboism.dev.

Supported environments

  • 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. Unlisted Editor versions are not claimed compatible, and unavailable adapters or features fail closed.
  • A supported Editor version does not mean every plugin feature is available on that version.
  • macOS packaging is preview-only: macOS Cubism host support is not verified and no macOS launcher is installed.
  • Linux coverage is limited to installer and payload behavior; Linux is not a supported Cubism host.

Installer languages

Every Turboism installer ships in English, Simplified Chinese, Japanese, and Korean.

  • The EXE wizard shows a language selection dialog before the welcome page and lists all languages regardless of host language.
  • The installer language affects only the installer itself and is never written to config.json.
  • The language Turboism uses at runtime comes from the runtime locale setting in config.json, and plugin interface language follows Cubism Editor's File → Environment Settings → General → Language.

Bundled plugins

Every package installs all bundled first-party plugins; there are no mode or per-plugin selection pages. Plugins can be enabled or disabled later in Cubism via Turboism → Manage Plugins…, and additional plugins are available from the in-Cubism Plugin Market (Turboism menu → Plugin Market…) or turboism.dev/plugins.

First-party plugins auto-update in the background after signature verification. Plugins marked hot-reload apply immediately, while others apply after restarting Cubism. Users can turn off automatic plugin updates in settings.

The development-only Turboism with fx plugin and managed fx runtime bytes are not part of any release package.

Required acknowledgements

The installer gates installation behind four explicit acknowledgements and a full localized runtime declaration. The acknowledgements cover Turboism's independent third-party identity, lawful Cubism authorization, independent backups before authorized content-changing automation, and open-source as-is operation without compatibility or recovery guarantees.

Windows .exe installer

Run TurboismInstaller-<version>.exe. It is the recommended path on Windows:

  • Runs per-user. Only the official Cubism BAT integration step elevates through UAC.
  • Installs to %LOCALAPPDATA%\Turboism by default; you can choose another directory.
  • Offers the optional Turboism-managed GraalVM runtime download (install now or later).
  • Scans for installed Cubism Editors and lets you import another installation folder; if none is found, Turboism can still be installed and configured later.
  • Lets you choose Start-menu shortcuts, a desktop shortcut, and official Cubism BAT integration. BAT integration is pre-selected and can be unchecked; it is hash-guarded, idempotent, and restored on uninstall.
  • Registers uninstall in the current user's Programs and Features.
  • Upgrades existing installations: rerunning a newer installer installs the current first-party plugins and keeps existing disabledPlugins disabled.
  • Writes uninstall.exe for later removal.
  • Does not modify Cubism JARs, DLLs, or licensing state.

Portable ZIP packages

On Windows (manual setup), macOS, and Linux:

  1. Download turboism-<version>.zip, which includes the runtime and every bundled first-party plugin.

  2. Extract the whole archive into a separate Turboism folder, never into the Cubism installation directory.

  3. From the extracted folder on Windows, run 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.

  4. Start Cubism through the generated Turboism shortcut or launch-cubism-turboism.bat in that folder.

ZIP manual installs have no uninstaller and do not enable official-BAT integration: close Cubism and delete the Turboism directory to remove them.

Verify the download

Each package has a .sha256 sidecar with the same filename plus .sha256. For example, in PowerShell:

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

Compare the result with the published value. A SHA-256 checksum proves file integrity; it is not a code-signing certificate.

After installation

  1. On Windows, use configure_turboism.ps1 in the Turboism home (or the Turboism_Configurator Start-menu entry) to add or change Cubism installations. It creates one managed launch entry per selected root. Saving zero installations leaves a valid framework-only install.
  2. The Windows installer applies official Cubism BAT integration unless you unchecked it. It records a hash-guarded backup; later user edits to those files become conflicts and preserve state for retry. ZIP manual installs do not enable it.
  3. Start Cubism through a Turboism shortcut, an existing Cubism shortcut when BAT integration is applied, or the managed launcher for your Cubism root (launch-cubism-turboism.bat on Windows).
  4. Confirm that Turboism starts and writes diagnostics in the Turboism home.
  5. In Cubism, use the top Turboism menu to access the Plugin Market…, Manage Plugins…, Plugin Settings…, Check for Updates, and other features.

Uninstall

  • Windows installation created by the .exe installer: run uninstall.exe in the Turboism home directory. It removes only Turboism's recorded managed shortcuts, states, and owned files. The uninstaller confirmation offers a checkbox to keep config.json (checked by default). It deletes only installer-deployed first-party plugin JARs; unknown files and third-party plugin JARs are preserved. Applied official BAT integration is restored from its hash-guarded backup.
  • ZIP manual installs: close Cubism and delete the Turboism directory.
  • Legacy installations (0.44.0 and earlier): installations made with the retired Java installer used java -jar <home>\Uninstaller\uninstaller.jar on Windows/Linux or uninstall.command on macOS.

Current limitations

  • Installer packages are not signed or notarized.
  • macOS Cubism host support is not verified, and no macOS launcher is installed.
  • There is no automatic framework installer update: Turboism checks for updates, but framework updates require running a newer installer or extracting a newer ZIP.
  • Feature readiness remains capability- and version-specific.