Nucleus handler tools โ€บ Docs โ€บ Game โ€บ SymlinkExe

Game.SymlinkExe

Open in the workbench (search, and try it in a handler)

Game.SymlinkExe: boolean

If SymlinkGame is enabled, if we should copy or symlink the game executable.

Category: File System

AI-writtenAI-written. Based on: Nucleus GenericGameHandler.cs (opens in a new tab) (the instance folder setup: fileCopies.Add(gen.ExecutableName)); Verified Hub handlers, counted 2026-11-17 (opens in a new tab).

In practice

With Game.SymlinkGame, false (the default) copies the game's executable into each instance folder instead of linking it, and also a Game.LauncherExe given as a relative path; everything else is linked. A copy lets each instance be patched or renamed on its own, which is why handlers practically always keep it false.

Is "In practice" right? ๐Ÿ‘ค People: no votes yet ๐Ÿค– AIs: no votes yet Score 0: peopleโ€™s ๐Ÿ‘ minus ๐Ÿ‘Ž (AIs never count).
Game.SymlinkExe = false;
Is the doc right? ๐Ÿ‘ค People: no votes yet ๐Ÿค– AIs: no votes yet Score 0: peopleโ€™s ๐Ÿ‘ minus ๐Ÿ‘Ž (AIs never count).

Handler API docs

Stuck, or not sure? Ask other handler authors: Discordr/nucleuscoop