Skip to content
Search

Installation

Locus is an Editor-only Unreal Engine plugin. Choose either Fab installation or a matching precompiled binary package.

  • Use the Locus release built for the exact Unreal Engine version used by the project. A package built for another Engine version may fail to load.
  • Current validation is for Win64. macOS and Linux are not currently advertised as supported platforms.

When installing through Fab or the Epic Games Launcher, select the Locus version for the Unreal Engine version you intend to use. Manual copying of plugin files is not required.

  1. Open the target project in Unreal Editor.
  2. Open Edit > Plugins and enable Locus if it is not already enabled.
  3. Restart Unreal Editor if prompted.

After restart, open Locus from Window > Locus, the Locus button in the Content Browser toolbar, or Ctrl+Shift+L.

Install a precompiled binary package manually

Section titled “Install a precompiled binary package manually”

Manually distributed Locus packages include the required precompiled binaries for their supported Unreal Engine version. Select the package built for the exact Engine version you intend to use.

Before copying or replacing plugin files, close Unreal Editor. Copy the complete Locus plugin directory; do not copy only Binaries, and do not merge files from packages built for different Engine versions.

Copy the complete Locus plugin folder into:

<ProjectRoot>/Plugins/Locus/

Create the project’s Plugins directory if it does not exist. This makes Locus available to that project and keeps the plugin version associated with it, which is useful when different projects require different Locus or Engine versions.

Copy the complete Locus plugin folder into:

<UnrealEngineRoot>/Engine/Plugins/Marketplace/Locus/

This makes Locus available to projects opened with that specific Unreal Engine installation and avoids copying the same package into each project. It does not install Locus into other Engine versions. Enable Locus separately in each project where it will be used.

  1. Reopen the project in the exact matching Unreal Engine version.
  2. In Edit > Plugins, find Locus and enable it if it is not already enabled.
  3. Restart Unreal Editor when prompted.

Open Locus from Window > Locus, the Locus button in the Content Browser toolbar, or Ctrl+Shift+L.

An officially supplied matching precompiled binary package does not require you to generate project files, compile Locus, rebuild the plugin, open Visual Studio, or modify .Build.cs files.

Locus creates storage as each content type is used:

Content Project-visible location
Shared Notes <Project>/ProjectNotes/
Shared Pins <Project>/ProjectPins/
Documents <Project>/ProjectDocuments/
Private Notes and Pins, recovery, and personal project UI state <Project>/Saved/Locus/ and related recovery folders under <Project>/Saved/

See Notes, Pins, and Documents for their exact ownership rules.

Disabling or removing the plugin stops its Editor UI; it does not intentionally delete the external files listed above. Back up the project before uninstalling a plugin, and decide separately whether retained Locus data should stay in the project or source-control repository.

Locus has Editor-only modules and does not add a runtime system to packaged games. Its external Notes, Pins, and Documents are not UAssets and are not automatically cooked as game content.

Next, follow Getting Started.