Getting started with Plastic SCM

Installing the Plastic SCM plugin for Unity

The plugin is available via the Version Control package in the Unity Package Manager.

You will need to uninstall the Plastic SCM Asset Store plugin from your Unity project in order to use Plastic SCM for Unity via the Version Control package. Here are the steps to do so:

1. Navigate to your Assets/Plugins folder in your Unity Project. Delete the PlasticSCM folder.
2. Re-open your Unity Project to recompile your packages.

Note: The .plastic workspace folder in the root of the Unity Project does not need to be removed as it can be read by the Version Control package.

You can access Plastic SCM for Unity on any supported version by navigating to Window > Plastic SCM. From there, you’ll walk through a simple onboarding process, which will guide your account setup and ensure that your Unity project is configured correctly.

Using the Plastic SCM plugin

Plastic SCM 插件会在 Unity 编辑器中启用 Plastic SCM 窗口。使用 Plastic SCM 窗口可管理文件更改，包括：

• 将项目链接到源代码控制
• 签入文件
• 撤消更改
• 比较文件修订

Plastic SCM 窗口会显示项目中新文件和更改的文件的列表。添加新文件或保存对现有文件的更改时，Plastic SCM 窗口会自动显示受影响的文件。

要打开 Plastic SCM 窗口，请选择 Window > Plastic SCM。

创建新工作空间

要在 Unity 项目中使用 Plastic SCM 插件，必须在 Plastic SCM 窗口或是在 Plastic SCM GUI 中为项目创建工作空间。

要在 Unity 编辑器中为项目创建新工作空间，请执行以下操作： 1.选择 Window > Plastic SCM。 2.指定项目的代码仓库名称、工作空间名称和路径。默认情况下会使用现有项目路径和名称。 3.选择要将 Plastic SCM 用作开发者（适用于完整 Plastic SCM 功能）还是美术师（适用于简化工作流程）。

创建了工作空间后，Plastic SCM 窗口便会显示项目文件。此外，Plastic SCM 会自动在工作空间（即项目文件夹）中创建一个忽略文件。

将项目文件提交到源代码控制

将项目连接到 Plastic SCM 工作空间后，Plastic SCM 窗口的 Pending Changes 选项卡会将所有现有项目文件都显示为 Added and private。要将这些文件包含在工作空间中，必须签入他们。

签入文件后，Pending changes 选项卡会刷新，不再列出已签入的文件。此外，Plastic SCM GUI 现在会显示：

• 项目文件（在工作空间资源管理器中）
• 最新签入（在 Changesets 视图中）

签入文件

要签入文件，请执行以下操作：

1.选择 Window > Plastic SCM。 2.在 Plastic SCM 窗口中，选择要签入的文件。 3.在文本字段中，输入注释以解释更改。 4.选择 Checkin。

更改会在 Plastic SCM GUI 的 Changesets 视图中列出。

忽略文件

使用 Plastic SCM 插件创建工作空间时，它会自动在工作空间中创建一个忽略文件。这包含要从源代码控制中排除的文件类型和路径的默认列表。 如果项目中还有其他文件要从共享代码仓库中排除，请将它们添加到忽略文件中：

1.在 Plastic SCM 窗口中，右键单击要忽略的文件。 2.选择 Add to ignored list。 3.选择文件名。

选择忽略的文件会从 Pending changes 列表中移除。 可以忽略特定文件名、整个文件夹以及具有特定扩展名的所有文件。

了解有关忽略文件的更多信息。

查看文件更改

要将更新的文件与以前的版本进行比较，请在 Plastic SCM 窗口中右键单击文件并选择 Diff。这会打开 Differences 视图，它会将代码仓库源与本地副本进行比较。这是纯文本视图。

恢复文件更改

如果在项目中进行了不想保留的更改，则可以恢复到以前的版本，即最新签入的版本。要恢复对文件的更改，请在 Pending changes 选项卡中选择文件并选择 Undo changes。

Plastic SCM 窗口

在 Unity 编辑器中使用 Plastic SCM 窗口可管理项目的版本控制。 如果项目尚未连接到 Plastic SCM，则 Plastic SCM 窗口会显示用于创建新工作空间的视图。 下表介绍了此视图的字段。

