Skip to content

Commit

Permalink
rudimentary readme.md and fix missing protobuf dependency
Browse files Browse the repository at this point in the history
  • Loading branch information
190nm committed Jul 20, 2021
1 parent 0e51a57 commit 162de73
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 1 deletion.
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@


## Installing
Extract the release zip and run:
```python setup.py install```

## Usage

* *As a courtesy to other fans, please refrain from spoiling unreleased story contents if any are found after decrypting.*

* **An android device with root access is required, such as an emulator**

```
Default behavior with no arguments is to attempt to decrypt the cache and export json lists of new and changed resources.
optional arguments:
-r , --revision The target cache revision to read during parsing for new assets. Defaults to None.
-d, --decrypt Decrypt and export assets after processing the database. Defaults to False.
-e {all,new}, --export {all,new}
Which assets to export. Defaults to new
-k , --key Magic alphanumeric numbers.
-iv , --iv Magic base64-ish numbers.
```

Place the encrypted cache file `octocacheevai` in the root folder next to `reincli.py`.
It can be found at:

`\data\data\com.square_enix.android_googleplay.nierspjp\files\octo\pdb\201\<numbers>\octocacheevai`

The encrypted resources are located at:

`\data\data\com.square_enix.android_googleplay.nierspjp\files\v1\201\`

Move all of the files within to a folder in the script directory named `resources`. (Though only the ones with 32 character filenames such as `c2e196279db8b6a49db81e1a64cd344a` are necessary.)


## Decrypting all resources
```
python reinkuro.py --decrypt --export all
```

## Decrypting new resources
If it has been used before with an older cache version, the script may also decrypt only the new/changed resources found in the updated cache version.
(This is the default behaviour)
```
python reinkuro.py --decrypt
```
Empty file removed README.rst
Empty file.
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

package_data = {"": ["*"], "reinkuro._clibs": ["kuro/*"]}

install_requires = ["pycryptodome>=3.10.1,<4.0.0", "rich>=10.5.0,<11.0.0"]
install_requires = ["pycryptodome>=3.10.1,<4.0.0", "rich>=10.5.0,<11.0.0", "protobuf>=3.17.3,<4.0.0"]

setup_kwargs = {
"name": "reinkuro",
Expand Down

0 comments on commit 162de73

Please sign in to comment.