diff --git a/ShotgunSamples/README.md b/ShotgunSamples/README.md new file mode 100644 index 0000000..355d567 --- /dev/null +++ b/ShotgunSamples/README.md @@ -0,0 +1,30 @@ +Shotgun CSV Import Export +-------------------------- + +This sample shows how to create a timeline in Unity using a shot sequence from a Shotgun CSV export and export back modifications. + +**This package is ONLY needed if you are running Unity versions prior to 2019.1.** +If not, directly install `com.unity.film-tv.toolbox` via Package Manager window. + +### How to install + +* Download `ShotgunCSVImportExport.unitypackage` and import it in Unity +* This will import in your Assets folder : + * CSVImportExport.cs : a sample script demonstrating how to simply import / export a Shotgun CSV file + * shot.csv : a shotgun csv export sample, used in the import. + +### How to test + +* Go to `Window > Film-TV toolbox > Samples > Shotgun` and select `Import CSV` + * This creates a Timeline Asset (see shotgun_imported_timeline in the sample folder) from the `shot.csv` sample file : + ![Package Manager UI](../com.unity.film-tv.toolbox/Documentation~/images/ShotgunCSVImportResultTimeline.png) + +* Make edits to the Timeline asset + +* Go to `Window > Film-TV toolbox > Samples > Shotgun` and select `Export CSV`: + * See export_from_unity.csv in the sample folder + +### Limitations + +* Having commas in fields (e.g.: `Opening sequence, part 2`) will confuse the parser +* Having duplicate column names will cause errors due to duplicate keys \ No newline at end of file diff --git a/ShotgunSamples/ShotgunCSVImportExport.unitypackage b/ShotgunSamples/ShotgunCSVImportExport.unitypackage new file mode 100644 index 0000000..a1a7366 Binary files /dev/null and b/ShotgunSamples/ShotgunCSVImportExport.unitypackage differ