PyREUser3 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- pyreuser3-0.1.0/LICENSE +21 -0
- pyreuser3-0.1.0/MANIFEST.in +7 -0
- pyreuser3-0.1.0/PKG-INFO +165 -0
- pyreuser3-0.1.0/PyREUser3.egg-info/PKG-INFO +165 -0
- pyreuser3-0.1.0/PyREUser3.egg-info/SOURCES.txt +40 -0
- pyreuser3-0.1.0/PyREUser3.egg-info/dependency_links.txt +1 -0
- pyreuser3-0.1.0/PyREUser3.egg-info/entry_points.txt +3 -0
- pyreuser3-0.1.0/PyREUser3.egg-info/requires.txt +5 -0
- pyreuser3-0.1.0/PyREUser3.egg-info/top_level.txt +1 -0
- pyreuser3-0.1.0/README.md +132 -0
- pyreuser3-0.1.0/docs/README.zh-CN.md +204 -0
- pyreuser3-0.1.0/pyproject.toml +58 -0
- pyreuser3-0.1.0/pyreuser3/__init__.py +65 -0
- pyreuser3-0.1.0/pyreuser3/__main__.py +7 -0
- pyreuser3-0.1.0/pyreuser3/api.py +410 -0
- pyreuser3-0.1.0/pyreuser3/cli.py +207 -0
- pyreuser3-0.1.0/pyreuser3/core.py +358 -0
- pyreuser3-0.1.0/pyreuser3/export/__init__.py +11 -0
- pyreuser3-0.1.0/pyreuser3/export/base.py +245 -0
- pyreuser3-0.1.0/pyreuser3/export/enums.py +171 -0
- pyreuser3-0.1.0/pyreuser3/export/fields.py +231 -0
- pyreuser3-0.1.0/pyreuser3/export/metadata.py +304 -0
- pyreuser3-0.1.0/pyreuser3/export/postprocess.py +346 -0
- pyreuser3-0.1.0/pyreuser3/export/tree.py +289 -0
- pyreuser3-0.1.0/pyreuser3/export/user3.py +415 -0
- pyreuser3-0.1.0/pyreuser3/pack/__init__.py +10 -0
- pyreuser3-0.1.0/pyreuser3/pack/base.py +281 -0
- pyreuser3-0.1.0/pyreuser3/pack/models.py +140 -0
- pyreuser3-0.1.0/pyreuser3/pack/plan.py +566 -0
- pyreuser3-0.1.0/pyreuser3/pack/writer.py +313 -0
- pyreuser3-0.1.0/pyreuser3/rich_ui.py +126 -0
- pyreuser3-0.1.0/pyreuser3/schema.py +193 -0
- pyreuser3-0.1.0/pyreuser3/web/__init__.py +6 -0
- pyreuser3-0.1.0/pyreuser3/web/__main__.py +6 -0
- pyreuser3-0.1.0/pyreuser3/web/handler.py +178 -0
- pyreuser3-0.1.0/pyreuser3/web/jobs.py +243 -0
- pyreuser3-0.1.0/pyreuser3/web/page.py +221 -0
- pyreuser3-0.1.0/pyreuser3/web/picker.py +92 -0
- pyreuser3-0.1.0/pyreuser3/web/runners.py +238 -0
- pyreuser3-0.1.0/pyreuser3/web/server.py +104 -0
- pyreuser3-0.1.0/pyreuser3/web/settings.py +42 -0
- pyreuser3-0.1.0/setup.cfg +4 -0
pyreuser3-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Egg Targaryen
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
pyreuser3-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: PyREUser3
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Pure Python tools for converting RE Engine .user.3 files to and from JSON.
|
|
5
|
+
Author: Egg Targaryen
|
|
6
|
+
License-Expression: MIT
|
|
7
|
+
Project-URL: Homepage, https://github.com/dzxrly/PyREUser3
|
|
8
|
+
Project-URL: Repository, https://github.com/dzxrly/PyREUser3
|
|
9
|
+
Project-URL: Issues, https://github.com/dzxrly/PyREUser3/issues
|
|
10
|
+
Keywords: RE Engine,user.3,JSON,modding,RSZ
|
|
11
|
+
Classifier: Development Status :: 4 - Beta
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Operating System :: OS Independent
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
22
|
+
Classifier: Topic :: File Formats
|
|
23
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
24
|
+
Classifier: Topic :: Utilities
|
|
25
|
+
Requires-Python: >=3.9
|
|
26
|
+
Description-Content-Type: text/markdown
|
|
27
|
+
License-File: LICENSE
|
|
28
|
+
Requires-Dist: rich>=13.0
|
|
29
|
+
Provides-Extra: dev
|
|
30
|
+
Requires-Dist: build>=1.2; extra == "dev"
|
|
31
|
+
Requires-Dist: twine>=5.0; extra == "dev"
|
|
32
|
+
Dynamic: license-file
|
|
33
|
+
|
|
34
|
+
# PyREUser3
|
|
35
|
+
|
|
36
|
+
English | [简体中文](./docs/README.zh-CN.md)
|
|
37
|
+
|
|
38
|
+
PyREUser3 is a pure Python package for converting RE Engine `.user.3` database files to JSON and packing compatible JSON back to `.user.3`.
|
|
39
|
+
|
|
40
|
+
Install it with:
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
pip install pyreuser3
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Import it with the same normalized package name:
|
|
47
|
+
|
|
48
|
+
```python
|
|
49
|
+
from pyreuser3 import REUser3Converter
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## What Is Included
|
|
53
|
+
|
|
54
|
+
- `.user.3 -> JSON` export.
|
|
55
|
+
- `JSON -> .user.3` packing.
|
|
56
|
+
- A reusable Python API through `REUser3Converter`.
|
|
57
|
+
- CLI commands through `pyreuser3`.
|
|
58
|
+
- A local `.user.3` export Web UI through `pyreuser3-web`.
|
|
59
|
+
|
|
60
|
+
This PyPI package intentionally does not include game resources, dumped game data, RE_RSZ templates, `il2cpp_dump.json`, `.msg.23` conversion tools, or repository-specific helper scripts.
|
|
61
|
+
|
|
62
|
+
## Requirements
|
|
63
|
+
|
|
64
|
+
- Python 3.9 or newer.
|
|
65
|
+
- A RE_RSZ schema JSON file for the target game/version.
|
|
66
|
+
- An `il2cpp_dump.json` file when exporting readable enum labels.
|
|
67
|
+
- One or more unpacked `.user.3` files.
|
|
68
|
+
|
|
69
|
+
## Command Line
|
|
70
|
+
|
|
71
|
+
Export `.user.3` files to JSON:
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
pyreuser3 export \
|
|
75
|
+
-i <input-user3-file-or-directory> \
|
|
76
|
+
-s <RE_RSZ-schema.json> \
|
|
77
|
+
-o <json-output-directory> \
|
|
78
|
+
-p <il2cpp_dump.json>
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Pack JSON back to `.user.3`:
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
pyreuser3 pack \
|
|
85
|
+
-j <input-json-file-or-directory> \
|
|
86
|
+
-s <RE_RSZ-schema.json> \
|
|
87
|
+
-o <user3-output-directory> \
|
|
88
|
+
-p <il2cpp_dump.json>
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
The `-p/--il2cpp-dump-path` option is required for export and optional for pack. Passing it during pack is recommended when enum names need to be resolved back to numeric values.
|
|
92
|
+
|
|
93
|
+
Start the local `.user.3` export Web UI:
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
pyreuser3-web --port 8765
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
The Web UI only handles `.user.3` export. It does not pack files and does not provide `.msg.23` conversion.
|
|
100
|
+
|
|
101
|
+
## Python API
|
|
102
|
+
|
|
103
|
+
```python
|
|
104
|
+
from pyreuser3 import REUser3Converter
|
|
105
|
+
|
|
106
|
+
converter = REUser3Converter(
|
|
107
|
+
schema_path="D:/schema/rsz_game.json",
|
|
108
|
+
il2cpp_dump_path="D:/game/il2cpp_dump.json",
|
|
109
|
+
)
|
|
110
|
+
|
|
111
|
+
converter.export_file(
|
|
112
|
+
"input/OtomonData.user.3",
|
|
113
|
+
"json/OtomonData.user.3.json",
|
|
114
|
+
)
|
|
115
|
+
|
|
116
|
+
converter.pack_file(
|
|
117
|
+
"json/OtomonData.user.3.json",
|
|
118
|
+
"mod/OtomonData.user.3",
|
|
119
|
+
)
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
For stable patch-and-repack workflows, use `patch_file()` or `parse_pack_file()`:
|
|
123
|
+
|
|
124
|
+
```python
|
|
125
|
+
from pyreuser3 import REUser3Converter
|
|
126
|
+
|
|
127
|
+
converter = REUser3Converter(
|
|
128
|
+
schema_path="D:/schema/rsz_game.json",
|
|
129
|
+
il2cpp_dump_path="D:/game/il2cpp_dump.json",
|
|
130
|
+
)
|
|
131
|
+
|
|
132
|
+
def patch(data, source_path):
|
|
133
|
+
# Modify the full instance-table JSON in place.
|
|
134
|
+
return None
|
|
135
|
+
|
|
136
|
+
converter.patch_file(
|
|
137
|
+
"input/example.user.3",
|
|
138
|
+
"output/example.user.3",
|
|
139
|
+
patch,
|
|
140
|
+
)
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
## Build From Source
|
|
144
|
+
|
|
145
|
+
```bash
|
|
146
|
+
python -m pip install -U build twine
|
|
147
|
+
python -m build
|
|
148
|
+
python -m twine check dist/*
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
Upload to TestPyPI first:
|
|
152
|
+
|
|
153
|
+
```bash
|
|
154
|
+
python -m twine upload -r testpypi dist/*
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
Then upload the same checked distribution files to PyPI:
|
|
158
|
+
|
|
159
|
+
```bash
|
|
160
|
+
python -m twine upload dist/*
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
## License
|
|
164
|
+
|
|
165
|
+
MIT License.
|
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: PyREUser3
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Pure Python tools for converting RE Engine .user.3 files to and from JSON.
|
|
5
|
+
Author: Egg Targaryen
|
|
6
|
+
License-Expression: MIT
|
|
7
|
+
Project-URL: Homepage, https://github.com/dzxrly/PyREUser3
|
|
8
|
+
Project-URL: Repository, https://github.com/dzxrly/PyREUser3
|
|
9
|
+
Project-URL: Issues, https://github.com/dzxrly/PyREUser3/issues
|
|
10
|
+
Keywords: RE Engine,user.3,JSON,modding,RSZ
|
|
11
|
+
Classifier: Development Status :: 4 - Beta
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Operating System :: OS Independent
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
22
|
+
Classifier: Topic :: File Formats
|
|
23
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
24
|
+
Classifier: Topic :: Utilities
|
|
25
|
+
Requires-Python: >=3.9
|
|
26
|
+
Description-Content-Type: text/markdown
|
|
27
|
+
License-File: LICENSE
|
|
28
|
+
Requires-Dist: rich>=13.0
|
|
29
|
+
Provides-Extra: dev
|
|
30
|
+
Requires-Dist: build>=1.2; extra == "dev"
|
|
31
|
+
Requires-Dist: twine>=5.0; extra == "dev"
|
|
32
|
+
Dynamic: license-file
|
|
33
|
+
|
|
34
|
+
# PyREUser3
|
|
35
|
+
|
|
36
|
+
English | [简体中文](./docs/README.zh-CN.md)
|
|
37
|
+
|
|
38
|
+
PyREUser3 is a pure Python package for converting RE Engine `.user.3` database files to JSON and packing compatible JSON back to `.user.3`.
|
|
39
|
+
|
|
40
|
+
Install it with:
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
pip install pyreuser3
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Import it with the same normalized package name:
|
|
47
|
+
|
|
48
|
+
```python
|
|
49
|
+
from pyreuser3 import REUser3Converter
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## What Is Included
|
|
53
|
+
|
|
54
|
+
- `.user.3 -> JSON` export.
|
|
55
|
+
- `JSON -> .user.3` packing.
|
|
56
|
+
- A reusable Python API through `REUser3Converter`.
|
|
57
|
+
- CLI commands through `pyreuser3`.
|
|
58
|
+
- A local `.user.3` export Web UI through `pyreuser3-web`.
|
|
59
|
+
|
|
60
|
+
This PyPI package intentionally does not include game resources, dumped game data, RE_RSZ templates, `il2cpp_dump.json`, `.msg.23` conversion tools, or repository-specific helper scripts.
|
|
61
|
+
|
|
62
|
+
## Requirements
|
|
63
|
+
|
|
64
|
+
- Python 3.9 or newer.
|
|
65
|
+
- A RE_RSZ schema JSON file for the target game/version.
|
|
66
|
+
- An `il2cpp_dump.json` file when exporting readable enum labels.
|
|
67
|
+
- One or more unpacked `.user.3` files.
|
|
68
|
+
|
|
69
|
+
## Command Line
|
|
70
|
+
|
|
71
|
+
Export `.user.3` files to JSON:
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
pyreuser3 export \
|
|
75
|
+
-i <input-user3-file-or-directory> \
|
|
76
|
+
-s <RE_RSZ-schema.json> \
|
|
77
|
+
-o <json-output-directory> \
|
|
78
|
+
-p <il2cpp_dump.json>
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Pack JSON back to `.user.3`:
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
pyreuser3 pack \
|
|
85
|
+
-j <input-json-file-or-directory> \
|
|
86
|
+
-s <RE_RSZ-schema.json> \
|
|
87
|
+
-o <user3-output-directory> \
|
|
88
|
+
-p <il2cpp_dump.json>
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
The `-p/--il2cpp-dump-path` option is required for export and optional for pack. Passing it during pack is recommended when enum names need to be resolved back to numeric values.
|
|
92
|
+
|
|
93
|
+
Start the local `.user.3` export Web UI:
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
pyreuser3-web --port 8765
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
The Web UI only handles `.user.3` export. It does not pack files and does not provide `.msg.23` conversion.
|
|
100
|
+
|
|
101
|
+
## Python API
|
|
102
|
+
|
|
103
|
+
```python
|
|
104
|
+
from pyreuser3 import REUser3Converter
|
|
105
|
+
|
|
106
|
+
converter = REUser3Converter(
|
|
107
|
+
schema_path="D:/schema/rsz_game.json",
|
|
108
|
+
il2cpp_dump_path="D:/game/il2cpp_dump.json",
|
|
109
|
+
)
|
|
110
|
+
|
|
111
|
+
converter.export_file(
|
|
112
|
+
"input/OtomonData.user.3",
|
|
113
|
+
"json/OtomonData.user.3.json",
|
|
114
|
+
)
|
|
115
|
+
|
|
116
|
+
converter.pack_file(
|
|
117
|
+
"json/OtomonData.user.3.json",
|
|
118
|
+
"mod/OtomonData.user.3",
|
|
119
|
+
)
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
For stable patch-and-repack workflows, use `patch_file()` or `parse_pack_file()`:
|
|
123
|
+
|
|
124
|
+
```python
|
|
125
|
+
from pyreuser3 import REUser3Converter
|
|
126
|
+
|
|
127
|
+
converter = REUser3Converter(
|
|
128
|
+
schema_path="D:/schema/rsz_game.json",
|
|
129
|
+
il2cpp_dump_path="D:/game/il2cpp_dump.json",
|
|
130
|
+
)
|
|
131
|
+
|
|
132
|
+
def patch(data, source_path):
|
|
133
|
+
# Modify the full instance-table JSON in place.
|
|
134
|
+
return None
|
|
135
|
+
|
|
136
|
+
converter.patch_file(
|
|
137
|
+
"input/example.user.3",
|
|
138
|
+
"output/example.user.3",
|
|
139
|
+
patch,
|
|
140
|
+
)
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
## Build From Source
|
|
144
|
+
|
|
145
|
+
```bash
|
|
146
|
+
python -m pip install -U build twine
|
|
147
|
+
python -m build
|
|
148
|
+
python -m twine check dist/*
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
Upload to TestPyPI first:
|
|
152
|
+
|
|
153
|
+
```bash
|
|
154
|
+
python -m twine upload -r testpypi dist/*
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
Then upload the same checked distribution files to PyPI:
|
|
158
|
+
|
|
159
|
+
```bash
|
|
160
|
+
python -m twine upload dist/*
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
## License
|
|
164
|
+
|
|
165
|
+
MIT License.
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
LICENSE
|
|
2
|
+
MANIFEST.in
|
|
3
|
+
README.md
|
|
4
|
+
pyproject.toml
|
|
5
|
+
PyREUser3.egg-info/PKG-INFO
|
|
6
|
+
PyREUser3.egg-info/SOURCES.txt
|
|
7
|
+
PyREUser3.egg-info/dependency_links.txt
|
|
8
|
+
PyREUser3.egg-info/entry_points.txt
|
|
9
|
+
PyREUser3.egg-info/requires.txt
|
|
10
|
+
PyREUser3.egg-info/top_level.txt
|
|
11
|
+
docs/README.zh-CN.md
|
|
12
|
+
pyreuser3/__init__.py
|
|
13
|
+
pyreuser3/__main__.py
|
|
14
|
+
pyreuser3/api.py
|
|
15
|
+
pyreuser3/cli.py
|
|
16
|
+
pyreuser3/core.py
|
|
17
|
+
pyreuser3/rich_ui.py
|
|
18
|
+
pyreuser3/schema.py
|
|
19
|
+
pyreuser3/export/__init__.py
|
|
20
|
+
pyreuser3/export/base.py
|
|
21
|
+
pyreuser3/export/enums.py
|
|
22
|
+
pyreuser3/export/fields.py
|
|
23
|
+
pyreuser3/export/metadata.py
|
|
24
|
+
pyreuser3/export/postprocess.py
|
|
25
|
+
pyreuser3/export/tree.py
|
|
26
|
+
pyreuser3/export/user3.py
|
|
27
|
+
pyreuser3/pack/__init__.py
|
|
28
|
+
pyreuser3/pack/base.py
|
|
29
|
+
pyreuser3/pack/models.py
|
|
30
|
+
pyreuser3/pack/plan.py
|
|
31
|
+
pyreuser3/pack/writer.py
|
|
32
|
+
pyreuser3/web/__init__.py
|
|
33
|
+
pyreuser3/web/__main__.py
|
|
34
|
+
pyreuser3/web/handler.py
|
|
35
|
+
pyreuser3/web/jobs.py
|
|
36
|
+
pyreuser3/web/page.py
|
|
37
|
+
pyreuser3/web/picker.py
|
|
38
|
+
pyreuser3/web/runners.py
|
|
39
|
+
pyreuser3/web/server.py
|
|
40
|
+
pyreuser3/web/settings.py
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
pyreuser3
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
# PyREUser3
|
|
2
|
+
|
|
3
|
+
English | [简体中文](./docs/README.zh-CN.md)
|
|
4
|
+
|
|
5
|
+
PyREUser3 is a pure Python package for converting RE Engine `.user.3` database files to JSON and packing compatible JSON back to `.user.3`.
|
|
6
|
+
|
|
7
|
+
Install it with:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
pip install pyreuser3
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Import it with the same normalized package name:
|
|
14
|
+
|
|
15
|
+
```python
|
|
16
|
+
from pyreuser3 import REUser3Converter
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## What Is Included
|
|
20
|
+
|
|
21
|
+
- `.user.3 -> JSON` export.
|
|
22
|
+
- `JSON -> .user.3` packing.
|
|
23
|
+
- A reusable Python API through `REUser3Converter`.
|
|
24
|
+
- CLI commands through `pyreuser3`.
|
|
25
|
+
- A local `.user.3` export Web UI through `pyreuser3-web`.
|
|
26
|
+
|
|
27
|
+
This PyPI package intentionally does not include game resources, dumped game data, RE_RSZ templates, `il2cpp_dump.json`, `.msg.23` conversion tools, or repository-specific helper scripts.
|
|
28
|
+
|
|
29
|
+
## Requirements
|
|
30
|
+
|
|
31
|
+
- Python 3.9 or newer.
|
|
32
|
+
- A RE_RSZ schema JSON file for the target game/version.
|
|
33
|
+
- An `il2cpp_dump.json` file when exporting readable enum labels.
|
|
34
|
+
- One or more unpacked `.user.3` files.
|
|
35
|
+
|
|
36
|
+
## Command Line
|
|
37
|
+
|
|
38
|
+
Export `.user.3` files to JSON:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
pyreuser3 export \
|
|
42
|
+
-i <input-user3-file-or-directory> \
|
|
43
|
+
-s <RE_RSZ-schema.json> \
|
|
44
|
+
-o <json-output-directory> \
|
|
45
|
+
-p <il2cpp_dump.json>
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Pack JSON back to `.user.3`:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
pyreuser3 pack \
|
|
52
|
+
-j <input-json-file-or-directory> \
|
|
53
|
+
-s <RE_RSZ-schema.json> \
|
|
54
|
+
-o <user3-output-directory> \
|
|
55
|
+
-p <il2cpp_dump.json>
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
The `-p/--il2cpp-dump-path` option is required for export and optional for pack. Passing it during pack is recommended when enum names need to be resolved back to numeric values.
|
|
59
|
+
|
|
60
|
+
Start the local `.user.3` export Web UI:
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
pyreuser3-web --port 8765
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
The Web UI only handles `.user.3` export. It does not pack files and does not provide `.msg.23` conversion.
|
|
67
|
+
|
|
68
|
+
## Python API
|
|
69
|
+
|
|
70
|
+
```python
|
|
71
|
+
from pyreuser3 import REUser3Converter
|
|
72
|
+
|
|
73
|
+
converter = REUser3Converter(
|
|
74
|
+
schema_path="D:/schema/rsz_game.json",
|
|
75
|
+
il2cpp_dump_path="D:/game/il2cpp_dump.json",
|
|
76
|
+
)
|
|
77
|
+
|
|
78
|
+
converter.export_file(
|
|
79
|
+
"input/OtomonData.user.3",
|
|
80
|
+
"json/OtomonData.user.3.json",
|
|
81
|
+
)
|
|
82
|
+
|
|
83
|
+
converter.pack_file(
|
|
84
|
+
"json/OtomonData.user.3.json",
|
|
85
|
+
"mod/OtomonData.user.3",
|
|
86
|
+
)
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
For stable patch-and-repack workflows, use `patch_file()` or `parse_pack_file()`:
|
|
90
|
+
|
|
91
|
+
```python
|
|
92
|
+
from pyreuser3 import REUser3Converter
|
|
93
|
+
|
|
94
|
+
converter = REUser3Converter(
|
|
95
|
+
schema_path="D:/schema/rsz_game.json",
|
|
96
|
+
il2cpp_dump_path="D:/game/il2cpp_dump.json",
|
|
97
|
+
)
|
|
98
|
+
|
|
99
|
+
def patch(data, source_path):
|
|
100
|
+
# Modify the full instance-table JSON in place.
|
|
101
|
+
return None
|
|
102
|
+
|
|
103
|
+
converter.patch_file(
|
|
104
|
+
"input/example.user.3",
|
|
105
|
+
"output/example.user.3",
|
|
106
|
+
patch,
|
|
107
|
+
)
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## Build From Source
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
python -m pip install -U build twine
|
|
114
|
+
python -m build
|
|
115
|
+
python -m twine check dist/*
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
Upload to TestPyPI first:
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
python -m twine upload -r testpypi dist/*
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
Then upload the same checked distribution files to PyPI:
|
|
125
|
+
|
|
126
|
+
```bash
|
|
127
|
+
python -m twine upload dist/*
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
## License
|
|
131
|
+
|
|
132
|
+
MIT License.
|