字段	描述
Repository name	代码仓库的名称。默认情况下，这是项目的名称。
Workspace name	工作空间的名称。默认情况下，这是项目的名称。
Path on disk	项目的路径。默认情况下，这是打开的项目的位置。
Developer 单选按钮	选择此选项以获得完整 Plastic SCM 功能，包括合并以及推送和拉取分支。
Artist 单选按钮	选择此选项可获得简化的文件签入工作流程（没有合并或多个分支）。
Create workspace 按钮	使用提供的详细信息为项目创建工作空间。

下表介绍了 Unity 编辑器中的 Plastic SCM 窗口。

字段	描述
跳转	显示当前正在处理的工作空间分支。
Pending changes 选项卡	显示项目中更改的文件的列表。
Incoming changes 选项卡	显示项目的本地版本还没有的工作空间外部更改。
Launch branch explorer（仅限开发者模式）	单击可打开分支资源管理器。
Launch Plastic（仅限开发者模式）	单击可打开 Plastic SCM。
Configure Gluon（仅限美术师模式）	单击可在配置模式下打开 Plastic Gluon。
Launch Gluon（仅限美术师模式）	单击可打开 Plastic Gluon。

Pending changes 选项卡

Pending changes 选项卡会显示项目本地版本中的新文件和更改的文件。使用此选项卡可将文件签入 Plastic 工作空间、从版本控制中排除文件以及将更改的文件与以前签入的版本进行比较。

字段	描述
Checkin changes	将选定文件提交到工作空间。必须先在文本框中输入注释，然后才能签入更改。
Undo changes	撤消对选定文件进行的本地更改。
Keep items locked（仅限美术师模式）	在签入操作后使项目保持锁定状态。例如，如果要对一个文件进行多个更改，但将它们作为单独更改分别签入，那么这会十分有用。要解锁项目，请取消选择此按钮。
Options	单击可打开 Options 窗口。
项	文件的名称和路径。文件按更改类型进行分组，例如： Changed Deleted Added
Status	文件的状态，例如： Changed Removed locally Private
Size	文件的大小。
扩展名	文件扩展名。
类型	文件类型。
修改日期	更改的日期和时间。
Repository	进行更改的代码仓库，即本地代码仓库或远程代码仓库（如果其他用户进行了更改）。

了解有关 Pending changes 视图的更多信息。

Incoming changes 选项卡

Incoming changes 选项卡显示项目的本地版本还没有的工作空间的外部更改。 使用此选项卡可从远程工作空间获取最新更改。

字段	描述
Update workspace	使用工作空间中的外部更改更新项目。
路径	文件路径和名称。
Last edited by（仅限美术师模式）	签入更改的用户。
Size	文件的大小。
Date modified（仅限美术师模式）	文件最近签入的日期。
Author（仅限开发者模式）	签入更改的用户。
Details（仅限开发者模式）	描述更新操作将对相关更改执行的操作。
Resolution method（仅限开发者模式）	显示用户在解决目录冲突时选择的解决方法。

了解有关 Incoming Changes 功能的更多信息。

Options 窗口

使用 Options 窗口可控制 Plastic SCM 窗口的行为。 下表介绍了 Plastic SCM 窗口的选项。

字段	描述
What to find 选项卡
Show checkouts	显示以下文件： 在 Plastic 中显式签出的文件 已移动的文件 正在进行合并的文件
Find changed files in the workspace	检查工作空间目录结构以通过时间戳识别更改的文件。
Check the content to determine files as changed, not just timestamp	使用更新的时间戳计算文件的哈希，以确保实际更改了文件内容。
What to show 选项卡
Auto-refresh	Plastic 会根据需要自动刷新 Pending Changes 列表，以避免手动刷新。
Show private files	显示未提交到源代码控制的文件，例如新文件或工具生成的内容。
Show ignored files	显示添加到忽略列表中的文件。
Show hidden files	显示添加到隐藏列表中的文件。
Show deleted files and directories	显示在 Plastic 控制范围之外的工作空间中手动删除的文件。
Move detection 选项卡
Find moved and renamed files and directories	在工作空间中搜索可能的已重命名或已移动文件，例如，如果删除了一个文件并添加了另一个文件。
Match binary files only when they have the same extension	将二进制文件的文件匹配限制为具有相同扩展名的文件。
Match text files only when they have the same extension	将文本文件的文件匹配限制为具有相同扩展名的文件。
Similarity percentage	定义需要如何将相似文件视为已移动或已重命名。 对于文本文件，此百分比与内容相关。 对于二进制文件，此百分比与文件大小相关。 对于目录结构，这与子项相关（采用目录条目总数百分比形式）。

了解有关 Options 窗口的更多信息。