initial commit

This commit is contained in:
Jo 2025-01-07 02:06:59 +01:00
parent 6715289efe
commit 788c3389af
37645 changed files with 2526849 additions and 80 deletions

View file

@ -0,0 +1,7 @@
# Access remote projects
1. In the Unity Hub v3 Beta, click **Open** > **Open Remote Project** to see the list of your Plastic SCM repositories that contain a Unity project.
Note: In Unity Hub 2.4.4 and up, your Plastic SCM projects will be listed alongside Collaborate projects.
2. Select the project and click **Next**.
3. Select the Editor version and platform and click the **change version** button.
4. Your local Plastic SCM workspace will be created for you. The latest version of the project will be downloaded and the Editor will open with the latest version of your Unity project.

View file

@ -0,0 +1,12 @@
# Add integrations
You can set up integrations for your Plastic SCM organization via your plasticscm.com Cloud Dashboard.
The Cloud dashboard gives you access to your organizations. From here, you can configure **triggers** (equivalent to integrations).
To configure a Slack notifications trigger:
1. On an organization, click **Configure** > **Triggers**.
2. Click **Add Trigger** > **Slack**.
3. In **Destination**, add your Slack channel name.
4. Select your trigger type and click **Save**.

View file

@ -0,0 +1,13 @@
# Add team members
To invite team members to contribute to your project:
1. Click the settings menu (gear icon) and click Invite Members to Workspace.
![Invite members to project](images/InviteMembers.png)
2. In the Plastic SCM cloud dashboard, click Add new user.
You can also send invitations and add different permission types for each user.

View file

@ -0,0 +1,23 @@
# Create projects
To create projects after the upgrade:
1. In Unity, open the Plastic SCM window and click on **Create Workspace**.
Plastic SCM will suggest names for your repository (shared files and history) and workspace (your local copy).
If you wish to use an existing Plastic SCM repository, click the three dots next to the repository name, and select a repository from the list.
2. Select the type of workspace that fits your needs.
* **Plastic workspace**
With this workspace, you can work with branching and merging.
* **Gluon workspace**
This workspace tailored for artists allows you to pick the files you want to work on and check them back in without updating your whole workspace.
3. Add asset files associated with your project.
Plastic SCM will display the project files from the asset folder in the **Pending changes** tab. You can choose specific files to include or add all to the repository by selecting the files and clicking Checkin changes.
Plastic SCM will automatically perform a check in for appropriate folders and files such as package files and project settings when its set up from the Unity Editor. You can view these in the **Changesets tab.**
Once your initial asset check in is complete, youre set up with Plastic SCM for Unity and ready to create.

View file

@ -0,0 +1,17 @@
# Getting started with an existing Plastic SCM repository
Suppose you want to start working on a Unity project in an existing Plastic SCM repository and already have a Plastic SCM account linked to your Unity ID. In that case, you will be able to open the project straight from the **Unity Hub**. A workspace will automatically be created for your project on your machine.
1. In the Unity Hub v3 Beta, click **Open** > **Open remote project** to see the list of your Plastic SCM repositories that contain a Unity project.
2. Click the project and click **Next**.
3. Click the Editor version and platform and click the **change version** button.
4. In the Editor pop-up, click the **Migrate** button to migrate your local workspace to a Plastic SCM workspace
5. Once the migration is completed, click the **Open Plastic SCM** button.
![Plastic Hub](images/plasticHub.gif)
## Accessing the Plastic SCM Window
You can access the **Plastic SCM** window in the Unity Editor by clicking **Window** > **Plastic SCM**.
![Plastic SCM window](images/AccessingPlastic.png)

View file

@ -0,0 +1,11 @@
# Export Collaborate projects
To export your Project as a zip file that you can import into Plastic SCM:
1. Sign into the [Unity Developer Dashboard](https://developer.cloud.unity3d.com/).
2. At the top of the screen, click on the project name to open the dropdown list. Search for the project you'd like to export, then click on it to load its dashboard.
3. In the left navigation window, click **DevOps**. Scroll to the **Collaborate** section in the new navigation window when the new page loads, then click **Storage**.
4. Under **Exporting a Project**, click **Start Export** in the main window.
5. When the export is complete, click the **Download Export**. A zip file downloads onto your local machine.
The zip file contains all versions of all files stored in the Projects repository, ready for import into Plastic SCM.

View file

@ -0,0 +1,37 @@
# Glossary
## 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 Workflow
Developers have access to the branch explorer directly from inside Unity and easily switch branches.
#### Gluon Workflow
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.

View file

@ -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 click **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)

View file

