Use the WVS-Plugin for Unreal

This page shows you how to install and use the WVS-Plugin for Unreal so that you can use WVS as a version control and collaboration framework in Unreal Editor.

Using the plugin lets you create and submit changelists without leaving the Unreal Editor. Additionally, when you save changes to your project in Unreal Editor, the editor prompts you on which files you need to check out so you don’t have to find them manually.

Supported Unreal Engine versions

  • UE4.26
  • UE4.27
  • UE5.0

Prerequisites

To follow the instructions on this page, you must have the following:

  • The latest WVS Desktop client is installed and initialized.
  • Unreal Engine is installed.
  • A WVS Unreal project is set up and cloned.

Install the WVS-Plugin for Unreal

You can install the WVS-Plugin for Unreal to your project or you can install it to Unreal Editor. Installing the plugin to your project enables the plugin for that project only. Installing the plugin to Unreal Editor enables the plugin for all projects.

  1. Download the WVS-Plugin for Unreal.

  2. Ensure that Unreal Editor is not running.

  3. Navigate to the directory of your WVS Unreal project on your workstation.

  4. Create a Plugins directory and copy the UE4WVSPlugin folder into it. For example:

    C:\wvsProjects\ue4-shootergame\Plugins\UE4WVSPlugin
    
  5. Open your WVS Unreal project using Unreal Editor.

  6. In the Unreal Editor toolbar, click Source control > Connect to source control…

  7. Click the Provider dropdown and select WVS.

    Your login information is populated once WVS is connected.

  8. Click Accept settings to complete the installation.

  1. Download the WVS-Plugin for Unreal.

  2. Ensure that Unreal Editor is not running.

  3. Navigate to the directory where Unreal Editor is installed. The default installation location is:

    C:\Program Files\Epics Games\<UE_VERSION>\Engine\Plugins\Editor
    
  4. Copy the UE4WVSPlugin directory into the Unreal Editor directory. For example:

    C:\Program Files\Epics Games\UE_4.27\Engine\Plugins\Editor\UE4WVSPlugin
    
  5. Open your WVS Unreal project in Unreal Editor.

  6. In the Unreal Editor toolbar, click Source control > Connect to source control…

  7. Click the Provider dropdown and select WVS.

    Your login information is populated once WVS is connected.

  8. Click Accept settings to complete the installation.

Select a branch

You must select the branch that you want to work on before opening your project in Unreal Editor. Changelists that you create using the plugin are pushed to the selected branch.

To select a branch, use the Desktop Client or the wvs CLI tool:

To select a branch using the Desktop Client, perform the following steps:

  1. Select the project that you want to work on:
    1. Click My projects.
    2. Select the project that you want to work on.
    3. Click Switch project.
  2. Click the branch dropdown menu next to your project name and select the branch that you want to work on.

To set the branch that you want to work on using the wvs CLI tool, perform the following steps:

  1. Navigate to your project folder. For example:

    C:\wvsProjects\ue4-shootergame
    
  2. Run the following command:

    wvs branch set <BRANCH_NAME>
    

    Replace <BRANCH_NAME> with the name of the branch that you want to set.

    Note: You can get a list of existing branches by running wvs branch list.

Update the WVS-Plugin

Check back to the plugin download page for new versions of the plugin. Download the new plugin package and replace the plugin files in the Plugins directory.

Create a changelist

To create a changelist, check out the files that you plan to change and a changelist is automatically created. After making changes to those files, you can submit the changelist to your WVS Unreal project.

Check out (lock) files

To prevent others on your team from making changes to a file that you’re working on, you can lock it by checking it out. In Unreal Editor, only checked-out files can be added to a changelist and submitted. To check out a file, choose one of the following methods.

Check out a file that you plan to change

In Unreal Editor, right-click on a file that you want to check out and click Source control > Check out.

Check out multiple changed files

  1. In the Unreal Editor toolbar, click Source control > Check out modified files…

    A popup window appears containing a list of files that you’ve changed.

  2. Optional: Deselect any files that you don’t want to check out from WVS.
  3. Click Check out selected to check out the selected files.

Submit a changelist

To create and submit a changelist after you’re done making changes, perform the following:

  1. In the Unreal Editor toolbar, click Source control > Submit to source control…
  2. Enter a description of the changelist in the Changelist description textbox.
  3. Optional: Under the Changelist description textbox is a list of files that you’ve changed and are automatically added to the changelist. If you want to exclude any of these files from the changelist, deselect the checkbox next to the file.
  4. Optional: If you want to keep the files in the changelist checked out after you submit the changelist, select Keep files checked out.
  5. Click Submit to submit your changes.

Check the changelist history of a file

To view a list of all changelists where a file is changed, right-click on the file and click Source control > History. This opens the File history window, which lists all changelists involving the file. You can click on a changelist to get the details of that changelist.

Check the differences with the previous changelist

To check the changes made to a file in a changelist, in the File history window, right-click on a changelist and click Diff against previous revision.

Revert changes

You can revert the changes that you’ve made to a single file or revert all changes.

Revert changes to individual files

To revert the changes that you’ve made to a file since the file was checked out, right-click on the file and click Source control > Revert.

Revert all changes

To revert all changes that you’ve made, in the Unreal Editor toolbar, click Source control > Revert.

Next steps