Skip to content

Installation

Jump to bottom
Zaldaryon edited this page Jun 27, 2026 · 20 revisions

Installation

Optimum ships as source. You download the source, run the build script for your platform, and the build produces a ready-to-run client on your machine. The build downloads the official Vintage Story client from Anego on your machine and applies the Optimum patches on top, so nothing copyrighted is redistributed.

Requirements

  • .NET 10 SDK
  • git, curl, python3, perl
  • bash (Linux and macOS have it; on Windows use the PowerShell script or installer below)

Download the Source

Grab the source archive for the latest release from the Releases page (the Source code (zip) or Source code (tar.gz) link), then extract it. You can also clone the repository directly:

git clone https://github.com/Zaldaryon/Optimum.git
cd Optimum

Windows (GUI Installer)

The v0.1.1 release includes a GUI installer that handles the full pipeline for you: prerequisite checks, download, decompile, patch, build, package, and install with registry entry and optional Start Menu shortcut.

  1. Download Optimum-Installer-v0.1.1.exe from Releases.
  2. Run the installer. It requests admin for the build process.
  3. Follow the license agreement, click Install, and wait for the build to complete.
  4. Launch Optimum from the desktop shortcut or Start Menu.

If your antivirus flags the .exe (false positive from ps2exe), download install-windows.ps1 instead and run:

powershell -ExecutionPolicy Bypass -File install-windows.ps1

Windows (Manual)

  1. Open the extracted folder.
  2. Run the build script: 
    powershell -ExecutionPolicy Bypass -File build-windows.ps1
  3. The script bootstraps, builds, and packages Optimum-v0.1.1-win-x64/. Run Optimum.exe from that folder.

Linux

  1. Open a terminal in the extracted folder.
  2. Run the build script: 
    ./build-linux.sh
  3. The script produces Optimum-v0.1.1-linux-x64/. Run ./Optimum from inside it.

macOS

  1. Open a terminal in the extracted folder.
  2. Run the build script: 
    ./build-macos.sh
  3. The script produces Optimum.app. Drag it into your Applications folder.

The first build downloads the official client (~570-610 MB) and takes a few minutes. The client launches with your existing account and data, no migration needed.

Data Path

Optimum reads from ~/.config/OptimumVintagestoryData by default (Linux), %AppData%/OptimumVintagestoryData (Windows), or ~/Library/Application Support/OptimumVintagestoryData (macOS). To share your existing vanilla worlds, point Optimum at your vanilla data path with the --dataPath launch argument.

This is Not a Mod

Do not place Optimum files in your Mods folder. Optimum is a standalone client that replaces the engine DLLs. It runs as its own application.

For the full build process and Makefile targets, see Building from Source.

Clone this wiki locally