diff --git a/README.rst b/README.rst index 658c6e9..8aae2ef 100644 --- a/README.rst +++ b/README.rst @@ -42,7 +42,6 @@ If something doesn't work, let me know. Using the Google Map Tile Generator =================================== -This is the new and preferred way to generate images of your map. Disclaimers ----------- @@ -64,25 +63,16 @@ To generate a set of Google Map tiles, use the gmap.py script like this:: The output directory will be created if it doesn't exist. This will generate a set of image tiles for your world in the directory you choose. When it's done, -it will put an index.html file in the same directory that you can use to view +you will find an index.html file in the same directory that you can use to view it. -Note that this program renders each chunk of your world as an intermediate step -and stores the images in your world directory as a cache. You usually don't -need to worry about this, but if you want to delete them, see the section below -about `Deleting the Cache`_. - -Also note that this program outputs hash files alongside the tile images in the -output directory. These files are used to quickly determine if a tile needs to -be re-generated on subsequent runs of the program on the same world. This -greatly speeds up the rendering. - Using more Cores ---------------- -Adding the "-p" option will utilize more cores to generate the chunk files. -This can speed up rendering quite a bit. +Adding the "-p" option will utilize more cores during processing. This can +speed up rendering quite a bit. The default is set to the same number of cores +in your computer, but you can adjust it. -Example:: +Example to run 5 worker processes in parallel:: python gmap.py -p 5 @@ -125,64 +115,6 @@ server to redirect all 404 requests in that directory to a single 1px "blank.png". This may or may not save on bandwidth, but it will probably save on log noise. -Using the Large Image Renderer -============================== -The Large Image Renderer creates one large image of your world. This was -originally the only option, but uses a large amount of memory and generates -unwieldy large images. It is still included in this package in case someone -finds it useful, but the preferred method is the Google Map tile generator. - -Be warned: For even moderately large worlds this may eat up all your memory, -take a long time, or even just outright crash. It allocates an image large -enough to accommodate your entire world and then draws each block on it. It -would not be surprising to need gigabytes of memory for extremely large -worlds. - -To render a world, run the renderer.py script like this:: - - python renderer.py - -The is the path to the directory containing your world files. - -Cave mode ---------- -Cave mode renders all blocks that have no sunlight hitting them. Additionally, -blocks are given a colored tint according to how deep they are. Red are closest -to bedrock, green is close to sea level, and blue is close to the sky. - -Cave mode is like normal mode, but give it the "-c" flag. Like this:: - - python renderer.py -c - -Deleting the Cache ------------------- -The Overviewer keeps a cache of each world chunk it renders stored within your -world directory. When you generate a new image of the same world, it will only -re-render chunks that have changed, speeding things up a lot. - -If you want to delete these images, run the renderer.py script with the -d flag:: - - python renderer.py -d - -To delete the cave mode images, run it with -d and -c - -:: - - python renderer.py -d -c - -You may want to do this for example to save space. Or perhaps you've changed -texture packs and want to force it to re-render all chunks. - -Using More Cores ----------------- -The Overviewer will render each chunk separately in parallel. You can tell it -how many processes to start with the -p option. This is set to a default of 2, -which will use 2 processes to render chunks, and 1 to render the final image. - -To bump that up to 3 processes, use a command in this form:: - - python renderer.py -p 3 - Bugs ==== This program has bugs. They are mostly minor things, I wouldn't have released a @@ -206,8 +138,4 @@ An incomplete list of things I want to fix soon is: * Add lighting -* Speed up the tile rendering. I can parallelize that process. - -* I want to add some indication of progress to the tile generation. - * Some kind of graphical interface.