From 0f1c0ffb11fb96060da7d0ecbe9c3ab79f691b4f Mon Sep 17 00:00:00 2001
From: tmpz23 <28760271+tmpz23@users.noreply.github.com>
Date: Mon, 15 Nov 2021 22:11:47 +0100
Subject: [PATCH] Update README.md

---
 README.md | 42 ++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 40 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index fab1ace..7f7c4b3 100644
--- a/README.md
+++ b/README.md
@@ -3,5 +3,43 @@ NeoGF is a library of tools for Gotcha Force.
 
 Pour plus d'info sur le jeu, rendez vous sur le [Wiki](http://re.wiki.virtualworld.fr/index.php/Gotcha_Force).
 
-## Tools
- - pzztool.py : Script python permettant d'unpack/repack et d'extraire/re-compresser des fichiers PZZ et leur contenu.
+## pzztool.py
+Python3 script for unpack/repack and uncompress/compress of PZZ archive.
+
+### User manual
+
+Every file extracted has a name using the format :
+
+AAAB_CD.E
+- AAA is the 3 digits index of the file in the PZZ starting at 000.
+- B describe the compression state of the file when packed in the PZZ. If compressed it's **C** or if not it's **U**.
+- C is the name of the PZZ.
+- D describe the actual compression state of the file. It's **\_compressed** if the file is compressed and nothing if the file is uncompressed.
+- E is the extension of the file. By default it is **.dat**
+
+For example file 012C_cmn_data.dat describe the 13th file off the pzz initialy compressed in a pzz named "cmn_data.pzz" and that has been uncompressed with the default format "dat". The names of unpacked files and the presence of empty unpacked files is important to keep informations relative to the initial pzz and ensure a correct pack.
+
+```
+pzztool.py -u source.pzz optional_dest_folder
+```
+Unpack **source.pzz** in the default new folder _source_.
+
+If optional_dest_folder is specified we unpack in _optional_dest_folder_.
+```
+pzztool.py -p source_folder optional_dest.pzz
+```
+Pack **source_folder** in the default new pzz file _source_folder.pzz_.
+
+If optional_dest.pzz is specified we pack in _optional_dest.pzz_.
+```
+pzztool.py -bu source_folder optional_dest_folder
+```
+Unpack every pzz files present in _source_folder_ using the same directory. For each pzz a folder is created using the name of the pzz.
+
+If optional_dest_folder is specified we unpack all files in _optional_dest_folder_ instead of source_folder.
+```
+pzztool.py -bp source_folder optional_dest_folder
+```
+Pack every folder present in _source_folder_ using the same directory. For each folder a pzz file a folder is created using the name of the pzz.
+
+If optional_dest_folder is specified we pack all folders in _optional_dest_folder_ instead of source_folder.