From a287eb0c227e16d7174e49d7ee439d2419574e02 Mon Sep 17 00:00:00 2001
From: Eric Wasylishen <ewasylishen@gmail.com>
Date: Sun, 1 Oct 2023 12:58:39 -0600
Subject: [PATCH] docs: create a stub for the maputil, lightpreview docs

---
 docs/index.rst        |  2 ++
 docs/lightpreview.rst | 19 +++++++++++
 docs/maputil.rst      | 78 +++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 99 insertions(+)
 create mode 100644 docs/lightpreview.rst
 create mode 100644 docs/maputil.rst

diff --git a/docs/index.rst b/docs/index.rst
index 3bc142c4..190c0d1d 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -13,6 +13,8 @@ Welcome to ericw-tools's documentation!
    light
    bspinfo
    bsputil
+   maputil
+   lightpreview
    changelog
 
 
diff --git a/docs/lightpreview.rst b/docs/lightpreview.rst
new file mode 100644
index 00000000..90c144f9
--- /dev/null
+++ b/docs/lightpreview.rst
@@ -0,0 +1,19 @@
+============
+lightpreview
+============
+
+lightpreview - GUI unifying :doc:`qbsp`, :doc:`vis`, and :doc:`light`, with a 3D viewport for visualizing the output.
+
+Controls
+========
+
+- :kbd:`WASDQE` fly movement
+
+View modes
+----------
+
+- :kbd:`Alt-1` Lightmapped
+- :kbd:`Alt-2` Lightmap Only
+- :kbd:`Alt-3` Fullbright
+- :kbd:`Alt-4` Normals
+- :kbd:`Alt-5` Flat shading
diff --git a/docs/maputil.rst b/docs/maputil.rst
new file mode 100644
index 00000000..2deca83e
--- /dev/null
+++ b/docs/maputil.rst
@@ -0,0 +1,78 @@
+=======
+maputil
+=======
+
+maputil - utiltiy for working with Quake MAP files
+
+Synopsis
+========
+
+**bsputil** [OPTION]... MAPFILE
+
+Options
+=======
+
+.. program:: maputil
+
+.. option:: --script <path to Lua script file>
+
+   execute the given Lua script.
+
+.. option:: --query \"<Lua expression>\"
+
+   perform a query on entities and print out matching results.
+   see docs for more details on globals.
+   note that query has the same access as script
+   but is more suitable for small read-only operations.
+
+.. option:: --strip_extended_info
+
+   removes extended Quake II/III information on faces.
+
+.. option:: --convert <quake | valve | etp | bp>
+
+   convert the current map to the given format.
+
+.. option:: --save \"<output path>\"
+
+   save the current map to the given output path.
+
+.. option:: --game <quake | quake2 | hexen2 | halflife>
+
+   set the current game; used for certain conversions
+   or operations.
+
+Lua layout
+==========
+
+::
+
+   entities = table[]
+    [E].dict = array
+        [D] = [ key, value ]
+    [E].brushes = table[]
+     [S].texture = string
+     [S].plane_points = [ [ x, y, z ] [ x, y, z ] [ x, y, z ] ]
+     [S].raw = table (can only contain ONE member:)
+         .quaked = table
+          .shift = [ x, y ]
+          .rotate = number
+          .scale = [ x, y ]
+         .valve = table
+          .axis = [ [ x, y, z ] [ x, y, z ] ]
+          .shift = [ x, y ]
+          .rotate = number
+          .scale = [ x, y ]
+         .bp = table
+          .axis = [ [ x, y, z ] [ x, y, z ] ]
+         .etp = table
+          .shift = [ x, y ]
+          .rotate = number
+          .scale = [ x, y ]
+          .tx2 = boolean
+     [S].info = table or nil
+         .contents = number
+         .value = number
+         .flags = number
+     [S].plane = [ x, y, z, d ] (read-only)
+     [S].vecs = [ [ x, y, z, d ] [ x, y, z, d ] ] (read-only)