Unity-Technologies / Unity-Technologies/UnityDataTools

Support SerializedFile v26 (Unity 6.7)

Offen
#130 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
C#
Sterne
821
Forks
71
Ø Merge
3 Std. 13 Min.
Gemergte PRs (30 T.)
9

Beschreibung

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).

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit dem Code zur Befehlsanalyse für serialized-file und dem vorhandenen UnityFileSystemApi C#-Wrapper; untersuche anschließend die DLLs des Unity 6.7-Beta-Snapshots auf die aufgeführten Änderungen an API und Dateiformat. Baue UnityProjects/LeadingEdge mit Unity 6.7 neu, um Referenzdateien zu erhalten, füge Abdeckung für die neuen Daten hinzu und bewahre dabei die Unterstützung für ältere Dateien, und aktualisiere die erwähnte TypeTree-Dokumentation und die Kommentare.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp, unity
Bereich
devtools, tooling
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Aktiv
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.