Getting Started

This walkthrough introduces the three Locus workspaces without requiring source control or an online account.

1. Open Locus

Open Window > Locus, use the Locus button in the Content Browser toolbar, or press Ctrl+Shift+L. The top navigation switches among Notes, Pins, and Documents. The Settings button is at the right side of the main toolbar.

2. Create a Note

Open Notes, choose New Note, and select a scope:

• Shared stores a .uenote file under <Project>/ProjectNotes/ for project collaboration.
• Private stores it under <Project>/Saved/Locus/PrivateNotes/ for the current local project workspace.

Give the Note a useful title, enter body text, and optionally add tags or rich Asset, Pin, Note, Document, and Actor references. Notes save automatically after a short editing delay. Press Ctrl+S to save immediately or retry a failed save.

Learn about folders, search, recovery, and conflicts in Notes.

3. Place a Pin

Open a saved level, switch to Pins, and choose a Shared or Private placement action. Click a surface in the level viewport to place the Pin; press Esc to leave Placement Mode.

A Pin can contain a title, body, tags, type, Open or Resolved status, assignee, comments, a saved viewport view, and one optional Snapshot. It is stored in a .locuspin file outside the map. Placing or editing a Pin does not add an Actor or dirty the map package.

See Pins for viewport controls, saved views, and visibility settings.

4. Create a Document

Switch to Documents. Create beneath Locus Documents for a Locus-only Markdown file, or beneath Content Browser for a Document mapped into the corresponding /Game folder. Both are project-owned .md files beneath <Project>/ProjectDocuments/; the roots clarify presentation without creating separate repositories. New Documents begin Untracked, so you can organize, rename, move, and edit them before choosing Mark for Add when their path is final.

Documents use explicit save: press Ctrl+S. Edit shows the Markdown source, Read presents supported Markdown with native Unreal UI, and Split Preview renders the current editing buffer beside the source. Multiple Documents can be open at once.

See Documents for Content Browser mapping, import/export, and Markdown limitations.

5. Understand Local Mode

Source control is optional. If Unreal has no configured provider, Locus uses Local Mode for legitimate local and untracked editing without provider operations and omits source-control-specific UI. With a provider configured, new Shared Notes retain their post-create add request; new Shared Pins and Documents remain Untracked until you explicitly choose Mark for Add. Existing depot-controlled content remains protected when its provider is unavailable. Private content never contacts the provider.

Read Source Control before introducing Locus files into a collaborative repository.

6. Adjust your workspace

Open Settings to change appearance, editor presentation, font sizes, wrapping, tree density, workspace restoration, and Pins presentation. Reset actions affect UI state, not content. See Settings and Appearance.

7. Connect an MCP client (optional)

Locus can optionally connect a compatible local MCP client to supported Notes, Documents, Pins, and status information while Unreal Editor is open. It does not include an autonomous AI assistant; the connected client performs the AI workflow. Start with MCP Integration when you are ready to set it up.

To report an issue or suggestion, choose Give Feedback in Locus or visit the feedback site.