Unreal Editor Workflow

Overview

The Kimura SCM Unreal Engine plugin exposes common Kimura source control actions in the Unreal Editor. It is intended for day-to-day work on files that are already inside a Kimura workspace.

Use the Visual Client for workspace creation, repository links setup, ignore rules, stash workflows, and broader workspace administration. Use the Unreal plugin when you are working inside the editor and need local asset and source file operations.

Connect to Kimura SCM

Before using source control actions, connect the editor to Kimura.

1. Open the Unreal Source Control menu.
2. Select Kimura SCM as the provider.
3. Choose the workspace that contains the current project.
4. Enter the Kimura server address and user credentials.
5. Connect.

After connection, Unreal can request file status, show pending work, and run supported Kimura operations through the editor UI.

Read File Status

The plugin reports source control state through Unreal's normal source control UI.

Files can appear as:

• available for add,
• checked out for edit,
• scheduled for delete,
• modified locally,
• not at the latest revision,
• affected by active operations from other users,
• ignored by Kimura ignore rules.

If status looks stale, use the editor's refresh/status action. For deeper workspace review, open the Visual Client and inspect Workspace changes, Active file operations, and repository state there.

Common File Operations

Use Unreal's source control context menus for routine work.

• Add: mark new files for add so they can be submitted.
• Check Out: mark existing files for edit before changing or saving them.
• Delete: schedule files for deletion through Kimura.
• Revert: cancel pending add, edit, or delete operations.
• Sync: bring selected files to the requested revision or latest available revision.
• Submit: submit selected pending work with a description.

The plugin uses Kimura's checkout model. Checking out a file makes the pending operation visible to other users before submit.

Change Lists

Kimura uses change lists to group pending file operations before submit.

From Unreal's source control UI, the plugin supports:

• creating a change list,
• editing a change list description,
• moving files between change lists,
• deleting an unused change list,
• submitting a change list.

Keep change lists focused on one task or fix when possible. This makes reviews, history, and team coordination easier.

History and Diff

The plugin supports file revision queries and diff against depot where Unreal exposes those actions.

Use these actions to inspect previous revisions or compare a local file with the revision stored in Kimura. For broader history review across folders or repositories, use the Visual Client's History tab.

What to Do in the Visual Client

Some Kimura workflows are better handled outside Unreal.

Use the Visual Client for:

• creating and switching workspaces,
• editing repository links (repository map),
• managing .kscmignore rules,
• reviewing full workspace state,
• using stash workflows,
• resolving larger workspace setup issues.

The Unreal plugin assumes the workspace already exists and is correctly mapped for the project.

Beta Limitations

This beta documentation describes the current plugin behavior.

• The local bridge to kscm.exe is Windows-based.
• Rename, copy, and move workflows are not documented as supported editor behavior in this version.
• Stashes are not exposed through the Unreal plugin; use the Visual Client or KSCM CLI.
• Workspace and repository links setup should be done before connecting from Unreal.