[email protected]

## [1.7.1] - 2021-06-25

Plastic SCM for Unity is now available as part of the Version Control Package! You can enable Plastic SCM via Window > Plastic SCM to get started!
If you have previously used the Unity Asset Store Plastic SCM plug-in, you can now simply use this package. Make sure you delete the plug-in from your project.
Removing a previously added Plastic SCM Asset Store Plug-In:
- Select the PlasticSCM folder in the Assets\Plugins folder on the Project tab, then click Edit > Delete
- Close the Unity Editor and open your project again. You will find the Plastic SCM menu item in the Window menu.
### Added
- Added support for inviting other members. This option is available from the gear / settings icon.
- Added support for signing in with Cloud Edition. This is available during the onboarding screen if you have never signed in.
- Added support for turning off Plastic in their project. This option removes the Plastic metadata from your directory. This option is available under Assets > Plastic SCM > Turn off Plastic SCM
- Added notification on the Plastic SCM tab title to indicate incoming changes. Users will no longer need to have the Plastic SCM window visible to know there are incoming changes.
- Auto configuration of SSO
- Added date column in incoming changes
### Changed
- Updating license to better conform with expected customer usage.
- Updated documentation file to meet standards.
- Updated third-party usage.
- No longer requires downloading of the full Plastic client. Basic features will work without additional installation. Features that require the full Plastic client will allow download and install as needed.
- Usability improvements around checking in code
- Improved update workspace tab UX
- Plastic SCM context menu is now available even if the Plastic SCM window is closed
### Fixed
- Stability and performance improvements

CHANGELOG.md

@@ -4,6 +4,31 @@ All notable changes to this package will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [1.7.1] - 2021-06-25
+
+Plastic SCM for Unity is now available as part of the Version Control Package! You can enable Plastic SCM via Window > Plastic SCM to get started!
+If you have previously used the Unity Asset Store Plastic SCM plug-in, you can now simply use this package. Make sure you delete the plug-in from your project.
+Removing a previously added Plastic SCM Asset Store Plug-In:
+- Select the PlasticSCM folder in the Assets\Plugins folder on the Project tab, then click Edit > Delete
+- Close the Unity Editor and open your project again. You will find the Plastic SCM menu item in the Window menu.
+### Added
+- Added support for inviting other members. This option is available from the gear / settings icon.
+- Added support for signing in with Cloud Edition. This is available during the onboarding screen if you have never signed in.
+- Added support for turning off Plastic in their project. This option removes the Plastic metadata from your directory. This option is available under Assets > Plastic SCM > Turn off Plastic SCM
+- Added notification on the Plastic SCM tab title to indicate incoming changes. Users will no longer need to have the Plastic SCM window visible to know there are incoming changes.
+- Auto configuration of SSO
+- Added date column in incoming changes
+### Changed
+- Updating license to better conform with expected customer usage.
+- Updated documentation file to meet standards.
+- Updated third-party usage.
+- No longer requires downloading of the full Plastic client. Basic features will work without additional installation. Features that require the full Plastic client will allow download and install as needed.
+- Usability improvements around checking in code
+- Improved update workspace tab UX
+- Plastic SCM context menu is now available even if the Plastic SCM window is closed
+### Fixed
+- Stability and performance improvements
+
 ## [1.5.7] - 2021-04-07
 ### Unreleased
 - The Version Control package will be expanding to include both Collaborate and Plastic SCM version control interfaces. This release is preparing for that move and contains no new functionality or bug fixes for Collaborate.

Documentation~/Compatibility.md

