Skip to content

Latest commit

 

History

History
110 lines (72 loc) · 4.68 KB

README.md

File metadata and controls

110 lines (72 loc) · 4.68 KB
Raw

Upkit — Unity3D project/package toolkit

Upkit is a command line toolkit that helps create/organize your Unity3D projects. With a simple configuration file, Upkit automatically resolves the project dependencies, symbolic-links them and generates a ready-to-use Unity project for you.

For those in a hurry, please go to Getting Started to see Upkit in action.

Why should you use it?

Our usecase

If you are like us, these are what you need when developing a Unity project:

  • Total separation of 3rd party assets, plugins, dependencies from your assets/codes, to reduce the project size.
  • Quick package swapping for prototyping and production.
  • Simple dependency resolving, from Nuget or Git repositories, or elsewhere.
  • Simple configuration.

Limitations of existing tools

At first glance, Upkit shares some similarities with Projeny, which is a great tool that we frequently used in our team. However, as Projeny model imposes a flat, exclusive package hierarchy, off-the-shelf packages do not often work well together. For example, two packages having the same native library folder Plugins/Android will clash. Even when there are no name clashes, Unity-compatible Nuget packages are not easily linked at times.

Unity 2018 officially comes with an easy-to-use built-in Package Manager. As of this writing, however, most of the Asset Store packages are still unavailable in the Package Manager, except those from Unity Technologies. Another drawback with current Package Manager is that we cannot use it for internal cross-project packages. This means that most of the time, we have to fall back to traditional approaches.

Upkit remedies those issues and adds some more tricks

Upkit was initially designed as our solution to the aforementioned limitations, which is a tool sitting between Nuget (dependency resolving step) and Projeny (project linking step) in our pipeline. As our projects evolve, we decided to simplify the whole process by combining the two steps into Upkit, making it even easier to use by adding the following features:

  • Single (YAML) file configuration, for dependency resolving, linking, etc.
  • Link anything with Linkspec ‐ determining how folders, files are linked to your Unity project.
  • Create distributable packages (with Linkspec).
  • Out-of-the-box support for Nuget and Git dependencies.

Getting Started

These instructions will use upkit to create a simple Unity3D project which depends on Newtonsoft.Json on Nuget Gallery.

The source code to this project can be also found under examples/simple-app.

Prerequisites

  • Python 2.7 or above, with pip.
  • (optional) nuget for resolving Nuget dependencies.
  • (optional) git for resolving Git dependencies.

Installation

$ pip install upkit

Step 1: Create Upkit project

Creating a new Upkit project is as simple as:

$ upkit create-package simple-app

Step 2: Edit Upkit config file upkit.yaml

Upkit will create a new folder named simple-app, where you can find upkit.yaml. This file contains all the information Upkit needs in order to create your Unity project. Now, modify it to let Upkit know the project will depends on NewtonSoft.Json:

# upkit.yaml
params:
  project: '{{__dir__}}/project'
  
links:
  - target: '{{__assets__}}'    
    source: '{{__dir__}}/assets'
    content: ['*']

  - target: '{{__plugins__}}'
    source: '{{__dir__}}/plugins'
    content: ['*']

  - target: '{{__project__}}/ProjectSettings'
    source: '{{__dir__}}/settings'
    
  - target: '{{__project__}}/Packages'
    source: '{{__dir__}}/packages'

  # Add project dependencies here: 
  - source: 'nuget:[email protected]#lib/net35'
    target: '{{__plugins__}}/Newtonsoft.Json'

Notice the second-last line where we instruct Upkit to resolve a Nuget library with nuget: scheme. Yes, it's that simple!

Step 3: Link to create Unity projects

The final step is to generate a Unity project, by calling:

$ cd simple-app 
$ upkit link

Upkit will take a few seconds to resolve project's dependencies and generate a Unity project under simple-app/project. Open the folder in Unity as a project and you are ready to go.

Documentation

Go to Project documentation

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • This tool uses xmltodict, pyyaml, yamlordereddictloader, and jinja2 under the hood. Thanks to the respected authors for the hard work.