avatarchik / unity-scene-exporter

Export scenes between projects. Mainly used to fix scene script references when changing between DLL and source files. It can also map fields to new fieldnames to preserve data between script versions.

Unity-Scene-Exporter

The tool enables you to export scenes from one project to another without breaking script references.

The Problem

When moving a scene file from one project to another, unity will lose all idea of what scripts are attached to what gameobjects. This is because it uses a filedID and GUID to reference scripts which are project specific. To fix these references the tool will search the old project for the old GUIDs and generate the corresponding fileID. Causing unity to find the reference to the script and solving all script references in the scene.

The most helpful information about this issue can be found on the unity forum here.

Main usecase

This is currently used to port Source code demo projects to DLL projects. It started of as a hobby project that quickly became a work project. So i'd also like to thank unit040 for keeping this open source.

How to use

Installation

1. Have two projects, the old project and the new project. (The old project will have the scene we would like to export)
2. Copy the Assets/ImportExport/ folder to both projects.
3. Import json.net from the unity assetstore in both projects.
4. Import YamlDotNet from the unity assetstore in both projects.

Note

Usage

WARNING: ALWAYS BACK UP YOUR PROJECT. Although this tool is non-destructive, we're working with the source files of the project so make sure you ALWAYS have a backup.

1. In the old project open Window/Scene import window on the menubar and open the window.
2. Click the Export Class Data of the current project button and the project will start to export the IDs (these will be saved to <project_path>/ImportExport/Export/Export.json).
3. Now do the same for the new project.
4. In the new project open Window/Scene import window on the menubar and open the window.
5. Click the Export Class Data of the current project button and the project will start to export the IDs (these will be saved to <project_path>/ImportExport/Export/Export.json).
6. For larger projects this can last quite a while. The progressbar should keep updating.
7. When the IDs have been exported in the old and new project, go to the new project and open the Window/Scene import window window.
8. Click the Import IDs button, the tool will then open a window. This window selects which export to use. Go to your old project and select the <project_path>/ImportExport/Export/Export.json file.
9. The tool will then open a window to select which scene to use.
10. Select the scenefile you wish to update.
11. The tool will now start converting the scene.
12. The tool will then show popups to map classes for which it can't find the new class.
13. After it can mapp all classes it wil check whether or not data needs to be migrated. If it doesn't it's exported the scene. But if the fields of the classes that have been changed the mergewindow will appear where you can select where to map the fields to.
14. When you're done mapping the fields (make sure to do this as best as possible as mismatched fields will result in dataloss) press the Merge button.
15. The tool will now change all fields of the scripts to the new fields.

The Tool will make a copy of the file and write it to the Assets folder of the project.