Document wpak support in README

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
MagicBotandClaude Opus 5.5 committed 2026-10-18 11:22:52 -04:00
1 parent a312c9270a
commit 8a8ebc5632
1 file changed
+12 -2
+12 -2
View File
@@ -18,6 +18,7 @@ Team Magicbane presents to the community technology allowing MagicBox administra
to fully modify their game using nothing more than notepad.exe. <br>
- Tool directly converts Shadowbane .cache file data to and from a high fidelity pure JSON representation.
- Shadowbane .wpak archives are decrypted to and from their plain text config files.
- Media such as textures and sound are converted in-situ.
- Enumerations are used throughout hiding from the user ugly signed ulong values.
- Written in Python and open-source allowing modification and extension with ease.
@@ -49,6 +50,16 @@ mbEditorPro.py pack all
New binary cache file(s) will be built from the JSON and output into the current directory. <br>
Pack only reads from the un-numbered folders (e.g. COBJECTS). If a cache file already exists, a numbered copy is written instead (e.g. CObjects.cache.1). <br>
### wpak files
```
mbEditorPro.py unpack config
mbEditorPro.py pack config
```
A .wpak is a zip archive whose entries are each Blowfish encrypted. Unpack decrypts Config.wpak into **ARCANE_DUMP/Config**,
one plain text file per entry. Pack encrypts that folder back into Config.wpak. The same numbering rules as the caches apply. <br>
### Limitations
Hirelings, ZoneEvents and Mobile Inventory are not parsed or written as there were no <br>
@@ -65,10 +76,9 @@ The tool generating pure JSON has the following benefits:
### Future
mbEditorPro will be the cornerstone of Magicbane's data project. The Team's goals are threefold:
mbEditorPro will be the cornerstone of Magicbane's data project. The Team's goals are twofold:
- Ship MagicBox 1.5 with both Aerynth and Vorringia mapsets.
- Integrate Magicbane's wpak extractor technology into the tool.
- Use data for a detailed audit of Magicbane's database.<br>
### More Information