From acfdc5ed4bbbde0490dd43a7ff40805a9949e885 Mon Sep 17 00:00:00 2001 From: Ryan Rector Date: Tue, 12 Jul 2011 11:51:38 -0600 Subject: [PATCH] Update readme with information on changes --- README.rst | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.rst b/README.rst index 942e4cb..c966cc7 100644 --- a/README.rst +++ b/README.rst @@ -22,6 +22,36 @@ https://github.com/brownan/Minecraft-Overviewer/wiki/Documentation To contact the developers and other users, go to the site at the top of this README, or go to #overviewer on irc.freenode.net. +### Additional Features + +A configurable north direction! I'm not a big fan of north pointing to the +bottom left corner of the screen, and I bet you aren't either. So here you go! +Either use the commandline option --north-direction, or use the option +north_direction in the settings file. Valid options are 'lower-left', +'upper-left', 'upper-right', and 'lower-right'. I'm partial to 'upper-right', +myself. + +### Additional Bugs + +With very small testing maps, the upper-right direction seems to exacerbate an +existing bug that will not let you click on a sign in some cases. This is a +bang-head-on-desk sort of thing, I should be able to find it but I cannot. +Somehow it does seem to work fine on my actual SMP map, but there is a good +chance that is just luck. + +Some blocks don't rotate properly in the upper-left and lower-right directions. +This is an easy fix, it just takes time. And besides, the upper-right is what +you are really looking for, anyway. Probably. + +It's slow! One of the rotation methods is very, very inefficient. It needs to be +rewritten, but I don't seem to be smart enough to do it right now. I must +investigate! No hard numbers but I will run a benchmark soon. + +### Upstream + +Once I've squashed some bugs and cleaned up the code a bit, I will see about +getting this included in the official Minecraft Overviewer. + Features ========