added warning to docs about the non-functionality of overlays

2012-03-03 00:00:20 -05:00
parent 925033bea8
commit ba3385e44b
1 changed files with 5 additions and 0 deletions
--- a/docs/config.rst
+++ b/docs/config.rst
@@ -487,6 +487,11 @@ ClearBase
    Forces the background to be transparent. Use this in place of Base
    for rendering pure overlays.

+    .. warning::
+
+        Overlays are currently not functional in this branch of code. We are
+        working on them. Please inquire in :ref:`IRC<help>` for more information.
+
 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