LogalDeveloper/Minecraft-Overviewer
Archived
0
Fork 0
Code Activity

more readme updates

Browse Source
This commit is contained in:
Andrew Brown
2010-09-15 19:07:00 -04:00
parent 340229c690
commit 0368a9b53c
1 changed files with 14 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.rst
View File

@@ -45,12 +45,17 @@ Using the Google Map Tile Generator
Disclaimers Disclaimers
----------- -----------
Before you dive into using this, let it be known that there are a few minor Before you dive into using this, just be aware that, for large maps, there is a
problems. First, it's slow. If your map is really large, this could take at *lot* of data to parse through and process. If your world is very large, expect
least half an hour, and for really large maps, several hours (Subsequent runs the initial render to take at least an hour, possibly more. (Since minecraft
will be quicker since it only re-renders tiles that have changed). Second, maps are practically infinite, the maximum time this could take is also
there's no progress bar. You can watch the tiles get generated, but the program infinite!)
gives no direct feedback at this time on how far along it is.
If you press ctrl-C, it will stop. The next run will pick up where it left off.
Once your initial render is done, subsequent renderings will be MUCH faster due
to all the caching that happens behind the scenes. Just use the same output
directory and it will only update the tiles it needs to.
There are probably some other minor glitches along the way, hopefully they will There are probably some other minor glitches along the way, hopefully they will
be fixed soon. See the `Bugs`_ section below. be fixed soon. See the `Bugs`_ section below.
@@ -103,18 +108,9 @@ access is required to load the Google Maps API files, but you otherwise don't
need anything else. need anything else.
You can throw these files up to a web server to let others view your map. You You can throw these files up to a web server to let others view your map. You
do not need a Google Maps API key (as was the case with older versions of the do *not* need a Google Maps API key (as was the case with older versions of the
API), so just copying the directory to your web server should suffice. API), so just copying the directory to your web server should suffice.
Tip: Since Minecraft worlds rarely produce perfectly square worlds, there will
be blank and non-existent tiles around the borders of your world. The Google
Maps API has no way of knowing this until it requests them and the web server
returns a 404 Not Found. If this doesn't bother you, then fine, stop reading.
Otherwise: you can avoid a lot of 404s to your logs by configuring your web
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.
Bugs Bugs
==== ====
This program has bugs. They are mostly minor things, I wouldn't have released a This program has bugs. They are mostly minor things, I wouldn't have released a
@@ -139,3 +135,5 @@ An incomplete list of things I want to fix soon is:
* Add lighting * Add lighting
* Some kind of graphical interface. * Some kind of graphical interface.
* A Windows exe for easier access for Windows users.