From fa17d2c87da8b5d80d59c0bc2ce46f0cb3d4b139 Mon Sep 17 00:00:00 2001 From: Andrew Brown Date: Tue, 18 Oct 2011 00:50:57 -0400 Subject: [PATCH] fixed typo, clarified some things, added cross-ref --- docs/options.rst | 15 ++++++++++----- docs/running.rst | 6 ++++-- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/docs/options.rst b/docs/options.rst index 79e5150..f477781 100644 --- a/docs/options.rst +++ b/docs/options.rst @@ -73,7 +73,7 @@ Useful Options Incomplete list of common render-modes for your convenience: - * normal, + * normal * lighting * night @@ -82,7 +82,7 @@ Useful Options Format: a list of strings. - Default: ["normal"] + Default: only render the normal mode See the `Render Modes`_ section for more information. @@ -144,6 +144,8 @@ Less Useful Options :option:`--textures-path`. Use this to see what terrain.png your current setup has selected. + See the :ref:`installing-textures` section for an example. + **Not available in settings file** .. cmdoption:: --display-config @@ -310,12 +312,15 @@ Less Useful Options .. note:: - If you installed Overviewer from the Debian package, then there isn't a - source directory; you must use this option to specify non-default - textures. + If you installed Overviewer from the Debian package or chose to install + the overviewer from source (``python setup.py install``), then there + isn't a source directory; this option may be necessary to specify + non-default textures. If you're having trouble getting The Overviewer to recognize your textures, see the :option:`--check-terrain` option. + + Also see the :ref:`installing-textures` section of the documentation. **Settings file:** Option name: ``textures_path`` diff --git a/docs/running.rst b/docs/running.rst index 52fddbc..e5d873c 100644 --- a/docs/running.rst +++ b/docs/running.rst @@ -59,6 +59,8 @@ Incremental updates are just as easy, and a lot faster. If you go and change something inside your world, run the command again and Overviewer will automatically re-render only what's needed. +.. _installing-textures: + Installing the Textures ======================= If you're running on a machine without the Minecraft client installed, you will @@ -89,10 +91,10 @@ You have several options: installations, you will need to specify the path... see the next bullet. * You can put a terrain.png file anywhere you want and point to its location - with the ``--textures-path`` option. This should point to the directory containing + with the :option:`--textures-path` option. This should point to the directory containing the terrain.png, not to the file itself. -Note: the ``--check-terrain`` option is useful for debugging terrain.png issues. +Note: the :option:`--check-terrain` option is useful for debugging terrain.png issues. For example:: $ ./overviewer.py --check-terrain