LogalDeveloper/Minecraft-Overviewer
Archived
0
Fork 0
Code Activity

cross-referenced command options from faq page. also

Browse Source 
added --bg-color to options page
This commit is contained in:
Andrew Brown
2011-10-01 19:24:32 -04:00
parent 4ad984a052
commit fa4f8c0e3b
2 changed files with 24 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/faq.rst
View File

@@ -3,20 +3,21 @@ Frequently Asked Questions
========================== ==========================
**The full map doesn't display even when fully zoomed out!** **The full map doesn't display even when fully zoomed out!**
Are you using the ``-z`` or ``--zoom`` option on your commandline or in Are you using the ``-z`` or ``--zoom`` option on your commandline or
settings.py? If so, try removing it, or increasing the value you set. It's in settings.py? If so, try removing it, or increasing the value you set.
quite likely you don't need it at all. It's quite likely you don't need it at all. See the documentation for the
:option:`--zoom <-z>` option.
**You've added a few feature, but it's not showing up on my map!** **You've added a few feature, but it's not showing up on my map!**
Some new features will only show up in newly-rendered areas. Use the Some new features will only show up in newly-rendered areas. Use the
``--forcerender`` option to update the entire map. :option:`--forcerender` option to update the entire map.
**How do I use this on CentOS 5?** **How do I use this on CentOS 5?**
CentOS 5 comes with Python 2.4, but the Overviewer needs 2.6 or higher. See CentOS 5 comes with Python 2.4, but the Overviewer needs 2.6 or higher. See
the special instructions at :ref:`centos` the special instructions at :ref:`centos`
**The background color of the map is black, and I don't like it!** **The background color of the map is black, and I don't like it!**
You can change this by using the ``--bg-color`` command line option, or You can change this by using the :option:`--bg-color` command line option, or
``bg_color`` in settings.py. See the `Options <options.html>`_ page for more ``bg_color`` in settings.py. See the `Options <options.html>`_ page for more
details. details.

23
docs/options.rst
View File

@@ -18,7 +18,7 @@ Command line options
Useful Options Useful Options
-------------- --------------
.. cmdoption:: --rendermodes=MODE1[,MODE2,...] .. cmdoption:: --rendermodes <MODE1>[,MODE2,...]
Use this option to specify which render mode to use, such as lighting or Use this option to specify which render mode to use, such as lighting or
night. Use --list-rendermodes to get a list of available rendermodes, and night. Use --list-rendermodes to get a list of available rendermodes, and
@@ -36,7 +36,7 @@ Useful Options
List the available render modes, and a short description of each. List the available render modes, and a short description of each.
.. cmdoption:: --north-direction=NORTH_DIRECTION .. cmdoption:: --north-direction <NORTH_DIRECTION>
Specifies which corner of the screen north will point to. Specifies which corner of the screen north will point to.
Valid options are: lower-left, upper-left, upper-right, lower-right. Valid options are: lower-left, upper-left, upper-right, lower-right.
@@ -44,7 +44,7 @@ Useful Options
the existing map uses. For new maps, it defaults to lower-left for the existing map uses. For new maps, it defaults to lower-left for
historical reasons. historical reasons.
.. cmdoption:: --settings=PATH .. cmdoption:: --settings <PATH>
Use this option to load settings from a file. For more information see the Use this option to load settings from a file. For more information see the
`Settings File`_ section below. `Settings File`_ section below.
@@ -52,7 +52,7 @@ Useful Options
Less Useful Options Less Useful Options
------------------- -------------------
.. cmdoption:: -p PROCS, --processes=PROCS .. cmdoption:: -p <PROCS>, --processes <PROCS>
Adding the "-p" option will utilize more cores during processing. This Adding the "-p" option will utilize more cores during processing. This
can speed up rendering quite a bit. The default is set to the same can speed up rendering quite a bit. The default is set to the same
@@ -75,7 +75,7 @@ Less Useful Options
Force re-rendering the entire map (or the given regionlist). This Force re-rendering the entire map (or the given regionlist). This
is an easier way to completely re-render without deleting the map. is an easier way to completely re-render without deleting the map.
.. cmdoption:: --regionlist=regionlist .. cmdoption:: --regionlist <regionlist>
Use this option to specify manually a list of regions to consider for Use this option to specify manually a list of regions to consider for
updating. Without this option, every chunk in every region is checked for updating. Without this option, every chunk in every region is checked for
@@ -88,7 +88,18 @@ Less Useful Options
a certain date. Or perhaps you can incrementally update your map by passing a certain date. Or perhaps you can incrementally update your map by passing
in a subset of regions each time. It's up to you! in a subset of regions each time. It's up to you!
.. cmdoption:: -z <zoom>, --zoom <zoom>
See the :ref:`zoom <zoom>` section below.
.. cmdoption:: --bg-color <color>
Configures the background color for the Google Map output. Specify in
#RRGGBB format.
*This list is currently incomplete. Use the* :option:`--help <-h>` *and*
:option:`--advanced-help` *options to see the complete list of accepted command
line options.*
Settings File Settings File
============= =============
@@ -110,6 +121,8 @@ imgformat=FORMAT
Set the output image format used for the tiles. The default is 'png', Set the output image format used for the tiles. The default is 'png',
but 'jpg' is also supported. but 'jpg' is also supported.
.. _zoom:
zoom=ZOOM zoom=ZOOM
The Overviewer by default will detect how many zoom levels are required The Overviewer by default will detect how many zoom levels are required
to show your entire map. This option sets it manually. to show your entire map. This option sets it manually.