Unity Version Control

https://docs.unity.com/en-us/unity-version-control
Admin
Unity Version Control (UVCS) is a version control and source code management tool optimized for game...
Tokens:991,276
Snippets:9,761
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### Typical Wwise install directory

Source: https://docs.unity.com/en-us/unity-version-control/release-notes/8

Example of a typical Wwise install directory.

```plaintext
C:\Program Files (x86)\Audiokinetic\Wwise 2019.1.X.YYYY
```

--------------------------------

### Installer --help command

Source: https://docs.unity.com/en-us/unity-version-control/release-notes/9

Command to get additional details for installer arguments.

```text
--help
```

--------------------------------

### View comprehensive help with examples for a command

Source: https://docs.unity.com/en-us/unity-version-control/cli/help

Run this command to get comprehensive help with examples for a specific command. Replace `<command>` with the actual command name.

```bash
cm <command> –help
```

--------------------------------

### Example BlobStorage configuration with MinSize

Source: https://docs.unity.com/en-us/unity-version-control/release-notes/5

Example configuration for the 'db.conf' file showing both 'BasePath' and 'MinSize' settings. This demonstrates a complete setup for external blob storage.

```xml
<BlobStorage>   <BasePath>C:\PlasticSCM\server\db_storage</BasePath>   <MinSize>1000</MinSize></BlobStorage>
```

--------------------------------

### GameUI help example

Source: https://docs.unity.com/en-us/unity-version-control/release-notes/5

Example command to launch GameUI with the '--help' argument to display help.

```text
    $> gameui.exe --help
```

--------------------------------

### Install Plastic Change Tracker service

Source: https://docs.unity.com/en-us/unity-version-control/release-notes/6

Command to install the Plastic Change Tracker service on Windows. After installation, start it with --start or via the service control panel.

```bash
plasticchangetrackerservice.exe --installservice
```

--------------------------------

### Sync parameters example

Source: https://docs.unity.com/en-us/unity-version-control/release-notes/9

Example parameters for the sync command, showing mainbranch and branchesfolder options.

```bash
--mainbranch=//depot/project/dev --branchesfolder=//depot/project
```

--------------------------------

### cm getconfig setfileasreadonly example

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-cli/getconfig

Example command to get the setfileasreadonly configuration.

```bash
cm getconfig setfileasreadonly
```

--------------------------------

### Filter example for Remove label trigger

Source: https://docs.unity.com/en-us/unity-version-control/triggers/concepts/detailed-trigger-reference

Example filter that restricts trigger execution to labels whose name starts with 'BL' in repositories whose name starts with 'code'.

```plaintext
--filter="rep:code*,BL*"
```

--------------------------------

### cm support examples

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-cli/support

Examples of running the support command and its bundle subcommand.

```bash
cm support
```

```bash
cm support bundle
```

```bash
cm support bundle c:\outputfile.zip
```

--------------------------------

### Example openwith.conf file

Source: https://docs.unity.com/en-us/unity-version-control/config-files/openwith-conf

An example openwith.conf file that defines a shortcut for Notepad++ to open the file.

```text
[Notepad|CtrlI] "C:\Program Files (x86)\Notepad++\notepad++.exe" @file
```

--------------------------------

### cm partial shelveset create examples

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-cli/partial-shelveset-create

Six examples of using 'cm partial shelveset create' with different options and arguments.

```bash
cm partial shelveset figure.png landscape.png
```

```bash
cm partial shelveset . -commentsfile=mycomment.txt
```

```bash
cm partial shelve background.png -c="my comment"
```

```bash
cm partial shelveset --applychanged
```

```bash
cm partial shelveset link --symlink
```

```bash
cm partial shelveset . --ignorefailed
```

--------------------------------

### Example content before local changes

Source: https://docs.unity.com/en-us/unity-version-control/release-notes/8

Controlled and up-to-date content used as the starting point for the example.

