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

Game.UseNucleusEnvironment

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

Game.UseNucleusEnvironment: boolean

Use custom environment variables for games that use them, replaces some common paths (e.g. AppData) with C:\Users\\<your username\>\NucleusCoop.

Category: Nucleus Co-op Environment

AI-writtenAI-written. Based on: Nucleus GenericGameHandler.cs (opens in a new tab) (the UserProfile/Documents copies need gen.UseNucleusEnvironment; the instance's environment); Verified Hub handlers, counted 2026-11-17 (opens in a new tab); Hub game engines (opens in a new tab).

In practice

Gives each instance its own user profile folders (AppData, Documents) under Nucleus' folder, by changing the environment the game starts with. The handler's Game.UserProfileConfigPath, Game.UserProfileSavePath and Game.DocumentsConfigPath/DocumentsSavePath are only copied there when it is true. Used for games that keep settings or saves in the user's profile, above all Unreal Engine games; rare in Unity games.

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

By engine: rarer in Unity and Source games.

Game.UseNucleusEnvironment = 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