Installation

Turboism is installed with an installer package. Two installers exist: the Windows-native TurboismInstaller-<version>.exe and the cross-platform TurboismInstaller-<version>.jar, which installs on Windows and macOS with a Java 17+ runtime. Ordinary users install with one of these installer packages; building from source is developer and maintainer work.

Neither installer modifies Cubism JARs, DLLs, official launcher files, licensing state, or existing projects.

Choose an installer

• On Windows, use the .exe installer. It is the native path: per-user, no administrator rights, with the Windows configurator and Start Menu integration.
• On Windows or macOS, use the .jar installer when you prefer one installer file across platforms. It requires Java 17+ and runs with java -jar TurboismInstaller-<version>.jar.
• Installer files must come from the release or preview channel that provided your build. Turboism does not currently publish public download assets for these installers.
• The installer JAR is separate from plugin JARs. Plugins are managed through Plugin Management, not through this installer.

Windows .exe installer

TurboismInstaller-<version>.exe is the Windows-native NSIS installer.

• Runs per-user and requests no administrator elevation.
• Installs to %LOCALAPPDATA%\Turboism by default; you can choose another directory.
• Offers Lite and Full modes. Full installs the first-party plugins; Lite installs only the agent and common files.
• Full mode lets you deselect individual plugins before installing.
• Adds per-user Start Menu entries and registers uninstall in the current user's Programs and Features.
• Opens configure_turboism.ps1 after installation so you can configure Cubism roots and managed launch entries.
• Writes uninstall.exe for later removal.
• Does not modify Cubism installation files.

Cross-platform .jar installer (Windows/macOS)

TurboismInstaller-<version>.jar is the IzPack-based installer for Windows and macOS.

• Requires Java 17 or newer.
• Run it with:

java -jar TurboismInstaller-<version>.jar

• Default install location: %LOCALAPPDATA%\Turboism on Windows; ~/Library/Application Support/Turboism on macOS. You can choose another directory.
• Offers the same Lite/Full modes as the .exe installer: Full installs the first-party plugins, Lite installs only the agent and common files, and Full lets you deselect individual plugins.
• Rerunning the installer updates the same Turboism home and plugin selection without blindly overwriting unrelated configuration.
• Uninstalls on both platforms through the generated uninstaller.

macOS packaging and uninstall are in Preview: they are verified on Apple Silicon and Intel packaging lanes, but macOS Cubism host launch and readiness are not verified and no macOS Cubism launcher is installed. On macOS, this installer can install and uninstall Turboism, but it does not yet provide a verified way to launch Turboism inside Cubism.

After installation

1. On Windows, run configure_turboism.ps1 in the Turboism home. It discovers supported Cubism 5.2/5.3 roots and creates one managed launch entry per selected root. Canceling the configurator leaves a valid framework-only install.
2. Start Turboism through the managed launcher for your Cubism root (launch-cubism-turboism.bat on Windows).
3. Confirm that Turboism starts and writes diagnostics in the Turboism home.
4. Install plugins through Plugin Management, which stages JARs and applies them after Cubism restarts.

Uninstall

• Windows installation created by the .exe installer: run uninstall.exe in the Turboism home directory. The confirmation asks whether to keep config.json.
• Windows installation created by the .jar installer: run

java -jar <home>\Uninstaller\uninstaller.jar

• macOS installation created by the .jar installer: double-click uninstall.command in the home directory, or run it in a terminal.

The uninstaller removes installer-owned files and the runtime logs, state, and cache data. Unknown files and third-party plugin JARs are preserved; config.json is removed only when you choose to delete it.

Developers and maintainers

Building Turboism from source and building installer packages is developer and maintainer work. Source, framework, and installer builds belong to developer or maintainer workflows and are intentionally excluded from this user guide.

Current limitations

• macOS Cubism host launch is not verified, and no macOS Cubism launcher is installed.
• Installer packages are not yet signed or notarized, and there is no public download channel.
• There is no automatic online updater: updating means rerunning a newer installer.
• Failed plugin replacements are protected by internal backup/restore, but a complete user-facing repair or history UI does not exist yet.
• Feature readiness remains capability- and version-specific.