diff --git a/README.md b/README.md index a53918b..b6a5ede 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,37 @@ +Giants Map Objects Extractor +============================ + +This tool is used to get extract in a map. It outputs the objects model and coords and doesn't do anything else yet. + +How it works +------------ + +Basically maps are just a zip file that contains a terrain file (.gti) and a meta file (.bin) which stores objects on the map. + +Objects in this file are stored using the following format: +``` +... +2a -> static byte which indicate the start of an object definition +model -> 4 bytes long value to indicate the model of the object +x -> 4 bytes float value +y -> 4 bytes float value +z -> 4 bytes float value +angle -> 4 bytes float value +... +``` + +Usage +---- + +``` +C:\Projects\gck-map-extract-objects> python .\extract.py +usage: extract.py [-h] map_file +extract.py: error: the following arguments are required: map_file +``` + +Example +------- + ``` extract.py "MvM - Ultimate Winter Duel.gck" 2019-05-24 11:00:00,229 - __main__ - INFO - Opening MvM - Ultimate Winter Duel.gck