mbEditorPro2.0 release

2022-12-25 08:47:00 -05:00
1 parent 30375c8413
commit 942b33a252
@@ -1,12 +1,65 @@
- ```
-• ▌ ▄ ·. ▄▄▄▄·     ▄▄▄ .·▄▄▄▄  ▪  ▄▄▄▄▄      ▄▄▄       ▄▄▄·▄▄▄        
-·██ ▐███▪▐█ ▀█▪    ▀▄.▀·██▪ ██ ██ •██  ▪     ▀▄ █·    ▐█ ▄█▀▄ █·▪     
-▐█ ▌▐▌▐█·▐█▀▀█▄    ▐▀▀▪▄▐█· ▐█▌▐█· ▐█.▪ ▄█▀▄ ▐▀▀▄      ██▀·▐▀▀▄  ▄█▀▄ 
-██ ██▌▐█▌██▄▪▐█    ▐█▄▄▌██. ██ ▐█▌ ▐█▌·▐█▌.▐▌▐█•█▌    ▐█▪·•▐█•█▌▐█▌.▐▌
-▀▀  █▪▀▀▀·▀▀▀▀      ▀▀▀ ▀▀▀▀▀• ▀▀▀ ▀▀▀  ▀█▄▀▪.▀  ▀    .▀   .▀  ▀ ▀█▄▀▪
-
-                Magicbane Emulator Project © 2013 - 2022
-                           www.magicbane.com
+```
+ • ▌ ▄ ·. ▄▄▄▄·     ▄▄▄ .·▄▄▄▄  ▪  ▄▄▄▄▄      ▄▄▄       ▄▄▄·▄▄▄        
+ ·██ ▐███▪▐█ ▀█▪    ▀▄.▀·██▪ ██ ██ •██  ▪     ▀▄ █·    ▐█ ▄█▀▄ █·▪     
+ ▐█ ▌▐▌▐█·▐█▀▀█▄    ▐▀▀▪▄▐█· ▐█▌▐█· ▐█.▪ ▄█▀▄ ▐▀▀▄      ██▀·▐▀▀▄  ▄█▀▄ 
+ ██ ██▌▐█▌██▄▪▐█    ▐█▄▄▌██. ██ ▐█▌ ▐█▌·▐█▌.▐▌▐█•█▌    ▐█▪·•▐█•█▌▐█▌.▐▌
+ ▀▀  █▪▀▀▀·▀▀▀▀      ▀▀▀ ▀▀▀▀▀• ▀▀▀ ▀▀▀  ▀█▄▀▪.▀  ▀    .▀   .▀  ▀ ▀█▄▀▪
+               Magicbane Emulator Project © 2013 - 2022
+                          www.magicbane.com
 ```

-This repository holds the source code for mbEditorPro along with other tooling and data required to give every MagicBox administrator the ability to fully modify the game as they see fit.
+# mbEditorPro v 2.0
+
+![Example Output](https://cdn.discordapp.com/attachments/399623779531096074/1029063849640468550/unknown.png)
+
+Team Magicbane presents to the community technology allowing MagicBox administrators<br>
+to fully modify their game using nothing more than notepad.exe. <br>
+
+- Tool directly converts Shadowbane .cache files to and from a high fidelity pure JSON representation.
+- 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 Edltirch Technologies parses all Shadowbane .cache files giving the user complete control over the game<br>
+
+Team Magicbane aims to deliver you the best crackhead free MMO technology around; all for free!
+
+### Usage:
+```
+mbEditorPro.py unpack cobjects
+mbEditorPro.py unpack all
+```
+JSON output will be in a folder **ARCANE DUMP** <br>
+
+```
+mbEditorPro.py pack textures
+mbEditorPro.py pack all
+```
+
+New binary cache file will be built from the JSON and output in the current directory. <br>>
+
+> note: Unpacked data from a 2008 cache file is available in the Data repo.  Build a new cache file right out of the box.
+
+### Limitations
+
+Hirelings, ZoneEvents and Mobile Inventory are not parsed or written as there were no <br>
+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 goal is threefold:
+
+- Ship MagicBox 1.5 with both Aerynth and Vorringia mapsets available.
+- Integrate Magicbane's wpak extractor technology into the tool<br>
+
+
+