diff --git a/contrib/benchmark.py b/contrib/benchmark.py index 145654e..6de19e1 100644 --- a/contrib/benchmark.py +++ b/contrib/benchmark.py @@ -1,3 +1,13 @@ +"""Simple Benchmarking script. + +Usage and example: + +$ python contrib/benchmark.py World4/ +Rendering 50 chunks... +Took 20.290062 seconds or 0.405801 seconds per chunk, or 2.464261 chunks per second +""" + + import chunk import world import tempfile @@ -8,12 +18,6 @@ import os import sys import shutil -# Simple Benchmarking script. Usage and example: - -# $ python contrib/benchmark.py World4/ -# Rendering 50 chunks... -# Took 20.290062 seconds or 0.405801 seconds per chunk, or 2.464261 chunks per second - # create a new, empty, cache dir cachedir = tempfile.mkdtemp(prefix="benchmark_cache", dir=".") diff --git a/contrib/blockcounter.py b/contrib/blockcounter.py index b3603d3..6d69d55 100644 --- a/contrib/blockcounter.py +++ b/contrib/blockcounter.py @@ -1,3 +1,7 @@ +"""Produces block counts + +""" + import world, chunk import sys diff --git a/contrib/clearOldCache.py b/contrib/clearOldCache.py index 01b604d..45f8b0a 100644 --- a/contrib/clearOldCache.py +++ b/contrib/clearOldCache.py @@ -1,5 +1,8 @@ #!/usr/bin/python +"""Deletes files from the old chunk-based cache""" + + usage = "python contrib/%prog [OPTIONS] " description = """ diff --git a/contrib/findSigns.py b/contrib/findSigns.py index 3213b35..a344c71 100644 --- a/contrib/findSigns.py +++ b/contrib/findSigns.py @@ -1,6 +1,8 @@ #!/usr/bin/python ''' +Updates overviewer.dat file sign info + This script will scan through every chunk looking for signs and write out an updated overviewer.dat file. This can be useful if your overviewer.dat file is either out-of-date or non-existant. diff --git a/contrib/playerInspect.py b/contrib/playerInspect.py index c520788..d20d2ac 100644 --- a/contrib/playerInspect.py +++ b/contrib/playerInspect.py @@ -1,5 +1,9 @@ import sys +""" +Very basic player.dat inspection script +""" + sys.path.append(".") from overviewer_core.nbt import load diff --git a/contrib/rerenderBlocks.py b/contrib/rerenderBlocks.py index eb93871..ff7b02a 100644 --- a/contrib/rerenderBlocks.py +++ b/contrib/rerenderBlocks.py @@ -1,6 +1,8 @@ #!/usr/bin/python ''' +Generate a region list to rerender certain chunks + This is used to force the regeneration of any chunks that contain a certain blockID. The output is a chunklist file that is suitable to use with the --chunklist option to overviewer.py. diff --git a/contrib/testRender.py b/contrib/testRender.py index c4de264..4fa9e7e 100644 --- a/contrib/testRender.py +++ b/contrib/testRender.py @@ -1,5 +1,7 @@ #!/usr/bin/python +"Test Render Script" + import os, shutil, tempfile, time, sys, math, re from subprocess import Popen, PIPE, STDOUT, CalledProcessError from optparse import OptionParser diff --git a/contrib/validateRegionFile.py b/contrib/validateRegionFile.py index 7dd2763..b9276f3 100644 --- a/contrib/validateRegionFile.py +++ b/contrib/validateRegionFile.py @@ -1,5 +1,10 @@ #!/usr/bin/env python +''' +Validate a region file + +TODO description here''' + import os.path import sys overviewer_dir = os.path.split(os.path.split(os.path.abspath(__file__))[0])[0]