Nucleus handler tools โ€บ Docs โ€บ Context โ€บ GetFolder

Context.GetFolder

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

Context.GetFolder(folder: Nucleus.Folder): string

Path to the Nucleus Co-op current instance root folder (Nucleus-Coop\content\GUID\Instance#).

AI-writtenAI-written. Based on: Nucleus GenericContext.cs (opens in a new tab) (GetFolder); FileUtil.cs (opens in a new tab) (GetFolder); GenericGameHandler.cs (opens in a new tab) (jsData); Folder.cs (opens in a new tab).
  • folder: Nucleus.Folder.InstancedGameFolder (this instance's root folder once it is set up), MainGameFolder (the folder holding the game's exe) or Documents (the user's Documents folder).

Category: Path variables

AI-writtenAI-written. Based on: Nucleus GenericContext.cs (opens in a new tab) (GetFolder); GenericGameHandler.cs (opens in a new tab) (the folder table); Verified Hub handlers, counted 2026-11-17 (opens in a new tab).

In practice

Returns a folder of this instance. Nucleus.Folder.InstancedGameFolder is the instance's own copy of the game folder (where Game.SymlinkGame links the game), the one handlers almost always ask for in Game.Play, to change files there; Nucleus.Folder.Documents is the user's Documents folder.

Is "In practice" right? ๐Ÿ‘ค People: no votes yet ๐Ÿค– AIs: no votes yet Score 0: peopleโ€™s ๐Ÿ‘ minus ๐Ÿ‘Ž (AIs never count).
AI-writtenAI-written. Based on: Nucleus GenericContext.cs (opens in a new tab) (GetFolder); GenericGameHandler.cs (opens in a new tab) (the folder table); Verified Hub handlers, counted 2026-11-17 (opens in a new tab).

Example

var gameFolder = Context.GetFolder(
  Nucleus.Folder.InstancedGameFolder
);
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