From c07073cc093d57b92629defd1387f1277352f802 Mon Sep 17 00:00:00 2001 From: MagicBot Date: Sun, 18 Oct 2026 12:05:37 -0400 Subject: [PATCH] Merge READMEs into the root README Bring the wpak documentation into the root README and remove the duplicate copy under mbEditorPro2.0. Co-Authored-By: Claude Opus 5.5 --- README.md | 18 +++++++- mbEditorPro2.0/README.md | 91 ---------------------------------------- 2 files changed, 16 insertions(+), 93 deletions(-) delete mode 100644 mbEditorPro2.0/README.md diff --git a/README.md b/README.md index b81bc35..2385eec 100644 --- a/README.md +++ b/README.md @@ -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.
- 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,20 @@ mbEditorPro.py pack all New binary cache file(s) will be built from the JSON and output into the current directory.
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).
+### wpak files + +``` +mbEditorPro.py unpack wpak +mbEditorPro.py unpack wpak Config +mbEditorPro.py pack wpak +mbEditorPro.py pack wpak Config +``` + +A .wpak is a zip archive whose entries are each Blowfish encrypted (.tga icons are stored unencrypted). +Unpack decrypts each pak into **ARCANE_DUMP/** (e.g. ARCANE_DUMP/Config), one file per entry. +Pack encrypts each folder back into .wpak. Name a single pak to work on just that one. +The same numbering rules as the caches apply.
+ ### Limitations Hirelings, ZoneEvents and Mobile Inventory are not parsed or written as there were no
@@ -65,10 +80,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.
### More Information diff --git a/mbEditorPro2.0/README.md b/mbEditorPro2.0/README.md deleted file mode 100644 index 91b7452..0000000 --- a/mbEditorPro2.0/README.md +++ /dev/null @@ -1,91 +0,0 @@ -``` - • ▌ ▄ ·. ▄▄▄▄· ▄▄▄ .·▄▄▄▄ ▪ ▄▄▄▄▄ ▄▄▄ ▄▄▄·▄▄▄ - ·██ ▐███▪▐█ ▀█▪ ▀▄.▀·██▪ ██ ██ •██ ▪ ▀▄ █· ▐█ ▄█▀▄ █·▪ - ▐█ ▌▐▌▐█·▐█▀▀█▄ ▐▀▀▪▄▐█· ▐█▌▐█· ▐█.▪ ▄█▀▄ ▐▀▀▄ ██▀·▐▀▀▄ ▄█▀▄ - ██ ██▌▐█▌██▄▪▐█ ▐█▄▄▌██. ██ ▐█▌ ▐█▌·▐█▌.▐▌▐█•█▌ ▐█▪·•▐█•█▌▐█▌.▐▌ - ▀▀ █▪▀▀▀·▀▀▀▀ ▀▀▀ ▀▀▀▀▀• ▀▀▀ ▀▀▀ ▀█▄▀▪.▀ ▀ .▀ .▀ ▀ ▀█▄▀▪ - Magicbane Emulator Project © 2013 - 2022 - www.magicbane.com -``` - -# mbEditorPro v 2.0 - -![Example JSON](https://cdn.discordapp.com/attachments/399623779531096074/1029063849640468550/unknown.png)
-![Example Textures](https://cdn.discordapp.com/attachments/534260038039109632/1056584030310641696/image.png)
-![Example Usage](https://cdn.discordapp.com/attachments/398522378545790976/1058787471544025138/image.png)
- -Team Magicbane presents to the community technology allowing MagicBox administrators
-to fully modify their game using nothing more than notepad.exe.
- -- 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. -- Want to raise all weapon damage by x%; Just modify item values as they are being parsed! - -The tool built with Eldritch Technologies parses **all Shadowbane .cache files** giving the user complete control over the game
- -Team Magicbane aims to deliver you the best crackhead free MMO technology around; all for free! - -### Requirements: - -mbEditorPro requires pillow for image manipulation and tqdm for metrics. - -```$ pip install -r requirements.txt``` - -### Usage: -``` -mbEditorPro.py unpack cobjects -mbEditorPro.py unpack all -``` -JSON output will be placed into the folder **ARCANE_DUMP**
-Unpack only reads the plain-named cache files (e.g. CObjects.cache). If a target folder already exists, a numbered folder is created instead (e.g. COBJECTS.1) so earlier output is never overwritten.
- -``` -mbEditorPro.py pack textures -mbEditorPro.py pack all -``` - -New binary cache file(s) will be built from the JSON and output into the current directory.
-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).
- -### wpak files - -``` -mbEditorPro.py unpack wpak -mbEditorPro.py unpack wpak Config -mbEditorPro.py pack wpak -mbEditorPro.py pack wpak Config -``` - -A .wpak is a zip archive whose entries are each Blowfish encrypted (.tga icons are stored unencrypted). -Unpack decrypts each pak into **ARCANE_DUMP/** (e.g. ARCANE_DUMP/Config), one file per entry. -Pack encrypts each folder back into .wpak. Name a single pak to work on just that one. -The same numbering rules as the caches apply.
- -### Limitations - -Hirelings, ZoneEvents and Mobile Inventory are not parsed or written as there were no
-examples in the .cache files to begin with. The game does seem to support them, however. - -### JSON - -The tool generating pure JSON has the following benefits: - -- It's ubiquitous and the tooling is mature. The standard interop exchange format. -- Human and machine-readable. -- Ease of importing into MySQL or other databases. -- Use as an intermediate representation to build a GUI World Editor or FBX importer. - -### Future - -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. -- Use data for a detailed audit of Magicbane's database.
- -### More Information - -See the mbEditorPro2.0 Wiki for more detailed information. -