CLI tool for generating boilerplate Unity packages
Project description
Create Unity Package
This is a simple command line tool that automates the creation of Unity packages. It creates the boilerplate package structure and inserts user-specific information. This package is inspired by other developer CLI tools such as CreateReactApp.
This application follows the instructions offered by Unity. It creates new local packages in the directory that the application is run.
Please file any issues for bugs or desired features. Good luck with your development!
Usage
How to install
This tool is Python-based. So, you will need to install Python 3 if you don't already have it installed.
Option #1: Install from Pip: pip install create_unity_package
Option #2: Install from GitHub: pip install git+https://github.com/ShiJbey/create_unity_package.git
How to create a new Unity Package
Run the following command in a terminal and answer the prompts: create-unity-package
By default, this creates a new folder with the unique package
name entered during the prompts. If you would like to name the
folder differently, you can change the folder name afterward or
use the --output
argument when generating the package. For more
help use the --help
.
create-unity-package --output <YourPackageName>
In your current working directory it will create a new package directory with the name of your package. The directory structure of the package is shown below. Your package will be ready to import and configured for editor scripts, runtime scripts like MonoBehaviours, and UnityTestRunner tests.
<root>
├── package.json
├── README.md
├── CHANGELOG.md
├── LICENSE.md # Defaults to MIT License
├── .gitignore # If --git is used
├── Third Party Notices.md
├── Editor
│ ├── [company-name].[package-name].Editor.asmdef
├── Runtime
│ ├── [company-name].[package-name].asmdef
├── Tests
│ ├── Editor
│ │ ├── [company-name].[package-name].Editor.Tests.asmdef
│ └── Runtime
│ ├── [company-name].[package-name].Tests.asmdef
├── Samples~
│ └── [empty]
└── Documentation~
└── [package-name].md
How to import and edit package in Unity
Unity has detailed instructions for developing a local package. You can instructions for installing a local package here.
Now you should see the your package name in the Packages
directory
in Unity's file explorer.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file create_unity_package-1.0.4.tar.gz
.
File metadata
- Download URL: create_unity_package-1.0.4.tar.gz
- Upload date:
- Size: 12.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 04134807a1dabe3d4162ba6d83f2439bfae17f09bc7b213b09eb7ab704e1b869 |
|
MD5 | 8fd0f79b3a07e4f16145ef8860add045 |
|
BLAKE2b-256 | 06d9502481ae33b7f9906bb1da519608ea2c34f3928ebcf6829b046eabf80b29 |
File details
Details for the file create_unity_package-1.0.4-py3-none-any.whl
.
File metadata
- Download URL: create_unity_package-1.0.4-py3-none-any.whl
- Upload date:
- Size: 13.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb6bc54f3515e1fa1ded1e8d9bbed947ba5903a7954f14714bef9069cf611018 |
|
MD5 | 8aa5eac82dae809c035f17c014053a8a |
|
BLAKE2b-256 | 6781e82d4f17f6ca16cd5f85ff9cb553c5255ab6c199439f5e29c0e23bbe56b0 |