Skip to content

Commit 7570c01

Browse files
committed
added notes to copy latest UnityFileSystemAPI and link to sdk 9 download
1 parent f93e368 commit 7570c01

1 file changed

Lines changed: 9 additions & 10 deletions

File tree

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,11 @@ content of Unity data files. You can directly jump
77
if your goal is to understand how to use the UnityDataTool command-line tool.
88

99
The UnityFileSystemApi library is distributed in the Tools folder of the Unity editor (starting in
10-
version 2022.1.0a14). For simplicity, it is also included in this repository. The library is
10+
version 2022.1.0a14). For simplicity, it is also included in this repository. The library is somewhat
1111
backward compatible, which means that it can read data files generated by any previous version of
12-
Unity.
13-
14-
Note that the UnityFileSystemApi library included in this repository is a custom version containing
15-
an additional function that is required to support the
16-
[SerializeReference](https://docs.unity3d.com/ScriptReference/SerializeReference.html)
17-
attribute. This version of the library will be included in future releases of Unity.
18-
12+
Unity. Ideally, you should copy UnityFileSystemApi (.dll/.dylib) from Unity Editor install path
13+
`Data/Tools/` subfolder to `UnityDataTool/UnityFileSystem/` of an Engine version that produced
14+
serialized data you want to analyze.
1915

2016
## What is the purpose of the UnityFileSystemApi native library?
2117

@@ -82,15 +78,18 @@ The repository contains the following items:
8278

8379
## How to build
8480

85-
The projects in this solution require the .NET 9.0 SDK. You can use your favorite IDE to build them.
81+
The projects in this solution require the [.NET 9.0 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/9.0).
82+
You can use your favorite IDE to build them.
8683
They were tested in Visual Studio on Windows and Rider on Mac.
8784

8885
It is also possible to build the projects from the CLI using this command:
8986

9087
`dotnet build -c Release`
9188

92-
## Disclaimer
89+
(Optional) Copying current editor `UnityFileSystemApi`(.so/.dll/.dylib) library from
90+
`{UnityEditor Install Folder}/Data/Tools/` to `UnityDataTool/UnityFileSystem/` before building.
9391

92+
## Disclaimer
9493
This project is provided on an "as-is" basis and is not officially supported by Unity. It is an
9594
experimental tool provided as an example of what can be done using the UnityFileSystemApi. You can
9695
report bugs and submit pull requests, but there is no guarantee that they will be addressed.

0 commit comments

Comments
 (0)