cleanup, update readme - release 0.1.0

CHANGELOG.md

@@ -1,5 +1,13 @@
 #Changelog
 
+**2018-08-26**: **v0.1.0** Release:
+* Add MLS Support
+* Add IFP Support
+* Add Manhunt Script Examples
+* Fix INST Position format (mh2) (thx ermaccer for the ASI position viewer )
+* Add vendor (for easy installation...)
+* And much much more
+
 **2018-06-10**: Bugfix **v0.0.3** Release:
 * Fix Manhunt 1 Inst Packer / Unpacker
 * Add Changelog

README.md

@@ -8,7 +8,9 @@ Every part is developed on PHP 7, you will need to install PHP on your System to
 
 ### Installing
 
+**Just load the latest Release and unzip it.**
 
+or grab the night build
 ```
 $ git clone https://github.com/Sor3nt/manhunt-toolkit
 $ cd manhunt-toolkit
@@ -19,29 +21,26 @@ $ cd manhunt-toolkit
 
 ### Unpack and Pack files
 
-Nothing easier than this. The current version allow us to handle this files:
+Nothing easier than this. 
 
-* *.glg
-* *.mls
-* *.inst
-* *.scc (this is actual an MLS)
+MHT will **autodetect** the given file by reading the header and content.
 
 
-You can unpack any file with
+You can unpack any supported file with
 ```
-$ php mht archive:unpack /path/to/my/file
+$ php mht unpack myManhhunt.file
 ```
 
 And repack again with
 ```
-$ php mht archive:pack /path/to/my/file
+$ php mht pack myManhhunt.mod
 ```
 
-MHT will autodetect the filetype by reading the header.
-
-> instead of **archive:unpack** you can also write **unpack** / **pack**
+The toolkit provide much more features and parameters, just call **mht** to get the help!
+```
+php mht
+```
 
-> unpack accept also a second parameter "output"
 
 ## About the Supported Formats
 
@@ -57,26 +56,46 @@ Any Object positions is here stored, MHT convert all values into a editable JSON
         "entityClass": "Player_Inst",
         "position": {
             "1": -44.7730712890625,
-            "2": -9.298941612243652,
-            "3": -0.03999999910593033
+            "2": 9.298941612243652,
+            "3": 0.03999999910593033
         },
         "rotation": {
             "1": 0,
             "2": 0,
-            "3": -0,
+            "3": 0,
             "4": 1
         },
         ...
 ```
 
-### MLS (Manhunt 1 & 2)
-The core, the holy grail. Here we have LevelScript code inside. This defines how the game logic is.
+### MLS (Manhunt 1 & 2) - Level Script
+
+The MLS file contains the level logic, it define what the player can do and how the level interact with the elements.
+
+After unpacking a MLS File you will receive 2 folders, **Supported** and **Unsupported**.
+* Any files inside the **Supported** folder are free editable \*
+* The files inside **Unsupported** are not compatible with the compiler.
 
-MHT unpacker will extract any script block and place it into an folder.
+The compiler is in a **early state** but works already very well.
 
-10 sections per script block will be exported
+You can find some documented code examples here: https://github.com/Sor3nt/manhunt-toolkit/tree/master/tests/Resources/Examples
 
-For more details about the MLS Format and where which Data is stored follow the Wiki (todo)
+\* free editable: Not all combinations are supported, some action will rais an exception.
+
+ **Found a bug ? Need a feature ? Question ?** 
+ Feel free to create a Issue on GitHub!
 
+## IFP - Animation Files
 
+This files contains any available animation from the game. At the current state we can export, remove, replace, add and also merge Animations between Manhunt 1 and Manhunt 2**
+
+ \** Cross merging is disabled currently. 
+#Credits
+
+* **Sor3nt** for 4 month sleeples bytecode reverse engineering and compiler building.
+* **Ermaccer** for extending the offsets, create awesome helpful ASI loader, help testing, endure my talks *g* and much more!
+* **Allen** for his structure analysis of multiple files.
+#HAPPY MODDING!
+
+