-
-
Notifications
You must be signed in to change notification settings - Fork 142
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
base: master
Are you sure you want to change the base?
Conversation
I will take a look at this PR tomorrow. 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 |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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.
Sorry for the late response, I kinda forgot about the PR, and well, then Easter came with lots of hiking. |
Summary
This PR:
legacy_patch
).