Kimura SCM

Appearance

Unreal Engine Plugin Setup ​

Overview ​

The Kimura SCM Unreal Engine plugin adds Kimura as a source control provider inside the Unreal Editor. It connects the editor to a Kimura server through an existing workspace, so artists and developers can perform common source control actions without leaving Unreal.

This beta setup documents the current plugin behavior for version 0.8.x.

As of today, version 0.8.x is compatible with Unreal Engine 5.7 and 5.8.

Info: During beta releases, version checks are intentionally strict. Match the Unreal plugin, the installed Kimura SCM command-line bridge, and the Kimura server to the same beta minor version. For example, the 0.8.x plugin is not compatible with a Kimura server running 0.9.x.

Prerequisites ​

  • Windows.
  • Unreal Editor (5.7 or 5.8 for plugin version 0.8.x).
  • Kimura SCM installed on the same machine as the editor.
  • A compatible kscm.exe installed by Kimura SCM.
  • A Kimura user account with access to a workspace containing the project.
  • A working C++ Unreal build environment capable of compiling the project and plugin modules.

The plugin looks for kscm.exe at the current Kimura SCM installation path and starts it as a local bridge. Users do not normally run that bridge manually from the editor workflow.

Fetch the Plugin Source ​

Retrieve the Kimura Unreal plugin source from the KimuraSCM GitHub repository.

  1. Clone or sync the plugin repository from GitHub to a local folder.
  2. Confirm the plugin source includes KimuraSourceControl.uplugin, Source/, and Resources/.

Install as a Project Plugin ​

Install the plugin inside the Unreal project so the project carries its source control dependency.

Info: In the current beta release, the plugin is distributed as source and must be built alongside your C++ Unreal project. Future releases are expected to be distributed through Epic's Fab marketplace.

The plugin can also be installed as an engine plugin if needed, but this guide focuses on the project-plugin workflow.

  1. Close Unreal Editor.

  2. Create a Plugins directory beside the project .uproject file if it does not already exist.

  3. Copy the plugin into:

    text
    <Project>/Plugins/KimuraSourceControl/

  4. Confirm that this file exists:

    text
    <Project>/Plugins/KimuraSourceControl/KimuraSourceControl.uplugin

    The source repository for the plugin may be checked out under a different folder name. The important part is that KimuraSourceControl.uplugin, Source/, and Resources/ are in the same plugin directory.

  5. Regenerate project files/solution for the Unreal project.

  6. Compile the C++ project and the Kimura plugin modules.

  7. Open the project in Unreal Editor.

If your team versions the Kimura plugin in its own repository, map that repository to the project plugin path through a repository link. For the full multi-repository workflow, see Native Unreal Project Setup.

Enable Kimura SCM in Unreal ​

After the project opens, enable Kimura as the source control provider.

  1. Open the Source Control menu in Unreal Editor.
  2. Choose the provider named Kimura SCM.
  3. Open the provider settings.
  4. Fill in the connection fields.
  5. Connect.

If the provider is not available, confirm that the plugin loaded and that Kimura SCM is installed on the machine.

Connection Fields ​

The settings panel uses the current project path to find matching Kimura workspaces.

  • Workspace: the workspace to bind to this Unreal project. The list is filtered to workspaces whose root contains the current project path.
  • Server address: address of the Kimura server, including host and port, for example HOSTMACHINE:8666.
  • User: the user's login name.
  • Password: Kimura password for the selected user.
  • Verify server certificate: require the server to provide a trusted certificate before connecting.
  • Client certificate: optional client certificate selection. Choose None, From Store (certificate thumbprint), or From PFX file.

When using a PFX client certificate, provide the PFX file path and password. When using the certificate store option, provide the certificate thumbprint.

Workspace Requirements ​

For a workspace to be visible in Unreal integration, the Unreal project only needs to be somewhere under that workspace root path; it does not need to be at the workspace root itself.

Troubleshooting ​

Kimura SCM Provider Does Not Appear ​

Confirm that KimuraSourceControl.uplugin is inside the project Plugins/KimuraSourceControl directory and that Unreal rebuilt the plugin successfully.

Kimura SCM Is Not Available ​

The plugin depends on the kscm.exe command-line bridge at the current Kimura SCM installation path. Reinstall or repair Kimura SCM if the plugin cannot find the installed bridge.

Incompatible Version ​

The plugin version is 0.8.x. If the editor log reports an incompatible version, update the Unreal plugin, Kimura SCM installation, or Kimura server so they use compatible beta versions. A 0.8.x plugin should not be used against a 0.9.x server.

No Workspace Appears in the List ​

The workspace list is filtered by the current Unreal project path. Confirm the project is under the workspace root path, then reopen the provider settings.

Connection Fails ​

Check the server address, user name, password, certificate settings, and network access to the Kimura server. If the same account cannot connect from the Visual Client, fix that connection first.