unity 签名留言，手写签名

# UPM Package Starter Kit The purpose of this package starter kit is to provide the data structure and development guidelines for new packages meant for the **Unity Package Manager (UPM)**. This is the first of many steps towards an automated package publishing experience within Unity. This package starter kit is merely a fraction of the creation, edition, validation, and publishing tools that we will end up with. We hope you enjoy your experience. You can use **#devs-packman** on Slack to provide feedback or ask questions regarding your package development efforts. ## Are you ready to become a package? The Package Manager is a work-in-progress for Unity and, in that sense, there are a few criteria that must be met for your package to be considered on the package list at this time: - **Your code accesses public Unity C# APIs only.** If you have a native code component, it will need to ship with an official editor release. Internal API access might eventually be possible for Unity made packages, but not at this time. - **Your code doesn't require security, obfuscation, or conditional access control.** Anyone should be able to download your package and access the source code. ## Package structure ```none <root> ├── package.json ├── README.md ├── CHANGELOG.md ├── LICENSE.md ├── Third Party Notices.md ├── QAReport.md ├── Editor │ ├── Unity.[YourPackageName].Editor.asmdef │ └── EditorExample.cs ├── Runtime │ ├── Unity.[YourPackageName].asmdef │ └── RuntimeExample.cs ├── Tests │ ├── .tests.json │ ├── Editor │ │ ├── Unity.[YourPackageName].Editor.Tests.asmdef │ │ └── EditorExampleTest.cs │ └── Runtime │ ├── Unity.[YourPackageName].Tests.asmdef │ └── RuntimeExampleTest.cs ├── Samples │ └── Example │ ├── .sample.json │ └── SampleExample.cs └── Documentation~ ├── your-package-name.md └── Images ``` ## Develop your package Package development works best within the Unity Editor. Here's how to set that up: 1. Clone the Package Starter Kit repository locally. - In a console (or terminal) application, choose a place to clone the repository and enter the following: ``` git clone git@github.cds.internal.unity3d.com:unity/com.unity.package-starter-kit.git ``` 1. Create a new repository for your package and clone to your desktop. - On Github.cds create a new repository with the name of your package (Example: `"com.unity.terrain-builder"`). - In a console (or terminal) application, choose a place to clone the repository and perform the following: ``` git clone git@github.cds.internal.unity3d.com:unity/com.unity.[your-package-name] ``` 1. Copy the contents of the Package Starter Kit folder to your new package. Be careful not to copy the Package Starter Kit *.git* folder over. 1. **Fill in your package information.** Follow the instructions for [filling out your package manifest](#fill-out-your-package-manifest) (*package.json*). Then update the `"createSeparatePackage"` field in the *Tests/.tests.json* file to set up testing for Continuous Integration (CI): * Set it to false if you want the tests to remain part of the published package. This is the default value. * Set it to true if you want the CI to create a separate package for these tests, and add the metadata at publish time to link the packages together. This allows you to have a large number of tests, or assets, etc. that you don't want to include in your main package, while making it easy to test your package with those tests & fixtures. 1. Start **Unity**, create a local empty project and import your package into the project. 1. In a console (or terminal) application, push the package starter kit files you copied in your new package repository to its remote. - Add them to your repository's list to version ```git add .``` - Commit to your new package's remote master ```git commit``` - Push to your new package's remote master ```git push``` 1. Restart **Unity**. This forces the Package Manager to rescan your project so that it can find the new package that you just embedded. For more information on embedded packages see [Confluence](https://confluence.hq.unity3d.com/display/PAK/How+to+embed+a+package+in+your+project). 1. **Update the *README.md* file.** It should contain all pertinent information for developers using your package, such as: * Prerequistes * External tools or development libraries * Required installed Software * Command line examples to build, test, and run your package. 1. **Rename and update your documentation file(s).** Use the samples included in this starter kit to create preliminary, high-level documentation. Your documentation should introduce users to the features and sample files included in your package. For more information, see [Document your package](#document-your-package). 1. **Rename and update assembly definition files.** Choose a name schema to ensure that the name of the assembly built from the assembly definition file (_.asmdef_) will follow the .Net [Framework Design Guidelines](https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/index). For more information, see [Name your assembly definition files](#name-your-assembly-definition-files). 1. **Add samples to your package (code & assets).** The Package Manager recognizes the *Samples* directory in a package but does not import samples into Unity when the package is added to a project by default. Users can import samples into their */Assets* directory by clicking the **Import in project** button from the [Details view](https://docs.unity3d.com/Manual/upm-ui-details.html) of your package in the Package Manager window. If your package contains a sample: * Rename the *Samples/Example* folder, and update the *.sample.json* file in it. * If your package contains multiple samples, make a copy of the *Samples/Example* folder for each sample, and update each *.sample.json* file accordingly. Delete the *Samples* folder altogether if your package does not need samples. 1. **Validate your package using the Validation Suite.** Before you publish your package, you need to make sure that it passes all the necessary validation checks by using the [Package Validation Suite](https://github.cds.internal.unity3d.com/unity/com.unity.package-validation-suite) extension. This is *required*. For more information, see [Validate your package](#validate-your-package). 1. **Follow our design guidelines** Follow these design guidelines when creating your package: * The [package design standards](https://confluence.hq.unity3d.com/display/UX/Packages) on Confluence. * The [design checklist](https://unitytech.github.io/unityeditor-hig/topics/checklist.html) from Unity's Human Interface Guidelines. * The namespace for code in the asmdef *must* match the asmdef name, except the initial `Unity`, which should be replaced with `UnityEngine` or `UnityEditor`. * For **Runtime code**, only use the `Unity` namespace for code that has no dependency on anything in `UnityEngine` or `UnityEditor` and instead uses `ECS` and other `Unity`-namespace systems. 1. **Add tests to your package.** For **Editor tests**: * Write all your Editor Tests in *Tests/Editor* * If your tests require access to internal methods, add an *AssemblyInfo.cs* file to your Editor code and use `[assembly: InternalsVisibleTo("Unity.[YourPackageName].Editor.Tests")]`. For **Playmode Tests**: * Write all your Playmode Tests in *Tests/Runtime*. * If your tests require access to internal methods, add an *AssemblyInfo.cs* file to your Runtime code and use `[assembly: InternalsVisibleTo("Unity.[YourPackageName].Tests")]`. 1. **Setup your package CI.** Make sure your package con