LogalDeveloper/Minecraft-Overviewer
Archived
0
Fork 0
Code Activity

clarified docs about the crop option

Browse Source
This commit is contained in:
Andrew Brown
2012-03-06 09:48:50 -05:00
parent 954c7289be
commit 1f7ccdaa93
1 changed files with 14 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/config.rst
View File

@@ -362,8 +362,8 @@ values. The valid configuration keys are listed below.
You can use this to render a small subset of your map, instead of the entire You can use this to render a small subset of your map, instead of the entire
thing. The format is (min x, min z, max x, max z). thing. The format is (min x, min z, max x, max z).
(The coordinates are block coordinates. The same you get with the debug menu The coordinates are block coordinates. The same you get with the debug menu
in-game) in-game and the coordinates shown when you view a map.
Example that only renders a 1000 by 1000 square of land about the origin:: Example that only renders a 1000 by 1000 square of land about the origin::
@@ -373,19 +373,29 @@ values. The valid configuration keys are listed below.
'crop': (-500, -500, 500, 500), 'crop': (-500, -500, 500, 500),
} }
This option performs a similar function to the old ``--regionlist`` option
(which no longer exists). It is useful for example if someone has wandered
really far off and made your map too large. You can set the crop for the
largest map you want to render (perhaps ``(-10000,-10000,10000,10000)``). It
could also be used to define a really small render showing off one
particular feature, perhaps from multiple angles.
.. warning:: .. warning::
If you decide to change the bounds on a render, you may find it produces If you decide to change the bounds on a render, you may find it produces
unexpected results. unexpected results. It is recommended to not change the crop settings
once it has been rendered once.
For an expansion to the bounds, because chunks in the new bounds have For an expansion to the bounds, because chunks in the new bounds have
the same mtime as the old, tiles will not automatically be updated. You the same mtime as the old, tiles will not automatically be updated. You
may need to use :option:`--forcerender` to force those tiles to update. may need to use :option:`--forcerender` to force those tiles to update.
(You can define the ``forcerender`` option on just one render)
For reductions to the bounds, because there is currently no mechanism to For reductions to the bounds, because there is currently no mechanism to
detect tiles that shouldn't exist but do, old tiles may remain and will detect tiles that shouldn't exist but do, old tiles may remain and will
not get deleted. The only fix for this currently is to delete that not get deleted. The only fix for this currently is to delete that
render directory and render it again with :option:`--forcerender`. render directory entirely and render it again with
:option:`--forcerender`.
``forcerender`` ``forcerender``
This is a boolean. If set to ``True`` (or any non-false value) then this This is a boolean. If set to ``True`` (or any non-false value) then this