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 asset 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, comments, and a type. 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 and create a Document. Locus creates a project-owned .md file beneath <Project>/ProjectDocuments/ and opens it in a dedicated editor tab.

Documents use explicit save: press Ctrl+S. Edit Mode shows the Markdown source; Read Mode presents supported Markdown with native Unreal UI. 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 active provider, Locus works in Local Mode and edits local files without provider operations. With a provider active, Shared Notes, Shared Pins, and project-owned Documents use provider-aware checkout, add, and delete safeguards. 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.

The inspected plugin revision does not yet include an Editor Documentation command. Use this website directly. To report an issue or suggestion, choose Give Feedback in Locus or visit the feedback site.