Skip to content

Documentation correction and update #310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

isHarryh
Copy link
Contributor

Summary

This PR:

  • Fixes some spelling typo.
  • Removes the 404 links in the "Important Object Types" (they have been moved to legacy_patch).
  • Addes a "Configurations" section where user can have a full understanding of customization.
  • Moves "UnityPy Encryption" and "C-Typetree" related content to the "Configuration" section.

@K0lb3
Copy link
Owner

K0lb3 commented Apr 18, 2025

I will take a look at this PR tomorrow.
I had some important stuff to handle IRL, and afterwards some tasks that accumulated due to it.

From a glance the changes look fine, but as @3ncy already mentioned in his comments, some rephrasing change the meanings of the text, which has to be discussed.

README.md Outdated
flag = CompressionFlags.LZHAM

from UnityPy.helpers import CompressionHelper
CompressionHelper.COMPRESSION_MAP[flag] = some_function
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of some or another it's probably better to simply name them

custom_compression_function and custom_decompression function,
with a stub above to show their expected functions signature.

README.md Outdated
@@ -9,8 +9,9 @@
A Unity asset extractor for Python based on [AssetStudio](https://github.com/Perfare/AssetStudio).

Next to extraction, UnityPy also supports editing Unity assets.
Via the typetree structure all objects types can be edited.
```py
Via the typetree structure all object types can be edited.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might make sense to say can be edited in their native forms and then proceeding to say that some have handled export functions to make the export easier.

@K0lb3
Copy link
Owner

K0lb3 commented Apr 24, 2025

Sorry for the late response, I kinda forgot about the PR, and well, then Easter came with lots of hiking.

@isHarryh
Copy link
Contributor Author

Sorry for the late response, I kinda forgot about the PR, and well, then Easter came with lots of hiking.

That's okay. Btw, congratulations to UnityPy for receiving 1k stars!

I have updated the commits according to the suggestions from you and @3ncy . You can view the diffs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants