Update 'mbEditor Pro'

2022-10-10 17:27:01 +00:00
parent bbbba0dd44
commit 2c0a564859
1 changed files with 68 additions and 0 deletions
@@ -0,0 +1,68 @@
+```
+ • ▌ ▄ ·. ▄▄▄▄·     ▄▄▄ .·▄▄▄▄  ▪  ▄▄▄▄▄      ▄▄▄       ▄▄▄·▄▄▄        
+ ·██ ▐███▪▐█ ▀█▪    ▀▄.▀·██▪ ██ ██ •██  ▪     ▀▄ █·    ▐█ ▄█▀▄ █·▪     
+ ▐█ ▌▐▌▐█·▐█▀▀█▄    ▐▀▀▪▄▐█· ▐█▌▐█· ▐█.▪ ▄█▀▄ ▐▀▀▄      ██▀·▐▀▀▄  ▄█▀▄ 
+ ██ ██▌▐█▌██▄▪▐█    ▐█▄▄▌██. ██ ▐█▌ ▐█▌·▐█▌.▐▌▐█•█▌    ▐█▪·•▐█•█▌▐█▌.▐▌
+ ▀▀  █▪▀▀▀·▀▀▀▀      ▀▀▀ ▀▀▀▀▀• ▀▀▀ ▀▀▀  ▀█▄▀▪.▀  ▀    .▀   .▀  ▀ ▀█▄▀▪
+               Magicbane Emulator Project © 2013 - 2022
+                          www.magicbane.com
+```
+
+# mbEditorPro v 1.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 fidality 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 currently parses both the CObject.cache and the Czones.cache files.  These were chosen<br>
+to start with as they will allow a MagicBox administrator to modify the game.  The remainder of the <br>
+existing .cache files modify how the game looks and will be added soon.<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 czones
+```
+JSON output will be in a folder **ARCANE DUMP** <br>
+
+```
+mbEditorPro.py pack cobjects
+mbEditorPro.py pack czones
+```
+
+New binary cache file will be built from the JSON and output in the current directory. <br>>
+
+> note: Tool comes stocked with unpacked data from a 2008 cache file.  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:
+
+- Build tooling to generate high fidality Magicbane databases from the JSON data.
+- Build up the tool and technology to parse the remaining .cache file.
+- Ship MagicBox 1.5 with both Aerynth and Vorringia mapsets available.<br>
+
+
+