Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xsduan/unity-hierarchy-folders
Specialized folder objects for Unity Hierarchy.
https://github.com/xsduan/unity-hierarchy-folders
folders hierarchy unity unity-package-manager unity3d upm
Last synced: 15 days ago
JSON representation
Specialized folder objects for Unity Hierarchy.
- Host: GitHub
- URL: https://github.com/xsduan/unity-hierarchy-folders
- Owner: xsduan
- License: mit
- Created: 2017-11-18T16:32:11.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-26T15:22:25.000Z (7 months ago)
- Last Synced: 2024-10-14T07:41:53.374Z (about 1 month ago)
- Topics: folders, hierarchy, unity, unity-package-manager, unity3d, upm
- Language: C#
- Homepage:
- Size: 116 KB
- Stars: 106
- Watchers: 3
- Forks: 23
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Folders for Unity Hierarchy
Specialized folder objects for Unity Hierarchy.
## Installation
This uses the new UPM system. The old copy-into-Assets method still works
perfectly decent so if you don't want to bother with UPM just copy the `Editor`
and `Runtime` folders into your project.
To add this project, add a [git dependency][1] in your `manifest.json`:
```json
{
"dependencies": {
"com.unity.package-manager-ui": "1.9.11",
"com.xsduan.hierarchy-folders": "https://github.com/xsduan/unity-hierarchy-folders.git"
}
}
```
Older versions of Unity may have to use the relative link, ie:
```json
{
"dependencies": {
"com.unity.package-manager-ui": "1.9.11",
"com.xsduan.hierarchy-folders": "file:../../unity-hierarchy-folders"
}
}
```
A "Create Folder" menu item should show up in the GameObject menu. Add
`Tests/Example.unity` to your current scene for an example of what hierarchy
folders can do for you.
The UPM does not have much documentation at the moment so it probably will be
buggy, you're not going crazy!
[1]: https://forum.unity.com/threads/git-support-on-package-manager.573673/#post-3819487
### OpenUPM
Please note that this is a third party service, which means that Unity
Technologies will not provide support. Always be mindful when considering
unofficial plugins and tools.
```
$ openupm add com.xsduan.hierarchy-folders
```
To install OpenUPM, please see the [documentation][2].
[2]: https://openupm.com/docs/
## Stripping Modes
You can choose how exactly the folder will be removed from the hierarchy in **Preferences -> Hierarchy Folders**.
The following stripping modes are available:
- **Prepend With Folder Name** - The folder will be removed, and all child objects will be prepended with the folder name (e.g. childObject => Folder/childObject). This is the default behaviour.
- **Delete** - The folder will be removed, and names of child objects will not change.
- **Do Nothing** *(available only for Play Mode)* - The folder will not be removed, the hierarchy will not change in play mode. Use this mode if you don't need extra performance in Editor.
- **Replace With Separator** *(available only for Play Mode)* - The hierarchy will flatten, and the folder will be replaced with a separator (e.g. "--- FOLDER ---"). Useful if you need extra performance in Editor but still want to see what folder game objects belong to.
## Stripping folders from prefabs
With this plugin, it is possible to strip folders from prefabs that are not present in the scene but are instantiated at runtime. Upon entering Play Mode, the plugin goes through all prefabs containing folders and strips them. On exiting Play Mode, the changes are reverted. It shouldn't add significant overhead unless you have thousands of prefabs with folders inside, but if entering Play Mode takes too long, you can try disabling this option in **Preferences -> Hierarchy Folders**. You can also choose whether to strip folders from prefabs before they are packed into a build.
## Possible FAQs
### Why folders in the first place?
As projects get bigger, they tend to get cluttered in the scene. It's very
helpful if you can group them together into logical groups.
#### Why delete them on build then?
Because they are best used for level designers to declutter the hierarchy, but
calculating the global transform from the local during runtime can take a
noticeable impact on performance once scenes get to 1000, 10000, or more
objects.
#### So why can't I just use empty GameObjects and delete them on build?
Sometimes empty GameObjects are used for other things and it's useful to have a
specific type of object that should always be deleted on build.
Besides, I did all the legwork, so you wouldn't have to!
### There's another product/widget that exists that does this exact task.
So there are. This isn't exactly a unique concept and I only made it for future
personal use and shared it only to possibly to help other people because I
couldn't find it on Google.
If you are the owner of one such product, please contact me and we can work
something out.
The hope is to have it be a native component like it is in Unreal. (Not
necessarily this one specifically, but I'm not opposed to it ;) I've seen paid
components for this and frankly for the effort it took me it's a bit of a
rip-off to pay any amount for it. [Vote for this feature on the Unity
Productboard if you agree!](https://portal.productboard.com/ca1chnbwvzw1eg5yjc5rijnj/c/392-hierarchy-folders)