LogalDeveloper/Minecraft-Overviewer
Archived
0
Fork 0
Code Activity

clarified some points in the config docs

Browse Source
This commit is contained in:
Andrew Brown
2012-03-02 23:45:50 -05:00
parent bab1ed3c14
commit 21cf4fc5dd
1 changed files with 23 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/config.rst
View File

@@ -239,8 +239,16 @@ values. The valid configuration keys are listed below.
"nether", "end", or the directory name of the dimension within the world. "nether", "end", or the directory name of the dimension within the world.
e.g. "DIM-1" e.g. "DIM-1"
.. note::
If you choose to render your nether dimension, you must also use a
nether :ref:`rendermode<option_rendermode>`. Otherwise you'll
just end up rendering the nether's ceiling.
**Default:** ``"overworld"`` **Default:** ``"overworld"``
.. _option_rendermode:
``rendermode`` ``rendermode``
This is which rendermode to use for this render. There are many rendermodes This is which rendermode to use for this render. There are many rendermodes
to choose from. This can either be a rendermode object, or a string, in to choose from. This can either be a rendermode object, or a string, in
@@ -278,8 +286,11 @@ values. The valid configuration keys are listed below.
normal is that the ceiling is stripped off, so you can actually see normal is that the ceiling is stripped off, so you can actually see
inside. inside.
*Note* Selecting this rendermode doesn't automatically render your .. note::
nether dimention. Be sure to also set the :ref:`dimension<option_dimension>` option.
Selecting this rendermode doesn't automatically render your nether
dimention. Be sure to also set the
:ref:`dimension<option_dimension>` option to 'nether'.
``"nether_lighting"`` ``"nether_lighting"``
Similar to "nether" but with blocky lighting. Similar to "nether" but with blocky lighting.
@@ -287,11 +298,14 @@ values. The valid configuration keys are listed below.
``"nether_smooth_lighting"`` ``"nether_smooth_lighting"``
Similar to "nether" but with smooth lighting. Similar to "nether" but with smooth lighting.
Technical note: The actual object type for this option is a list of
*rendermode primitive* objects. See :ref:`customrendermodes` for more
information.
**Default:** ``"normal"`` **Default:** ``"normal"``
.. note::
The value for the 'rendermode' key can be either a *string* or
*rendermode object* (strings simply name one of the built-in rendermode
objects). The actual object type is a list of *rendermode primitive*
objects. See :ref:`customrendermodes` for more information.
``northdirection`` ``northdirection``
This is direction that north will be rendered. This north direction will This is direction that north will be rendered. This north direction will
@@ -508,6 +522,9 @@ Then you can use your new rendermode in your render definitions::
"dimension": "overworld", "dimension": "overworld",
} }
Note the lack of quotes around ``my_rendermode``. This is necessary since you
are referencing the previously defined list, not one of the built-in
rendermodes.
Built-in Rendermodes Built-in Rendermodes
-------------------- --------------------