@ -0,0 +1,6 @@
# More help
To find more information on working with the Plastic SCM plug-in, see [Getting started with Plastic SCM](https://docs.unity3d.com/2022.1/Documentation/Manual/PlasticSCMPluginGettingStarted.html).
You can also post and find questions related to Plastic SCM in the [Unity forum](https://forum.unity.com/forums/plastic-scm.605/).

View file

@ -0,0 +1,24 @@
# Getting started with a new Plastic SCM repository
**Note**: To start from an existing Plastic SCM repository, see [Getting started with an existing Plastic SCM repository](ExistingPlasticRepo.md).
You can walk through a straightforward onboarding wizard when creating a repository for your Unity project. This new wizard will help you:
* Set up your account and configure your repository for your Unity project, enabling you to sync to a Plastic SCM Cloud Edition repository.
* Generate a standard ignore file that prevents unnecessary components of your Unity project from being checked in.
* Automatically do the first check-in so that your repository is in sync with your local changes.
1. Open your Unity project.
2. To access the Plastic SCM window in the Unity Editor, click **Window** > **Plastic SCM**:
![Plastic SCM window](images/AccessingPlastic.png)
3. In the Plastic SCM onboarding window, complete the steps to continue:
![Onboarding](images/Onboarding.png)
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 checkin during the initial setup. So now you're all set to start using Plastic SCM!
![Automatic setup](images/AutomaticSetup.png)
**Note**: Basic version control actions, such as viewing pending changes, checking in changes, and viewing changesets, dont require a Plastic SCM Client install. However, if you want to use more advanced features, such as branching and diffing changeset, you will be prompted to download the Plastic SCM client (if you have not already done so):
![Advanced features](images/AdvancedFeatures.png)

View file

@ -0,0 +1,14 @@
# Plastic SCM for Git users
| **GIT**| **Plastic**| **Explanation**|
|:--|:--|:--|
| To Commit| To Check in| To Check in 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. Its 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.

View file

@ -0,0 +1,14 @@
# Quick start guide
The Version Control package will allow you to use Plastic SCM for Unity for your projects in the Unity Editor.
Plastic SCM for Unity integrates Plastic SCM in Unity that will abstract version control complexity. 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:
* 2021.1.15f1
* 2021.2.0b6
* 2022.1.0a4
[Getting started with Plastic SCM for Unity](StartPlasticForUnity.md)

View file

@ -0,0 +1,10 @@
# Connect Unity Cloud Build
Unity Cloud Build is a [continuous integration](https://docs.unity3d.com/2022.2/Documentation/Manual/UnityCloudBuild.html#automated-build-generation) that automatically creates multiplatform builds in the Cloud in minutes. You can point Cloud Build toward your version control system to:
* Automate new builds
* Build faster
* Catch problems earlier
* Iterate on your builds more efficiently with agility.
To get started, see [Pay as you go with Cloud Build](https://docs.unity3d.com/2022.2/Documentation/Manual/UnityCloudBuildMeteredBilling.html).

View file

@ -0,0 +1,8 @@
# Getting started with Plastic SCM for Unity
Plastic SCM for Unity will allow you to use Plastic SCM directly in Unity and is available via the Version Control package in the Unity Package Manager.
Learn more about [Plastic SCM Cloud Edition](https://unity.com/products/plastic-scm).
* 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).

View file

@ -0,0 +1,21 @@
[About version control](index.md)
* [Quick start guide](QuickStartGuide.md)
* [Create projects](CreateProjects.md)
* [Access remote projects](AccessRemoteProjects.md)
* [Add team members](AddMembers.md)
* [Connect Cloud Build](ReconnectCB.md)
* [Add integrations](AddIntegrations.md)
* [Getting started with Plastic SCM for Unity](StartPlasticForUnity.md)
* [Getting started with a new Plastic SCM repository](NewPlasticRepo.md)
* [Getting started with an existing Plastic SCM repository](ExistingPlasticRepo.md)
* [Main features](MainFeatures.md)
* [Pending Changes](MainFeatures.md#pending-changes)
* [Incoming Changes](MainFeatures.md#incoming-changes)
* [Project History](MainFeatures.md#project-history)
* [Plastic SCM for Git users](PlasticForGitUsers.md)
* [Glossary](Glossary.md)
* [General terms](Glossary.md#general-terms)
* [Plastic SCM terms](Glossary.md#plastic-scm-terms
* [More help](MoreHelp.md)

Binary file not shown.

Binary file not shown.

View file

@ -0,0 +1,7 @@
# About Version Control
The Version Control package provides an in-editor interface for teams to work with Plastic SCM.
## Plastic SCM
Plastic SCM Plug-in for Unity is a free Unity plug-in that gives you the ability to use Plastic SCM, a leading version control solution, directly in Unity. Get started with [Plastic SCM](QuickStartGuide.md).