Getting started with Helix Core for administrators

If you are the Helix Core administrator, you need to deploy Helix Core Server, configure it, work with versioned files, and set up end users. If you are using Helix Core with Unreal Engine or Unity 3D, you will complete additional steps.

Complete the following steps to set up Helix Core for your team.

1. Plan your Helix Core deployment.

   If you are the Helix Core administrator, you need to deploy Helix Core Server and configure it for your team. The first step is to decide if you want to manage Helix Core or have it managed by someone else. Then, you can decide how and where to host Helix Core.

2. Deploy Helix Core.

   If you choose to manage your Helix Core deployment yourself, follow the corresponding instructions to deploy on your preferred platform. If you choose for someone else to manage your deployment, sign up for the offering and follow instructions in the provided resources to get started.

3. Download and install P4V and other client applications.

   Download and install Helix Core Visual Client, called P4V for short. As part of P4V installation, you will also install the Helix Core Visual Admin Client (P4Admin). You will use P4V and P4Admin to configure security and add users.

4. Configure an administrative user for P4V for Windows (on-premises deployments only).

   If you installed Helix Core Server for Linux, you configured an administrative user as part of installing the server. If you installed Helix Core Server for Windows, you need to complete a few more steps to configure an administrative user.

5. Configure security.

   Configure password security, restrict creating users to the administrator, and restrict viewing the list of Helix Core users to the administrator.

6. Configure typemap settings.

   By setting up a typemap, you can ensure that Helix Core Server handles files with specific extensions or files in specific folders in a specific way.

7. Create a stream depot.

   A depot is the highest level of organization on a Helix Core Server. Create a stream depot, which is a container for streams.

8. Create a mainline stream.

   Streams are the preferred way to handle branching and merging in Helix Core. They provide a framework to manage concurrent development and track relationships visually across branches. You must create at least one stream for each depot you create.

9. Create a workspace.

   A workspace is a crucial link between a stream and a team member’s device. It provides access to the files you need to work on. Every Helix Core user on your team will create one or more workspaces, making them an essential part of your version control workflow.

10. Configure ignored files.

    It is best practice to ignore (not version) some files for security or performance reasons. You can specify ignored paths at the stream level or by using a p4ignore file.

11. Add and work with versioned files.

    Add new files to your workspace to submit to Helix Core Server and edit files already under version control.

12. Set up and use game engine integrations (optional).

    If you are working with Unreal Engine or Unity 3D, you can either submit changes to assets in P4V or by using the source control menu built into your game engine.

13. Add users.
    

    Before end users can work with assets in Helix Core, you must create and configure users.

14. Onboard your team.

    Send credentials and a link to Getting started with Helix Core for end users to your team.

What's next

Next, choose a deployment path for Helix Core.

Go to Step 1: Plan your Helix Core deployment.