Create a new WVS Unreal or Unity project

This page shows you how to create a new Unreal or Unity project on WVS. For information on importing an existing project onto WVS, see Import projects.

The process for creating a project is as follows:

flowchart TD; id1[Create a WVS project] --> id2[Clone the WVS project]; id2 --> id3[Create a changelist]; id3 --> id4[Create project folder in the clone directory]; id4 --> id5[Create a Unreal/Unity project to the project folder]; id5 --> id6[Commit changelist]

Prerequisites

To perform the steps on this page, ensure the following:

  • Complete the tasks in Prepare to use WVS and make sure you’re signed in to wvs.io.
  • Have an Unreal or Unity account.
  • Have Unreal Editor or Unity Editor installed.

Create a blank project

  1. Go to the WVS projects dashboard.

  2. Click the New project button.
  3. Click Create from template.
  4. Next to the blank template for your game engine of choice, click Use template.
  5. Configure your project as follows:
    • Project name: Give a name for your project.
    • Project URL: Select a project namespace. The project namespace can be any group or user that you have access to. Selecting a group gives every member of that group access to the project.

    • (Optional) Project slug: Enter a slug for your project. A project slug is a human-readable identifier for your project. The project namespace and slug form the URL of your project as follows: 

      https://wvs.io/namespace/slug/

      If you don’t enter a project slug, WVS uses the name of your project and replaces any spaces with dashes.

    • Project description: Enter an optional description of your project. The project description is often displayed under the project name in various clients and interfaces.
    • Visibility level: Select a visibility level for the project. The visibility levels are defined as follows:
      • Private: All users must be explicitly granted access to the project. If the project is created under a group namespace, all members of the group have access to the project.
      • Internal: Only signed-in WVS users can access the project.
      • Public: Anyone, including non-WVS users, can access the project, including viewing files, cloning the project, and viewing output pages.

  6. Click Create project.

    After the project is created, the project is opened in the WVS Web Client.

Clone the blank project

Cloning a project means downloading the project from the WVS project repository to your local workstation so that you can work on that project.

You can clone your blank project by using the WVS Desktop Client or the wvs command line (CLI) tool.

To clone your new project using the WVS Desktop Client, perform the following:

  1. Open the WVS Desktop Client.
  2. Click Remote projects.
  3. Select your new project and click Clone project.
  4. Select the directory to save the project, for example, C:\wvsProjects.
  5. Click Clone project.
  6. Select the desired local destination to store your local project and click Clone Project.

To clone your forked project using the wvs CLI tool, run the following command: 

wvs project clone --sshUrl SSH_URL

Replace SSH_URL with the SSH URL of your project. You can copy the SSH URL of your project by performing the following steps:

  1. Go to your project home page.
  2. Click Clone.
  3. Copy the URL under Clone with SSH.

Create a changelist

After your Unreal or Unity project is created, you can push the newly added files to the project repository on WVS by creating and submitting a changelist. You can create and submit changelists by using the WVS Desktop Client or the wvs CLI tool.

To create a new changelist by using the WVS Desktop Client, perform the following steps:

  1. Open the WVS Desktop Client.
  2. Click My projects.
  3. Select your new project and click Switch project.
  4. Click New Changelist.
  5. In the New Changelist field, enter a name for the changelist.
  6. Click Start changelist.

After the changelist is committed, your new Unreal or Unity project is now in your WVS project repository. You are ready to work on your new project.

To create a changelist using the wvs CLI, run the following command: 

wvs changelist begin CHANGELIST_NAME

Replace CHANGELIST_NAME with the name you want to give the changelist.

Create a project directory

In the directory on your workstation where you cloned your new project, create a new directory for your project files. For example, if your project is cloned in C:\wvsProjects\UE5shooter, the new directory could be something like C:\wvsProjects\UE5shooter\ProjectFiles.

Create a new project in Unreal or Unity

Create a new project in Unreal or Unity, ensuring the following:

  • The game engine you’re using matches the template that you used when creating your WVS project.

    For example, when creating your project in WVS, if you chose the template Blank (Preconfigured for Unreal Engine), then your WVS repository can only support Unreal projects.

  • Create the project in the project directory of your cloned project that you created in the previous step. From the example, it’s C:\wvsProjects\UE5shooter\ProjectFiles.

Push your project files to WVS

To push your project files to your WVS repository, commit your changelist by performing the following steps:

  1. In the Modified Files section, ensure that your newly added project files are listed.
  2. Click Commit changelist.
  3. Click Push changelist.
  4. Confirm that your project files are in your WVS project repository.

After the changelist is committed, your new Unreal or Unity project is now in your WVS project repository. You are ready to work on your new project.

  1. Check that your project files are included in the changelist by running the following command: 

    wvs project status

    You should see your project files listed under Current Changlist.

  2. To commit the changelist, run the following command: 

    wvs changelist finish
  3. Confirm that your project files are in your WVS project repository.

After the changelist is committed, your new Unreal or Unity project is now in your WVS project repository. You are ready to work on your new project.

Next steps

Report a problem with this page.