Unity-Technologies / Unity-Technologies/UnityDataTools

Support SerializedFile v26 (Unity 6.7)

Ouverte
#130 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
C#
Étoiles
821
Forks
71
Merge moyen
3 h 13 min
PR mergées (30 j)
9

Description

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

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par le code d’analyse des commandes de serialized-file et le wrapper C# UnityFileSystemApi existant, puis examinez les DLL du snapshot bêta de Unity 6.7 pour y rechercher les changements d’API et de format de fichier indiqués. Recompilez UnityProjects/LeadingEdge avec Unity 6.7 afin d’obtenir des fichiers de référence, ajoutez une couverture pour les nouvelles données tout en conservant la prise en charge des anciens fichiers, et mettez à jour la documentation et les commentaires TypeTree mentionnés.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
csharp, unity
Domaine
devtools, tooling
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
Active
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.