HTTPS SSH

README

Nested Prefabs for Unity is a fully integrated and completely automatic nested prefab solution for Unity. The plugin itself can be found on the Unity Asset Store.

Nested Prefabs version 1.3.0 or higher is required in order to build the plugin with the source in this repository.

The Nested Prefabs plugin consists of three separate parts:

  • Assemblies (Subset)
    Contains shared code between multiple Visual Design Cafe projects, named the Assemblies project. Nested Prefabs only contains a subset of the full library, as not all code is required to run the plugin.
  • Nested Prefabs Library
    Contains the core functionality for Nested Prefabs. All code for nesting prefabs, applying changes, overriding properties, and UI is present in this library.
  • Nested Prefabs Package Manager
    Installs, updates, uninstalls, and starts the Nested Prefabs plugin. Miscellaneous code to install and run the plugin. Does not directly influence any of the functionality for nesting prefabs, however, it is essential for installing and running the plugin.

This repository contains all code for the Nested Prefabs Library. The other parts are currently not available for download.

What and who is this repository for?

  • To extend the plugin with custom functionality tailored to a specific project or organization.
  • For those who want to have a copy of the source code as backup.
  • Anyone who wishes to improve the plugin with new features, bug fixes, or improvements.

How do I build Nested Prefabs?

  1. Download the source code or clone this repository.
  2. Open the Visual Studio Solution in the Visual Studio~ folder.
  3. Add references to the Assemblies folder from the Asset Store Package. (VisualDesignCafe.Editor.dll and VisualDesignCafe.Editor.Analytics.dll). By default the solution contains references to these assemblies in an Assemblies~ folder. You can either replace these references, or copy the Assemblies folder from the Asset Store Package to the root folder of this repository and rename it to Assemblies~.
  4. Build the solution.
  5. Copy the created assemblies (NestedPrefabs.dll and NestedPrefabs.Editor.dll) into your Unity project.

Contribution guidelines

  • All code in the plugin should target Unity 5.0. If a feature is targeted at a higher version of Unity and uses functionality that is not available in Unity 5.0 then please use reflection to retrieve the required methods and make sure the feature can be ignored safely in older versions of Unity.
  • All new features should come with Unit Tests. This repository does not contain the unit tests for Nested Prefabs at the moment. These will be added soon along with a testing API.
  • Pull requests will be tested with our full list of Unit Tests. The pull request will only be accepted if all tests pass. These tests contain most user-actions such as adding/removing components, children, properties, etc.

Who do I talk to?

  • For specific issues with the plugin please create a new issue or write a comment on an existing issue in the public issue tracker.
  • For other questions and/or inquiries please send an email to support@visualdesigncafe.com