```text
/Assets/a.txt/Assets/Scripts/s.txt/Assets/Scripts/s1.txt/Assets/Scripts/s2.txt/Assets/Scripts/s3.txt/Assets/Scripts/s4.txt/Assets/Scripts/s5.txt/Assets/Scripts/s6.txt/Assets/Scripts/s7.txt/Assets/Scripts/s8.txt/Assets/Scripts/s9.txt/Assets/Scripts/MainMenu/Testing/Editor/b.txt/Assets/Scripts/MainMenu/m.txt/Assets/Scripts/MainMenu/Testing/t.txt
```

--------------------------------

### Install rdiff-backup 1.2.8

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-on-prem/backups/rdiff-backups

Install rdiff-backup version 1.2.8 on the server as part of the backup setup.

```bash
rdiff-backup 1.2.8
```

--------------------------------

### Install desktop client (plasticscm-client-gui)

Source: https://docs.unity.com/en-us/unity-version-control/install-uvcs-on-linux

Use plasticscm-client-gui to install the visual tools, including plasticgui and gluon.

```bash
plasticscm-client-gui
```

--------------------------------

### cm changeset edit command with GUID

Source: https://docs.unity.com/en-us/unity-version-control/release-notes/10

The 'cm changeset edit' command now correctly handles GUIDs. This example shows how to edit a changeset by its GUID.

```bash
$ cm changeset edit "89095131-895d-4173-9440-ff9ef9b2538d@project@cloud" "Changing my commit message"
```

--------------------------------

### Copy ontime.conf example from Linux or macOS

Source: https://docs.unity.com/en-us/unity-version-control/vcs-plugins/issue-tracking/axosoft

Copy the 'ontime.conf' example into the new path from the specified locations.

```text
<plasticscm_install_path>/client/extensions/config_samples
```

```text
/Applications/PlasticSCM.app/Contents/IssueTrackerConfigSamples
```

--------------------------------

### cm changeset delete example with GUID

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-cli/changeset-delete

Deletes the changeset with the GUID 'cs:cb11ecdb-1aa9-4f11-8698-dcab14e5885a' using the full 'delete' command.

```bash
cm changeset delete cs:cb11ecdb-1aa9-4f11-8698-dcab14e5885a
```

--------------------------------

### GitSync command line client example

Source: https://docs.unity.com/en-us/unity-version-control/release-notes/5

Example of using GitSync with the command line client to get more info about an error.

```bash
$ cm sync rep2 git git@bitbucket.org:myuser/myrepo.git
```

--------------------------------

### Server name example: mainserver

Source: https://docs.unity.com/en-us/unity-version-control/xlinks

Example of a server name.

```text
mainserver
```

--------------------------------

### db.conf with custom DatabaseCreationCommands

Source: https://docs.unity.com/en-us/unity-version-control/release-notes/5

Example of a 'db.conf' file with a custom 'DatabaseCreationCommands' value. The command must be written in a single line; the example is formatted for readability. The 'DatabaseCreationCommands' key allows user-defined settings for SQL Server database creation.

```XML
<?xml version="1.0"?><DbConfig><ProviderName>sqlserver</ProviderName><ConnectionString>SERVER=localhostSQLEXPRESS;User Id=username;Pwd=password;DATABASE={0};</ConnectionString><DatabaseCreationCommands>CREATE DATABASE @PlasticDatabase ON PRIMARY(NAME=@PlasticDatabase_custom, FILENAME='@PlasticDefaultDatabaseFile', SIZE=10, FILEGROWTH=100)LOG ON (NAME=@PlasticDatabase_log, FILENAME='@PlasticDefaultLogFile', SIZE=10, FILEGROWTH=100)COLLATE @PlasticDefaultCollation</DatabaseCreationCommands><DatabasePath></DatabasePath></DbConfig>
```

--------------------------------

### Filter example for Create label trigger

Source: https://docs.unity.com/en-us/unity-version-control/triggers/concepts/detailed-trigger-reference

Example filter that triggers only for labels whose name starts with 'BL' in the repository 'code'.

```plaintext
--filter="rep:code,BL*"
```

--------------------------------

### cm issuetracker jira status get example

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-cli/issuetracker

Gets the status of issue 11 for the 'PRJ' project using Jira parameters.

```bash
cm issuetracker jira status get 11 --user=user@mail.es --password=pwd --host=https://user.atlassian.net --projectkey=PRJ
```

--------------------------------

