Guides

Migrating from 5.6 to 2017 LTS

🚧

Deprecated Guide

This guide is deprecated and no longer used! You're probably in the wrong place, but we're leaving this here in case there's some info you need in here.

You might be looking for the Migrating from 2018 LTS to 2019 LTS guide.

Migrating your project from Unity 5.6 to 2017.4 isn't as difficult as you might think! Here's a guide providing each step in detail.

How to install Unity Hub and Unity 2017.4.28f1

Unity Hub is a great tool that allows you to seamlessly install and work with multiple Unity versions at one time. We strongly recommend using it!

  1. Grab Unity Hub. You can find it on Unity's site by clicking here. Click on "Unity Hub", its the green button on the right.

  2. Once Unity Hub is installed, click this link to install the correct version of Unity.
    Alternately, go to this page, find Unity 2017.4.28, and click the "Unity Hub" button on the far left side.
    You can also go to this page, scroll down, and find Unity 2017.4.28f1.
    If you're having trouble finding the right version, use this link, but keep in mind you'll have to manually add the install to Unity Hub.

  3. Unity Hub will install Unity 2017.4.28f1. Make sure you're grabbing the right version!

  4. Once installed, go ahead and grab the VRChat SDK. Click this link to log into VRChat Home and download the SDK.

  5. If you're starting a new project, just create a new project. If you're migrating from 5.6, make a copy of your old project, and name it something different-- put 2017 at the end. Do not export your 5.6 project as a UnityPackage, that can take forever/have other errors. Just make a copy of your project folder.

6. If you're starting a new project, you can go to the 14th step. If you're migrating from Unity 5.6, you'll need to clear out some stuff. Use Explorer to delete the following files-- don't open Unity yet!

  1. First, delete the folder VRCSDK in your Assets directory. Also delete the VRCSDK.meta file in your Assets directory.

  2. Open your Plugins directory and delete the VRCSDK folder as well as the VRCSDK.meta file. If you don't have a Plugins directory, skip this step.

  3. Open "regedit". You can do this by typing regedit in your Start menu.

  4. If you're running Windows 10, paste this into the top bar:
    Computer\HKEY_CURRENT_USER\Software\Unity Technologies\Unity Editor 5.x
    If you're not running Windows 10, or an older version, go to the path manually. Yes, this path is correct even for Unity 2017.

  5. Delete all keys starting with VRC in that directory. Highlight them by dragging a box over them, right click, and click delete. ONLY DELETE the keys starting with VRC. Very important.

  6. Close regedit.

  7. Open your project. You'll have to click Open in Unity Hub, then find the directory of your 2017 project copy. Ensure that you select Unity 2017.4.28f1 as the Unity version to open the project with.

  8. If you're opening a project you're migrating, it can take a while (30min+ on a mechanical hard drive for large projects). Be patient!

  9. Open Unity and import the SDK into your new (or upgraded) Unity 2017.4 project as normal. Go to the Assets menu, then Import Package, then Import Custom Package.

  10. You should be good to go. Get back to creating!

Some tips:

  • Create copies of your projects before you import them. Importing a project into a newer version of Unity will make it very difficult/impossible to port it back to 5.6. Keep backups!!! We cannot help you with reverting your projects.

  • Read the blog! There's tons of info in there on the new features available, the upgrade process, and the plan moving forward. It is exceedingly important that you read the post.