From 85e8a1e8895e5d0b908a395a858d55b5bc1127a0 Mon Sep 17 00:00:00 2001 From: Aaron Griffith Date: Mon, 22 Aug 2011 23:20:17 -0400 Subject: [PATCH] added more stern warnings about sample.settings.py and the --zoom option --- README.rst | 4 ++-- sample.settings.py | 9 ++++++--- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index e8dede7..0548053 100644 --- a/README.rst +++ b/README.rst @@ -235,8 +235,8 @@ zoom=ZOOM This is equivalent to setting the dimensions of the highest zoom level. It does not actually change how the map is rendered, but rather *how much of - the map is rendered.* (Calling this option "zoom" may be a bit misleading, - I know) + the map is rendered.* Setting this option too low *will crop your map.* + (Calling this option "zoom" may be a bit misleading, I know) To be precise, it sets the width and height of the highest zoom level, in tiles. A zoom level of z means the highest zoom level of your map will be diff --git a/sample.settings.py b/sample.settings.py index cccdac8..f5761ea 100644 --- a/sample.settings.py +++ b/sample.settings.py @@ -33,7 +33,9 @@ if procs < 1: procs = 1 ## Sets the zoom level manually instead of calculating it. This can be useful ## if you have outlier chunks that make your world too big. This value will ## make the highest zoom level contain (2**ZOOM)^2 tiles -## Normally you should not need to set this variable. +## ***Normally you should not need to set this variable.*** +## ***Setting it too low will crop your map!*** +## Seriously, check the README before using this. ## Default: Automatically calculated from your world ## Type: integer ## Example: @@ -163,7 +165,8 @@ north_direction = "upper-right" -### As a reminder, don't use this file verbatim, it should only be used as -### a guide. +### As a reminder, *don't use this file verbatim*, it should only be used as +### a guide. Be sure to read what each option does before you set it. +### See the README for more details. import sys sys.exit("This sample-settings file shouldn't be used directly!")