LogalDeveloper/Minecraft-Overviewer
Archived
0
Fork 0
Code Activity

Updated sign docs, including --genpoi usage

Browse Source
This commit is contained in:
Sean Kilgore
2012-03-26 13:41:16 -07:00
parent 373291932f
commit c287247b86
2 changed files with 27 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/running.rst
View File

@@ -184,6 +184,15 @@ is typically correct.
This option is automatically activated for first-time renders. This option This option is automatically activated for first-time renders. This option
conflicts with :option:`--check-tiles` and :option:`--no-tile-checks` conflicts with :option:`--check-tiles` and :option:`--no-tile-checks`
.. cmdoption:: --genpoi
.. note::
Don't use this flag without first reading :ref:`signsmarkers`!
Generates the POI markers for your map. This option does not do any tile/map
generation, and ONLY generates markers. See :ref:`signsmarkers` on how to
configure POI options.
.. cmdoption:: -p <procs>, --processes <procs> .. cmdoption:: -p <procs>, --processes <procs>

25
docs/signs.rst
View File

@@ -70,17 +70,28 @@ rendered map. For example::
Generating the POI Markers Generating the POI Markers
========================== ==========================
.. note::
Markers will not be updated or added during a regular overviewer.py map render!
You must use one of the following options to generate your markers.
The --genpoi option
-------------------
Running overviewer.py with the :option:`--genpoi` option flag will generate your
POI markers. For example::
/path/to/overviewer.py --config /path/to/your/config/file.conf --genpoi
.. note::
A --genpoi run will NOT generate a map render, it will only generate markers.
genPOI.py genPOI.py
--------- ---------
In order to actually generate the markers and add them to your map, the script The genPOI.py script is also provided, and can be used directly. For example::
genPOI.py must be run. For example::
/path/to/overviewer/genpoi.py --config=/path/to/your/config.file
genpoi.py --config=/path/to/your/config.file
.. note::
Markers will not be updated or added during a regular overviewer.py
map render!
This will generate the necessary JavaScript files needed in your config file's This will generate the necessary JavaScript files needed in your config file's
outputdir. outputdir.
@@ -88,7 +99,7 @@ outputdir.
Options Options
------- -------
genPOI.py has a single option:: --config. You should use the same configfile as genPOI.py has a single option :option:`--config`. You should use the same configfile as
used for your normal renders. used for your normal renders.