LogalDeveloper/Minecraft-Overviewer
Archived
0
Fork 0
Code Activity

Updated example to be more correct

Browse Source
This commit is contained in:
Andrew Brown
2012-02-22 23:20:16 -05:00
parent 1a1e975793
commit ae820079d1
1 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
docs/config.rst
View File

@@ -39,12 +39,14 @@ The ``worlds`` dictionary
lines like this one. Otherwise, one is sufficient. lines like this one. Otherwise, one is sufficient.
The ``renders`` dictionary The ``renders`` dictionary
Each item here declares a "render" which is a map of a world rendered with a Each item here declares a "render" which is a map of one dimension of one
set of options. If you have more than one, when viewing the maps, you will world rendered with the given options. If you declare more than one render,
get a dropdown box to choose which map you want to look at. then you will get a dropdown box to choose which map you want to look at
when viewing the maps.
You can render the same world multiple times with different options, or You are free to declare as many renders as you want with whatever options
render multiple worlds. you want. For example, you are allowed to render multiple worlds, or even
render the same world multiple times with different options.
.. note:: .. note::
@@ -80,14 +82,6 @@ A more complicated example
"dimension": "nether", "dimension": "nether",
} }
renders["survivalspawnoverlay"] = {
"world": "survival",
"title": "Spawn Overlay",
"rendermode": spawn_overlay,
"dimension": "overworld",
"overlay": ["survivalday", "survivalnight"],
}
renders["creative"] = { renders["creative"] = {
"world": "creative", "world": "creative",
"title": "Creative", "title": "Creative",
@@ -96,24 +90,30 @@ A more complicated example
} }
outputdir = "/home/username/mcmap" outputdir = "/home/username/mcmap"
textures = "/home/username/my_texture_pack.zip" texturepath = "/home/username/my_texture_pack.zip"
This config defines four maps for render, and one overlay. Two of them are of This config defines four maps for render. Two of them are of the survival
the survival world's overworld, one is for the survival's nether, and one is for world's overworld, one is for the survival's nether, and one is for the creative
a creative world. The overlay is the "spawn_overlay" (which highlights areas world.
that are dark enough for monsters to spawn) and it will be available when
viewing the survivalday and survivalnight maps.
Notice here we explicitly set the dimension property on each render. If Notice here we explicitly set the dimension property on each render. If
dimension is not specified, the default or overworld dimension is used. dimension is not specified, the default or overworld dimension is used. It is
necessary e.g. for the nether render.
Also note here we specify some different rendermodes. A rendermode refers to how Also note here we specify some different rendermodes. A rendermode refers to how
the map is rendered. The Overviewer can render a map in many different ways, and the map is rendered. The Overviewer can render a map in many different ways, and
there are many preset rendermodes, and you can even create your own (more on there are many preset rendermodes, and you can even create your own (more on
that later). that later).
And finally, note the usage of the ``textures`` option. This specifies a texture And finally, note the usage of the ``texturepath`` option. This specifies a
pack to use for the rendering. texture pack to use for the rendering. Also note that it is set at the top level
of the config file, and therefore applies to every render. It could be set on
individual renders to apply to just those renders.
.. note::
See the ``sample_config.py`` file included in the repository for another
example.
Config File Specifications Config File Specifications
========================== ==========================