Unity-Technologies / Unity-Technologies/UnityDataTools

Support SerializedFile v26 (Unity 6.7)

オープン
#130 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
C#
スター
821
フォーク
71
平均マージ
3時間 13分
マージ済み PR(30日)
9

説明

Unity 6.6 is v23 of the file format.
At end of alpha Unity 6.7 has reached v26, with several significant changes.

    kIndependentTypeTreeVersion = 24, // 6000.7: TypeTree blobs are now versioned by their own TypeTreeFormatVersion instead of this enum; TypeTree format changes no longer bump the serialized file version.
    kSerializeReferenceRegistryFirst = 25, // 6000.7: the [SerializeReference] registry is a leading frame in the object's data (v3 table format) instead of a trailing TypeTree-described node. Older readers would misparse the frame bytes as field data, so they must reject the file on version.
    kSharedSubtreeSupport = 26, // Shared sub-typetree referencing: the file carries a table of compound subtrees stored once, keyed by content hash, that its types reference

This means the "dump", "analyze" commands will not work with the output from Unity 6.7

Most subcommands of the "serialized-file" will also not work (but the "header" command does work, that can be used to see the serialized file version)

Work includes:

  • Updating to new snapshot UnityFileSystemApi dll (windows/mac/linux), e.g. take a snapshot from an official build of Unity 6.7 beta.
  • Expose the API changes in UnityFileSystemApi through the C# wrapper
  • Change the parsing code used by serialized-file command to reflect the updated file format (but continue to support reading older files)
  • Add some reference files for automated tests
    • e.g. rebuild the UnityProjects/LeadingEdge project with Unity 6.7)
    • ideally add refernce files that demonstrate any new features and add specific tests for how this data is exposed
  • Make sure docs / comments are updated to reflect the changes, e.g. any docs about TypeTrees should be revisited, and the serialized reference registry change may also influence the example.
  • Update UnityDataTools version and create a release for download (along with other fixes).

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

serialized-file のコマンド解析コードと既存の UnityFileSystemApi C# ラッパーから始め、次に Unity 6.7 ベータスナップショットの DLL を調べて、記載された API とファイル形式の変更を確認します。Unity 6.7 で UnityProjects/LeadingEdge を再ビルドして参照ファイルを取得し、古いファイルのサポートを維持しながら新しいデータのカバレッジを追加し、言及されている TypeTree のドキュメントとコメントを更新します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
csharp, unity
領域
devtools, tooling
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
活発
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。