@@ -0,0 +1,11 @@
+# Asset Store Plugin & Unity Package Compatibility
+
+Although the [Asset Store Plugin](https://assetstore.unity.com/packages/tools/utilities/plastic-scm-plugin-for-unity-beta-169442) and the Unity Package (in the package manager) are both available, you can only have one of the two installed.
+
+Below is what happens if you install both the package and plugin version of the Plastic SCM window:
+
+![Console errors](images/Compatibility.png)
+
+The errors in the console indicate that you've imported both the Plastic Plugin from the Asset Store and the Version Control package.
+
+To resolve these errors, remove either version from the project.

Documentation~/ExistingPlasticRepo.md

@@ -0,0 +1,45 @@
+# Getting started with an existing Plastic SCM repository
+
+1. Download and install the Plastic SCM [Cloud Client](https://www.plasticscm.com/download/).
+
+2. Open the Plastic SCM Cloud Client and log in.
+
+   ![Plastic sign-in page](images/SignIn.png)
+
+3. Join the Plastic **Organization** (this is different from your Unity organization) where the existing repository is located).
+
+4. Select the workflow that fits your needs.
+
+* **Developer Workflow**
+
+  With this workflow, you can work with branching and merging. To check in your changes straight to your cloud repository, create your workspace using the centralized tab.
+
+  ![Developer workflow](images/DeveloperWorkflow.png)
+
+* **Gluon Workflow**
+
+    This workflow tailored for artists allows you to pick the files you want to work on and check them back in without updating your whole workspace. To work inside the Unity Editor, make sure to configure Gluon to pull down all Unity project files required to open a Unity project.
+
+  ![Gluon workflow](images/GluonWorkflow.png)
+
+5. Create a Workspace.
+
+* If your Unity project files are already on your machine, select the directory path corresponding to your Unity project's root.
+* If your Unity project files are not on your machine, you can choose any location in which to create your workspace.
+
+6. Update or Configure your Workspace.
+
+* If you select the **Gluon Workflow** , configure your workspace to pull down all Unity project files required to open a Unity project.
+* If you choose the **Developer Workflow** , update your workspace to ensure your project is up to date with all incoming changes.
+
+7. Open your Unity project through the Hub.
+
+   **Note**: Unity will add the ability to join projects directly from the Unity Hub in a future version.
+
+8. Select **Window** > **Plastic SCM**.
+
+## Accessing the Plastic SCM Window
+
+You can access the **Plastic SCM** window in the Unity Editor by selecting **Window** > **Plastic SCM**.
+
+![Plastic SCM window](images/AccessingPlastic.png)

Documentation~/Faq.md

@@ -0,0 +1,16 @@
+# FAQ
+
+**What is the pricing for Plastic SCM Cloud Edition?**
+
+The pricing for Plastic SCM Cloud Edition depends on the number of users and amount of storage. It does not have a limit on bandwidth (except in cases of excessive use of egress).
+
+* As your team grows, the 3 first users will remain free. For a team of 5 users, you pay for 2 users.
+* Storage depends on the size of your repositories. For more details, see [Plastic SCM Cloud Edition pricing](https://www.plasticscm.com/plasticscm-cloud-edition/pricing).
+
+**Where should I post questions related to Plastic SCM?**
+
+Visit the [Unity forum](https://forum.unity.com/forums/plastic-scm.605/).
+
+**I have a Collaborate project that I want to use with Plastic SCM. What should I do?**
+
+To migrate your current Collaborate projects to Plastic SCM, see [Migration from Collaborate to Plastic SCM](MigrateCollab.md).

Documentation~/Glossary.md

@@ -0,0 +1,55 @@
+# Glossary
+
+## Asset terms
+
+**Asset**:
+
+Any media or data that can be used in your game or project. An asset may come from a file created outside of Unity, like a 3D model, an audio file, or an image. You can also create some asset types in Unity, such as an **Animator Controller** , an Audio Mixer, or a **Render Texture**. See [Asset workflow](https://docs.unity3d.com/Manual/AssetWorkflow.html).
+
+**Asset package**:
+
+A collection of files and data from Unity projects or elements of projects, compressed and stored in one file, similar to Zip files, with the .unitypackage extension. **Asset packages** are a handy way of sharing and re-using Unity projects and collections of assets. See [Asset packages](https://docs.unity3d.com/Manual/AssetPackages.html).
+
+**Asset Store**:
+
+A growing library of free and commercial assets created by Unity and members of the community. Offers a wide variety of textures, models, animations, project examples, tutorials, and Editor extensions. See [Using the Asset Store](https://docs.unity3d.com/Manual/AssetStore.html).
+
+**Package**:
+
+A container that stores various types of features and assets for Unity. Packages are self-contained units that the Unity Package Manager can share across Unity projects. Most of the time, these are called _packages_, but occasionally they are called **Unity Package Manager (UPM) packages**. See [Unity's Package Manager](https://docs.unity3d.com/Manual/Packages.html).
+
+## General terms
+
+**Ignore file**:
+
+A special file used in many **Version Control** Systems which specifies files to be excluded from **version control**. In Unity projects, several files can be excluded from **version control**. Using an Ignore File is the best way to achieve this. See [Using external version control systems with Unity](https://docs.unity3d.com/Manual/ExternalVersionControlSystemSupport.html).
+
+**Project**:
+
+In Unity, you use a project to design and develop a game. A project stores all of the files related to a game, such as the asset and **Scene** files. See [2D or 3D projects](https://docs.unity3d.com/Manual/2Dor3D.html).
+
+**Version Control**:
+
+A system for managing file changes. You can use Unity in conjunction with most **version control** tools, including **Perforce** , Git, Mercurial, and PlasticSCM. See [Version Control](https://docs.unity3d.com/Manual/VersionControl.html).
+
+## Plastic SCM terms
+
+**Checkin**:
+
+Checkin is the act of submitting changes to the repo. You must enter a comment in the text box before you can check in your changes.
+
+**Developer Mode**:
+
+Developers have access to the branch explorer directly from inside Unity and easily switch branches.
+
+**Gluon Mode**:
+
+Artists can take advantage of the Gluon visualized interface and workflow from inside Unity.
+
+**Organization**:
+
+The organization handles different sets of repositories in the Cloud. Inside the organization, you can create as many repositories as you need.
+
+**Workspace**:
+
+Your workspace interacts with the version control, where you download the files and make the required changes for each checkin.

Documentation~/KnownIssues.md

@@ -0,0 +1,5 @@
+# Known Issues
+
+* **Contents of a ModalUtility window are invisible when launched from a Unity Context Menu on 2020.3LTS, 2021.1, and 2021.2 (Active).**
+
+* **Enabling the Plastic SCM for Unity package disables the standard VCS integration option in the Project Settings.**

Documentation~/MigrateCollab.md

@@ -0,0 +1,55 @@
+# Migration from Collaborate to Plastic SCM
+
+Complete the steps to migrate Collaborate projects with the [Collaborate migration tool](https://www.plasticscm.com/plasticscm-cloud-edition/migrate-unity-projects/). You can invite your team members, set up your Plastic SCM workspace, and install Plastic SCM for Unity (beta).
+
+ **Videos**
+
+* [Migration Wizard](https://youtu.be/TKZuvPMprKg)
+* [Plastic SCM Plugin Dev workflow](https://youtu.be/6_x3SLCiyWo)
+* [Plastic SCM Plugin Gluon workflow](https://youtu.be/kfRu21cArGc)
+
+**Migration Steps**
+
+1. Access the [Collaborate migration tool](https://www.plasticscm.com/plasticscm-cloud-edition/migrate-unity-projects) on the Plastic SCM website.
+
+2. Click on **Get Started** and complete the wizard to migrate your Collaborate project(s) to Plastic SCM:
+
+   ![Migrate Collaborate projects](images/MigrateProjects.png)
+
+3. Download and install the Plastic SCM [Cloud Client](https://www.plasticscm.com/download/).
+
+4. Open the Plastic SCM Cloud Client and log in.
+
+5. Select the Organization that you have created with the migration tool.
+
+6. Select the workflow that fits your needs.
+
+  * **Developer Workflow**
+
+    With this workflow, you can work with branching and merging. To check in your changes straight to your cloud repository, create your workspace using the centralized tab.
+
+    ![Developer workflow](images/DeveloperWorkflow.png)
+
+* **Gluon Workflow**
+
+    This workflow, tailored for artists, allows you to pick the files you want to work on and check them back in without updating your whole workspace. To work inside the Unity Editor, make sure to configure Gluon to pull down all Unity project files required to open a Unity project.
+
+   ![Gluon workflow](images/GluonWorkflow.png)
+
+7. Create a Workspace.
+
+* If your Unity project files are already on your machine, select the directory path corresponding to your Unity project's root.
+* If your Unity project files are not on your machine, choose any location in which to create your workspace.
+
+8. Update or configure your Workspace.
+
+* If you select the **Gluon Workflow** , configure your workspace to pull down all Unity project files required to open a Unity project.
+* If you choose the **Developer Workflow** , update your workspace to ensure your project is up to date with all incoming changes.
+
+9. Open your Unity project through the Hub.
+
+   **Note:** Unity will add the ability to join projects directly from the Unity Hub in a future version.
+
+10. Select **Window** > **Plastic SCM**.
+
+You're all set to work on your project using Plastic SCM!

Documentation~/NewPlasticRepo.md

@@ -0,0 +1,34 @@
+# Getting started with a new Plastic SCM repository
+
+To start from an existing Plastic SCM repository, see [Getting started with an existing Plastic SCM repository](ExistingPlasticRepo.md).
+
+1. Open your Unity project.
+2. To access the Plastic SCM window in the Unity Editor, select **Window** > **Plastic SCM**.
+3. In the Plastic SCM onboarding window, complete the steps to continue.
+4. Download and install the Plastic SCM edition that matches your license. For example, if you are using Plastic SCM for the Cloud, download the Cloud Edition.
+5. Click on **Login or sign up.** You can **sign in using your Unity ID** or with a Plastic SCM account.
+6. Create a Plastic SCM **Organization** (this is different from your Unity organization) for your repositories or join an existing one.
+
+   ![Plastic SCM organization](images/PlasticOrg.png)
+
+7. Create a **Workspace** for your project.
+
+   ![Workspace creation](images/Workspace.png)
+
+Your workspace interacts with the version control, where you download the files and make the required changes for each check in.
+
+**Note:** You can have several workspaces working with the same local repository.
+
+By default, Plastic SCM sets the repository name and workspace name to the name of your Unity project.
+
+8. Choose the workflow you'd like to work with:
+
+   **Plastic Workspace** : Great for branching, merging and allowing you to push/pull.
+
+   **Gluon Workspace** : Choose this workflow If you only need to check in your work and sync with your teammates.
+
+Unity connects your project to your Plastic SCM Cloud repository.
+
+Plastic SCM automatically creates an ignore file in the workspace for Unity projects, so it doesn't track files that shouldn't be part of the repository. It also creates a standard automatic check in during the initial setup, so you're all set to start creating!
+
+![Plastic SCM window](images/AutomaticSetup.png)

Documentation~/OverviewOfFeatures.md

@@ -0,0 +1,37 @@
+# Overview of features
+
+## Pending Changes
+
+The **Pending Changes** tab allows you to view all pending changes in your workspace. These changes are not checked into the repository. In this tab, you can select which files you want to check in, add a comment, and check in the changes.
+
+![Pending changes tab](images/PendingChanges.png)
+
+**Note** : You can check in a specific file using the Plastic SCM contextual menu in the project view or the **Checkin** button in the **Inspector** window.
+
+![Inspector window](images/InspectorWindow.png)
+
+In the example below, the user adds a GameScene. They can check in the scene using the **Pending Changes** tab or the **Checkin** option in the contextual menu.
+
+![Checkin using contextual menu](images/GamesSceneExample.png)
+
+## Incoming Changes
+
+The **Incoming Changes** tab allows you to view all incoming changes and conflicts and update your local project. Any changes made to your project prompts an "**Incoming changes**" notification at the top right of the Plastic SCM window.
+
+**Tip** : Check the **Incoming Changes** tab frequently to avoid facing future change conflicts in your team.
+
+![Incoming changes tab](images/IncomingChanges.gif)
+
+## Project History
+
+Use the **Changesets** tab to view all changes made to your project as they occur chronologically, along with who made the changes and when. You can sort by columns and alter the chronological view of the story.
+
+![Changesets tab](images/ProjectHistory.png)
+
+Double-click any file in a changeset to go to the **File History** tab, and display every changeset. In the **File History view**, right-click on a change and select **Save the revision as…** to restore the file's former state. This is useful if you had previously deleted some logic that you now need.
+
+![File history view](images/FileHistory.png)
+
+You can also view the changes made to a specific file in the **Project view** through a contextual menu, then revert to an earlier revision of the file.
+
+![Revert changes in project view](images/ProjectView.gif)

Documentation~/PlasticForGitUsers.md

@@ -0,0 +1,14 @@
+# Plastic SCM for Git users
+
+
+| **GIT**| **Plastic**| **Explanation**|
+|:--|:--|:--|
+| To Commit| To Checkin| To Checkin is to submit changes to the repo.|
+| Commit| Changeset| Each new change on the history of the repo, grouping several individual file and directory changes.|
+| Master| Main| When you create a repo in Plastic, there's always an "empty" branch. Plastic calls it Main.|
+| To checkout  | To update| Downloading content to the workspace (working copy). This is called "update" because in Plastic, "checkout" has a different meaning.|
+|| Checkout| When you checkout a file in Plastic, you're telling Plastic you are going to modify the file.|
+|| Exclusive checkout or lock | This is locking a file so nobody can touch it. It’s only useful for non-mergeable files, like binaries, images, or art in a video game.|
+| Rebase|| Plastic handles branching differently than Git. In Plastic, a rebase is just a merge operation.|
+| Repository   | Repository| Where the entire history of the project is stored.
+| Working copy | Workspace| In Git, you have the working copy and the repository in the exact location. You have a working copy and a .git hidden dir with the repository. In Plastic, this is slightly different since repositories and workspaces are separated. You can have several workspaces working with the same local repository.

Documentation~/QuickStartGuide.md

@@ -0,0 +1,13 @@
+# Quick start guide
+
+The Version Control package will allow you to use either Collaborate or Plastic SCM for Unity for your projects in the Unity Editor. The Editor does not allow both services at the same time. For information on how to switch between both services, see [Switch between Collaborate and Plastic SCM](SwitchCollabAndPlastic.md).
+
+**Note** : For information on migrating projects from Collaborate to Plastic SCM, see [Migration from Collaborate to Plastic SCM](MigrateCollab.md).
+
+* Collaborate will give you the ability to share projects amongst small teams who want an easy way to sync their projects without navigating the complexity of version control.
+* Plastic SCM for Unity (beta) is an integration of Plastic SCM in Unity (actively developed) that will abstract version control complexity, like Collaborate. It will also enable you to work collaboratively on more complex projects by providing additional VCS features such as branching, locking, merging, and a standalone GUI.
+
+The Version Control package follows the Unity support schedule. Currently, supported versions are 2019.4LTS, 2020.3LTS, 2021.1, and 2021.2.
+
+* [Getting started with Collaborate](StartWithCollab.md)
+* [Getting started with Plastic SCM for Unity (beta)](StartPlasticForUnity.md)

Documentation~/StartPlasticForUnity.md

@@ -0,0 +1,12 @@
+# Getting started with Plastic SCM for Unity (beta)
+
+**Note**: Plastic SCM for Unity (beta) is available via the Version Control package in the Unity Package Manager.
+
+Plastic SCM for Unity (beta) will allow you to use Plastic SCM directly in Unity.
+
+**Important**: Enabling the Plastic SCM for Unity package will disable the standard VCS integration option in the Project Settings (this option will be removed from future Editor releases), which was an older integration previously offered in the Editor. Features available in the standard integration have been ported to the Plastic SCM for Unity package. This is the version that will be actively developed and maintained going forward.
+
+Plastic SCM Cloud Edition is **free for up to 3 users and up to 5 GB**. To learn more about Plastic SCM, see [Version control for game development](https://unity.com/products/plastic-scm?_ga=2.258676808.391394560.1617648415-1935282152.1592839733).
+
+* To start with a new Plastic SCM repository for your project, see [Getting started with a New Plastic SCM repository](NewPlasticRepo.md)
+* To start from an existing Plastic SCM repository, see [Getting started with an existing Plastic SCM repository](ExistingPlasticRepo.md)