Skip to content

Files

Latest commit

e8d04c1 · Dec 10, 2020

History

History
61 lines (52 loc) · 3.93 KB

README.md

File metadata and controls

61 lines (52 loc) · 3.93 KB

Unity Package Maker License

This repository is a Unity Editor tool for creating new Unity packages (or updating existing ones). See the Unity documentation for manual instructions for Creating custom Unity packages.

The tool has been verified on the following versions of Unity:

  • 2019.4
  • 2019.3

Setup

Option A) Clone or download the repository and drop it in your Unity project.
Option B) Add the repository to the package manifest (go in YourProject/Packages/ and open the "manifest.json" file and add "com..." line in the depenencies section). If you don't have Git installed, Unity will require you to install it.
{
  "dependencies": {
      ...
      "com.razluta.unitypackagemaker": "https://github.com/razluta/UnityPackageMaker.git"
      ...
  }
}
Option C) Add the repository to the Unity Package Manager using the Package Manager dropdown.

Using the tool

Option A) Creating a new package

Step 01 of 05

Launch the tool from the Unity menus by navigating to Raz's Tools > Package Maker.

Step 02 of 05

Since you are creating a new package, you can ignore the Load Existing Unity Package button. Start populating the fields. All properties that are enabled by default and do not have the ability to be disabled are mandatory. When in doubt about the data, review Unity's documentation: Package Layout Manual and Package Manifest Manual.

Step 03 of 05

Under the Included Package Contents section, enable the toggles for all additional documentation and folders you would like to include. If you enable any of the folder creation (which is highly recommend to follow Unity's naming standards and keep consistency between projects), keep in mind the tool will also create a .gitnull file to force git to acknowledge the folder while Unity will not see the file and will only see the folder. If you have enabled any additional documents such as the README.md, their text fields on the right side of the tools will be enabled and you can add your text there.

Step 04 of 05

You can at any time Clear All fields, which will clear all the data in the tool.

Step 05 of 05

Once you are done putting in your data, press Create New Unity Package. If all the data is valid, the tool will ask you for the parent folder where you would like the tool to create the root tool folder and all the contents.

Option B) Updating an existing package

Step 01 of 05

Launch the tool from the Unity menus by navigating to Raz's Tools > Package Maker.

Step 02 of 05

Press the Load Existing Unity Package button and navigate to the root folder of the package from which you would like to extract the data. If Unity can find a valid manifest (package.json), it will auto-populate all the tool fields.

Step 03 of 05

Made any edits necessary to the fields, add/remove/modify content.

Step 04 of 05

You can at any time Clear All fields, which will clear all the data in the tool.

Step 05 of 05

Once you are done with the modifications, press Update Existing Unity Package. If all the data is valid, the tool will override the data of the Unity Package you loaded using the Load Existing Unity Package.

Option C) Creating a new package from an existing package

Step 01, 02, 03 and 04 of 05

Same as Option B) Updating an existing package

Step 05 of 05

Once you are done with the modifications, press Create New Unity Package. If all the data is valid, the tool will ask you for the parent folder where you would like the tool to create the root tool folder and all the contents.