LogalDeveloper/Minecraft-Overviewer
Archived
0
Fork 0
Code Activity

Added information about --skip-scan to the docs

Browse Source
This commit is contained in:
Caleb Sander
2015-01-28 22:44:14 -05:00
parent 97e5985933
commit a998911d02
1 changed files with 25 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/running.rst
View File

@@ -78,7 +78,7 @@ Usage
===== =====
For this section, we assume the executable is ``overviewer.py``. Replace that For this section, we assume the executable is ``overviewer.py``. Replace that
with ``overviewer.exe`` for windows. with ``overviewer.exe`` for windows.
Overviewer usage:: Overviewer usage::
@@ -131,7 +131,7 @@ is typically correct.
is not detected. This means that changes in your render configuration will is not detected. This means that changes in your render configuration will
not be reflected in your world except in updated chunks. It could also cause not be reflected in your world except in updated chunks. It could also cause
problems if the system clock of the machine running Minecraft is not stable. problems if the system clock of the machine running Minecraft is not stable.
**This option is the default** unless :option:`--forcerender` or **This option is the default** unless :option:`--forcerender` or
:option:`--check-tiles` is in effect. This option conflicts with :option:`--check-tiles` is in effect. This option conflicts with
:option:`--forcerender` and :option:`--check-tiles`. :option:`--forcerender` and :option:`--check-tiles`.
@@ -148,13 +148,13 @@ is typically correct.
automatically stored. This option was designed to handle the case where the automatically stored. This option was designed to handle the case where the
last render was interrupted -- some tiles have been updated but others last render was interrupted -- some tiles have been updated but others
haven't, so each one is checked before it is rendered. haven't, so each one is checked before it is rendered.
This is slightly slower than :option:`--no-tile-checks` due to the This is slightly slower than :option:`--no-tile-checks` due to the
additional disk-io involved in reading tile mtimes from the filesystem additional disk-io involved in reading tile mtimes from the filesystem
Since this option also checks for erroneous tiles, **It is also useful after Since this option also checks for erroneous tiles, **It is also useful after
you delete sections of your map, e.g. with worldedit, to delete tiles that you delete sections of your map, e.g. with worldedit, to delete tiles that
should no longer exist.** Overviewer greatly overestimates tiles to be should no longer exist.** Overviewer greatly overestimates tiles to be
rendered and time needed to complete. rendered and time needed to complete.
The caveats with this option are the same as for :option:`--no-tile-checks` The caveats with this option are the same as for :option:`--no-tile-checks`
@@ -186,15 +186,14 @@ is typically correct.
conflicts with :option:`--check-tiles` and :option:`--no-tile-checks` conflicts with :option:`--check-tiles` and :option:`--no-tile-checks`
.. cmdoption:: --genpoi .. cmdoption:: --genpoi
.. note:: .. note::
Don't use this flag without first reading :ref:`signsmarkers`! 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 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 generation, and ONLY generates markers. See :ref:`signsmarkers` on how to
configure POI options. configure POI options.
.. cmdoption:: -p <procs>, --processes <procs> .. cmdoption:: -p <procs>, --processes <procs>
This specifies the number of worker processes to spawn on the local machine This specifies the number of worker processes to spawn on the local machine
@@ -203,6 +202,17 @@ is typically correct.
This option can also be specified in the config file as :ref:`processes <processes>` This option can also be specified in the config file as :ref:`processes <processes>`
.. cmdoption:: --skip-scan
.. note::
Don't use this flag without first reading :ref:`signsmarkers`!
When generating POI markers, this option prevents scanning for entities and
tile entities, and only creates the markers specified in the config file.
This considerably speeds up the POI marker generation process if no entities
or tile entities are being used for POI markers. See :ref:`signsmarkers` on
how to configure POI options.
.. cmdoption:: -v, --verbose .. cmdoption:: -v, --verbose
Activate a more verbose logging format and turn on debugging output. This Activate a more verbose logging format and turn on debugging output. This
@@ -237,7 +247,7 @@ Installing the Textures
If Overviewer is running on a machine with the Minecraft client installed, it If Overviewer is running on a machine with the Minecraft client installed, it
will automatically use the default textures from Minecraft. will automatically use the default textures from Minecraft.
.. note:: .. note::
Overviewer will only search for installed client *release* versions, not Overviewer will only search for installed client *release* versions, not
snapshots. If you want to use a snapshot client jar for the textures, snapshots. If you want to use a snapshot client jar for the textures,
@@ -263,21 +273,21 @@ If you want or need to provide your own textures, you have several options:
VERSION=1.8 VERSION=1.8
wget https://s3.amazonaws.com/Minecraft.Download/versions/${VERSION}/${VERSION}.jar -P ~/.minecraft/versions/${VERSION}/ wget https://s3.amazonaws.com/Minecraft.Download/versions/${VERSION}/${VERSION}.jar -P ~/.minecraft/versions/${VERSION}/
If that's too confusing for you, then just take this single line and paste it into If that's too confusing for you, then just take this single line and paste it into
a terminal to get 1.8 textures:: a terminal to get 1.8 textures::
wget https://s3.amazonaws.com/Minecraft.Download/versions/1.8/1.8.jar -P ~/.minecraft/versions/1.8/ wget https://s3.amazonaws.com/Minecraft.Download/versions/1.8/1.8.jar -P ~/.minecraft/versions/1.8/
* You can also just run the launcher to install the client. * You can also just run the launcher to install the client.
* You can transfer the client jar to the correct place manually, from a computer * You can transfer the client jar to the correct place manually, from a computer
that does have the client, to your server. The correct places are: that does have the client, to your server. The correct places are:
* For Linux: ``~/.minecraft/versions/<version>/<version>.jar`` * For Linux: ``~/.minecraft/versions/<version>/<version>.jar``
* For Mac: ``~/Library/Application Support/minecraft/versions/<version>/<version>.jar`` * For Mac: ``~/Library/Application Support/minecraft/versions/<version>/<version>.jar``
* For Windows: ``%APPDATA%/.minecraft/versions/<version>/<version>.jar`` * For Windows: ``%APPDATA%/.minecraft/versions/<version>/<version>.jar``
* You can download and use a custom resource pack. Download the resource pack * You can download and use a custom resource pack. Download the resource pack