From 02e5ec17e58a540c25b320478ed9ecc670f28e74 Mon Sep 17 00:00:00 2001
From: Aaron Griffith <aargri@gmail.com>
Date: Sun, 26 Feb 2012 11:57:44 -0500
Subject: [PATCH] added docs for overlay primitives

---
 docs/config.rst | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/docs/config.rst b/docs/config.rst
index d6d26bd..5b073dd 100644
--- a/docs/config.rst
+++ b/docs/config.rst
@@ -430,6 +430,26 @@ SmoothLighting
 
     (same as Lighting)
 
+ClearBase
+    Forces the background to be transparent. Use this in place of Base
+    for rendering pure overlays.
+
+SpawnOverlay
+    Color the map red in areas where monsters can spawn. Either use
+    this on top of other modes, or on top of ClearBase to create a
+    pure overlay.
+
+MineralOverlay
+    Color the map according to what minerals can be found
+    underneath. Either use this on top of other modes, or on top of
+    ClearBase to create a pure overlay.
+    
+    **Options**
+    
+    minerals
+        A list of (blockid, (r, g, b)) tuples to use as colors. If not
+        provided, a default list of common minerals is used.
+
 Defining Custom Rendermodes
 ---------------------------
 Each rendermode primitive listed above is a Python *class* that is automatically