Unity-Technologies / Unity-Technologies/UnityDataTools

Document tips for using UnityDataTool with Library AssetDatabase artifacts

Open
#94 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
821
Forks
71
Avg merge
3h 13m
Merged PRs (30d)
9

Description

The AssetDatabase uses binary serialized files to represent imported Assets.

UnityDataTool can read such files, e.g. the dump command and can be a nicer alternative to the older binary2text tool that is typically used for this case.

It should only be necessary to look in these files in quite advanced cases. But it could be useful when developing custom scripted importers, or education about how Unity works, or for tracking a problem through the full pipeline from source to build output (e.g. for FBX files, or Scenes)

The Import Activity window shows Artifacts and has a "Show in Explorer" option for retrieving that artifact as a file. This is worth describing. We should also show how to do this from script (if possible using public APIs?)

Note: There are some changes in how these artifacts represented in recent versions of Unity, e.g. introduction of Unity Data Store (UDS) so the topic may have make information conditional on the version of Unity.

This task is to offer some

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with UnityDataTool's dump command and the Import Activity window's "Show in Explorer" workflow. Verify whether public scripting APIs can retrieve artifacts and account for version differences such as Unity Data Store; the documentation is done when it explains artifact access, relevant use cases, and those caveats.

Written by the indexing model from the issue text.

Assessment

Tech stack
unity
Domain
documentation, game-dev, tooling
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.