LogalDeveloper/Minecraft-Overviewer
Archived
0
Fork 0
Code Activity

renamed --config-file to --settings, updated README with new options

Browse Source
This commit is contained in:
Aaron Griffith
2011-05-13 18:22:00 -04:00
parent dacd45e5d3
commit 21de6222ca
2 changed files with 23 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.rst
View File

@@ -191,11 +191,18 @@ Options
--list-rendermodes --list-rendermodes
List the available render modes, and a short description of each. List the available render modes, and a short description of each.
--settings=PATH
Use this option to load settings from a file. The format of this file is
given below.
Settings Settings
-------- --------
You can optionally store settings in a file named settings.py. It is a regular
python script, so you can use any python functions or modules you want. You can optionally store settings in a file named settings.py (or really,
anything you want). It is a regular python script, so you can use any python
functions or modules you want. To use a settings file, use the --settings
command line option.
For a sample settings file, look at 'sample.settings.py'. Note that this file For a sample settings file, look at 'sample.settings.py'. Note that this file
is not meant to be used directly, but instead it should be used as a is not meant to be used directly, but instead it should be used as a
@@ -241,6 +248,18 @@ web_assets_hook
This function should accept one argument: a QuadtreeGen object. This function should accept one argument: a QuadtreeGen object.
web_assets_path
This option lets you provide alternative web assets to use when
rendering. The contents of this folder will be copied into the output folder
during render, and will overwrite any default files already copied by
Overviewer. See the web_assets folder included with Overviewer for the
default assets.
textures_path
This is like web_assets_path, but instead it provides an alternative texture
source. Overviewer looks in here for terrain.png and other textures before
it looks anywhere else.
Viewing the Results Viewing the Results
------------------- -------------------
Within the output directory you will find two things: an index.html file, and a Within the output directory you will find two things: an index.html file, and a

4
configParser.py
View File

@@ -24,7 +24,7 @@ class ConfigOptionParser(object):
self.requiredArgs = [] self.requiredArgs = []
# add the *very* special config-file path option # add the *very* special config-file path option
self.add_option("--config-file", dest="config_file", help="Specifies a configuration file to load, by name. This file's format is discussed in the README.", metavar="PATH", type="string", commandLineOnly=True) self.add_option("--settings", dest="config_file", help="Specifies a settings file to load, by name. This file's format is discussed in the README.", metavar="PATH", type="string", commandLineOnly=True)
def display_config(self): def display_config(self):
logging.info("Using the following settings:") logging.info("Using the following settings:")
@@ -77,7 +77,7 @@ class ConfigOptionParser(object):
self.configFile = options.config_file self.configFile = options.config_file
elif os.path.exists(self.configFile): elif os.path.exists(self.configFile):
# warn about automatic loading # warn about automatic loading
logging.warning("Automatic settings.py loading is DEPRECATED, and may be removed in the future. Please use --config-file instead.") logging.warning("Automatic settings.py loading is DEPRECATED, and may be removed in the future. Please use --settings instead.")
if os.path.exists(self.configFile): if os.path.exists(self.configFile):
execfile(self.configFile, g, l) execfile(self.configFile, g, l)