book

BrettMayson · Nov 21, 2023 · 6f3a8ed · 6f3a8ed
1 parent 7dcb671
commit 6f3a8ed
Show file tree

Hide file tree

Showing 6 changed files with 114 additions and 22 deletions.
diff --git a/book/SUMMARY.md b/book/SUMMARY.md
@@ -7,38 +7,43 @@
 # Mod Projects
 
 - [Configuration](configuration/index.md)
-    - [Minimum](configuration/minimum.md)
-    - [Version](configuration/version.md)
-    - [Addon](configuration/addon.md)
+  - [Minimum](configuration/minimum.md)
+  - [Version](configuration/version.md)
+  - [Addon](configuration/addon.md)
 - [Commands](commands/index.md)
-    - [new](commands/new.md)
-    - [dev](commands/dev.md)
-    - [launch](commands/launch.md)
-    - [build](commands/build.md)
-    - [release](commands/release.md)
-    - [script](commands/script.md)
+  - [new](commands/new.md)
+  - [dev](commands/dev.md)
+  - [launch](commands/launch.md)
+  - [build](commands/build.md)
+  - [release](commands/release.md)
+  - [script](commands/script.md)
 - [Rhai](rhai/index.md)
-    - [Libraries](rhai/library/index.md)
-        - [Logging](rhai/library/logging.md)
-        - [HEMTT](rhai/library/hemtt.md)
-        - [Project](rhai/library/project.md)
-        - [File System](rhai/library/filesystem.md)
-        - [Time](rhai/library/time.md)
-    - [Hooks](rhai/hooks/index.md)
-        - [Examples](rhai/hooks/examples.md)
-    - [Scripts](rhai/scripts/index.md)
-        - [Examples](rhai/scripts/examples.md)
+  - [Libraries](rhai/library/index.md)
+    - [Logging](rhai/library/logging.md)
+    - [HEMTT](rhai/library/hemtt.md)
+    - [Project](rhai/library/project.md)
+    - [File System](rhai/library/filesystem.md)
+    - [Time](rhai/library/time.md)
+  - [Hooks](rhai/hooks/index.md)
+    - [Examples](rhai/hooks/examples.md)
+  - [Scripts](rhai/scripts/index.md)
+    - [Examples](rhai/scripts/examples.md)
 - [Linting](linting.md)
 - [ArmaScriptCompiler](armascriptcompiler.md)
 
 # Utilities
 
+- [Inspect](utilities/inspect.md)
 - [Verify](utilities/signing/verify.md)
+- [PBO]()
+  - [Inspect](utilities/pbo/inspect.md)
+  - [Extract](utilities/pbo/extract.md)
+  - [Unpack](utilities/pbo/unpack.md)
 
 # Reference
 
 - [Analysis](analysis/index.md)
-    - [Config](analysis/config.md)
+  - [Config](analysis/config.md)
 
 <!--
 # Modding Guide

diff --git a/book/utilities/inspect.md b/book/utilities/inspect.md
@@ -0,0 +1,26 @@
+# hemtt utils inspect
+
+<pre><code>Provides information about supported files. Supported: pbo, bikey, bisign
+
+Usage: hemtt utils inspect [OPTIONS] &lt;file&gt;
+
+Arguments:
+  &lt;file&gt;
+        File to inspect
+
+Options:
+  -v...
+        Verbosity level
+
+  -h, --help
+        Print help (see a summary with '-h')
+</code>
+</pre>
+
+This will inspect a file and provide information about it.
+
+Currently supported files are:
+
+- .pbo
+- .bikey
+- .bisign
diff --git a/book/utilities/pbo/extract.md b/book/utilities/pbo/extract.md
@@ -0,0 +1,19 @@
+# hemtt utils pbo extract
+
+<pre><code>Extract a file from a PBO
+
+Usage: hemtt utils pbo extract [OPTIONS] &lt;pbo&gt; &lt;file&gt; [output]
+
+Arguments:
+  &lt;pbo&gt;     PBO file to extract from
+  &lt;file&gt;    File to extract
+  [output]  Where to save the extracted file
+
+Options:
+  -v...                    Verbosity level
+  -h, --help               Print help
+</code></pre>
+
+Extracts a file from a PBO.
+
+If no output is specified, it will be written to stdout.
diff --git a/book/utilities/pbo/inspect.md b/book/utilities/pbo/inspect.md
@@ -0,0 +1,22 @@
+# hemtt utils pbo inspect
+
+<pre><code>Inspect a PBO
+
+Usage: hemtt utils pbo inspect [OPTIONS] &lt;pbo&gt;
+
+Arguments:
+  &lt;pbo&gt;
+        PBO to inspect
+
+Options:
+  -v...
+        Verbosity level
+
+  -h, --help
+        Print help (see a summary with '-h')
+</code>
+</pre>
+
+Provides information about a PBO.
+
+This is the same as `hemtt utils inspect` but will assume the file is a PBO.
diff --git a/book/utilities/pbo/unpack.md b/book/utilities/pbo/unpack.md
@@ -0,0 +1,20 @@
+# hemtt utils pbo unpack
+
+<pre><code>Unpack a PBO
+
+Usage: hemtt utils pbo unpack [OPTIONS] &lt;pbo&gt; &lt;output&gt;
+
+Arguments:
+  &lt;pbo&gt;     PBO file to unpack
+  &lt;output&gt;  Directory to unpack to
+
+Options:
+  -v...                    Verbosity level
+  -h, --help               Print help
+</code></pre>
+
+Unpacks a PBO to a directory.
+
+A `$PBOPREFIX$` file will be created in the output directory containing the prefix of the PBO.
+
+All other properties from the PBO will be saved into `properties.txt`
diff --git a/book/utilities/signing/verify.md b/book/utilities/signing/verify.md
@@ -5,10 +5,10 @@
 Usage: hemtt utils verify [OPTIONS] &lt;pbo&gt; &lt;bikey&gt;
 
 Arguments:
-  <pbo>
+  &lt;pbo&gt;
           PBO to verify
 
-  <bikey>
+  &lt;bikey&gt;
           BIKey to verify against
 
 Options: