d12frosted / unitylibraryswitcher

Unity plugin for switching build targets, git branches without endless assets reimport. Not maintained anymore.

Unity Library Switcher

Unity Library Switcher is a Unity3d plugin for switching build targets and git branches without the burden of assets reimporting.

Install

In order to install UnityLibrarySwitcher you have two options. First one is to download unitypackage file and open it. Second option is to clone this repository or download sources and copy UnityProject/Assets/UnityLibrarySwitcher folder to your project assets folder. Just don’t forget to add LibrarySwitcherCache folder to .gitignore file.

For Windows users this plugin is working but not as perfect as on OS X. UnityLibrarySwitcher needs path to bash or sh that already is configured to work with git. By default it assumes that you have installed GitHub Client to C:\Program Files (x86)\Git. In case it’s not what you are using - feel free to change following line in MonoBasher.cs.

private static string ShellPath = @"C:\Program Files (x86)\Git\bin\sh";

In case you want to improve things on Windows - pull requests are highly appreciated.

How it works

You have two actions:

1. switch build target
2. switch git branch

Both actions are available from the plugin window, which is accessible from Window/Library Switcher menu.

Library folder is cached for every (branch, target) pair. When you perform any action, the plugin will cache Library folder for current (branch, target) pair and then replace Library folder by the cached library of selected (branch, target) pair if it exists. To make things work faster plugin copies Library folder only in case you are moving to the (branch, target) pair that wasn’t cached before. If it was already cached, then plugin just moves directories around. All cached Library folders are stored in LibrarySwitcherCache folder in unity project root directory. (branch, target) pair’s Library folder is stored at LibrarySwitcherCache/branch/target.

Limitations

• Due to the implementation details you should change build target or git branch only from the plugin window. Otherwise you will run into unnecessary imports.
• Branch switching only works with locally existing branches.

Contributing

Pull requests, feature requests are warmly welcome!

Issues / Tasks

Please, see Issues section.

More reading

You can find more information about this project in this blog post.

unitylibraryswitcher's Issues

Add a keybinding to bring up the plugin window

Unsupported target platforms

In the Select target drop-down list there are all build targets, even those user can’t switch to because of licence restrictions. I suggest to filter this list if it’s possible.

Support for non-GIT repositories

This asset causes exceptions when you using SVN. Would you consider making the GIT requirement optional ?

Add force update button

This button should force update following things:

• list of branches
• list of cached libraries and their info

List of Cached Libraries

We should show the list of cached library folders. I am not sure how to visualize it - the overall design is a matter of change in future, but think about following points.

• List all cached directories.
• Calculate size of each cached library directory.
• Show total size of cache directory.
• Make it possible to remove cached library from this list.
• Show the date of cache creation, because sometimes it’s critical to know in order to make switch as fast as possible

Update screenshots

Now there is a list of cached stuff, so I should update screenshot. Also, the current one has a terrible quality.

Add support of branch switching on Windows

It should not work on Windows. But honestly I even haven't tested.

Possible problems when editor fails to switch the target

Target switch process can fail because of following reasons.

1. User cancels the process.
2. Target platform is not available for user due to licence etc.

We can’t swap library folder after switching the target, because this process leads to recompilation and reimporting. We can’t foresee the failure of target switch, so in case of failure we should swap library back.