### Enable automatic startup for proxy (systemctl enable plasticscm-proxy-server)

Source: https://docs.unity.com/en-us/unity-version-control/install-uvcs-on-linux

Run this command after installing the proxy to enable automatic startup for the proxy server.

```bash
systemctl enable plasticscm-proxy-server
```

--------------------------------

### LDAP filter for setups without uid attribute

Source: https://docs.unity.com/en-us/unity-version-control/release-notes/9

Example LDAP filter for setups that do not have the 'uid' attribute, using sAMAccountName or cn.

```plaintext
(|(sAMAccountName={user})(cn={user}))
```

--------------------------------

### Enable automatic startup for server (systemctl enable plasticscm-server)

Source: https://docs.unity.com/en-us/unity-version-control/install-uvcs-on-linux

Run this command after installing the server to ensure the Unity Version Control server starts automatically when the system boots.

```bash
systemctl enable plasticscm-server
```

--------------------------------

### Filter example for Create branch trigger

Source: https://docs.unity.com/en-us/unity-version-control/triggers/concepts/detailed-trigger-reference

Example filter that restricts the trigger to branches whose name starts with 'scm' in the repository 'default'.

```plaintext
--filter="rep:default,scm*"
```

--------------------------------

### CLI command to open server configuration wizard

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-on-prem/saml-auth-microsoft

Run this command from the server directory to start the configuration wizard.

```text
.\plasticd configure
```

--------------------------------

### cm support bundle example (specified location)

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-cli/support-bundle

Creates a support bundle at the specified location using the outputfile argument.

```bash
cm support bundle c:\outputfile.zip
```

--------------------------------

### Filter example for Remove attribute trigger

Source: https://docs.unity.com/en-us/unity-version-control/triggers/concepts/detailed-trigger-reference

Example filter that restricts the trigger to repositories whose name starts with 'code' and the attribute named 'resolved'.

```plaintext
--filter="rep:code*,resolved"
```

--------------------------------

### Filter example: --filter="rep:cod*"

Source: https://docs.unity.com/en-us/unity-version-control/triggers/concepts/detailed-trigger-reference

Example filter that restricts the trigger to repositories whose name starts with 'cod'.

```plaintext
--filter="rep:cod*"
```

--------------------------------

### List workspaces

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-cli/workspace

Example of listing all workspaces.

```bash
cm workspace list
```

--------------------------------

### Example: get workspace with extended format

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-cli/getworkspacefrompath

Uses the `gwp` alias to get workspace info for the current directory, displaying name, type, and dynamic status.

```bash
cm gwp . --format="Name: {wkname} | Type: {type}, {dynamic}"
```

--------------------------------

### Example: cm repo with server spec and multiple repositories

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-cli/repository-create

Creates multiple repositories on a specified server using a repository server specification.

```bash
cm repo 192.168.1.140:8087 Rep01 Rep01/ModuleA Rep01/ModuleB
```

--------------------------------

### Example: Basic fast-import

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-cli/fastimport

Imports the contents of 'repo.fast-export' into the 'mynewrepo' repository on server 'atenea:8084'. The repository is created if it does not exist.

```bash
cm fast-import mynewrepo@atenea:8084 repo.fast-export
```

--------------------------------

### cm pull hydrate with changeset GUID

Source: https://docs.unity.com/en-us/unity-version-control/release-notes/8

The 'cm pull hydrate' command now accepts a changeset GUID. Previously it only accepted changeset IDs unless the source branch was specified. The example shows hydrating a changeset specified by GUID.

```bash
cm pull hydrate cs:cadcf131-d7a4-4e4c-a665-fc04accb8c7f@myrepo@myserver:myport
```

--------------------------------

### cm profile examples

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-cli/profile

Examples of profile commands: list, create, and delete.

```bash
cm profile
```

```bash
cm profile list
```

```bash
cm profile create
```

```bash
cm profile delete 1
```

--------------------------------

### Extension rule example

Source: https://docs.unity.com/en-us/unity-version-control/release-notes/11

Example of a rule that matches a folder starting with a dot, such as .vs. This rule only matches files or directories with that exact name, not paths with the .vs extension.

```text
.vs
```
Tokens:
Raw