Unity-Technologies / Unity-Technologies/UnityDataTools

Support SerializedFile v26 (Unity 6.7)

Đang mở
#130 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Ngôn ngữ chính
C#
Star
821
Fork
71
Merge trung bình
3 giờ 13 phút
Pull request đã merge (30 ngày)
9

Mô tả

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

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu với mã phân tích lệnh của serialized-file và wrapper C# UnityFileSystemApi hiện có, sau đó kiểm tra các DLL trong snapshot beta của Unity 6.7 để tìm các thay đổi API và định dạng tệp được liệt kê. Xây dựng lại UnityProjects/LeadingEdge bằng Unity 6.7 để lấy các tệp tham chiếu, bổ sung coverage cho dữ liệu mới trong khi vẫn duy trì khả năng hỗ trợ các tệp cũ hơn, đồng thời cập nhật tài liệu và các chú thích TypeTree được đề cập.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
csharp, unity
Lĩnh vực
devtools, tooling
Loại issue
Tính năng
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Sôi nổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.