The Minecraft Overviewer

To complement our APT repository, we now offer an RPM repository for RPM-based distros. Currently the RPMs are available for CentOS 5 and 6 and Fedora 16 but other targets could be added if there is enough interest. Details on installing the repo can be found over on RPM repo info page.

Are there any other platforms we should support? Let us know in the comments or drop by the IRC channel!

Thanks to those that have tried the new beta and given us feedback. We've already fixed several bugs; things are shaping up nicely!

About the new "Anvil" level format, we will be supporting this, but it is a rather hefty change. Our tentative plan is to make a new branch off of the beta "rewrite" branch for the anvil level format. Once the anvil format makes its way out of the Minecraft "pre-release" stage and into a proper release, we will merge the branch of our code and the new format will be the only one supported from then on.

We currently don't have any plans to support the Anvil format in the old "master" branch. We are not against it, but I don't foresee anyone stepping up to do the work. This means there is a deadline for those of you to convert your config files and setups to the new config format if you want to stay up to date. We believe the new config format is not complicated enough to be a big barrier for converting. If you need help please see us in IRC!

We also currently don't have any plans to support both world formats in one code-base. The changes it requires are quite extensive and I don't see that as being a very feasible option. Thus, if you want to continue running an older version of Minecraft with the older level format in the future, you will be blocked from updating Overviewer past a certain point. We will probably end up leaving a Git branch or tag at the last commit that supports the old format for those that don't want to upgrade. However, as time goes on we think most everyone will end up updating (just like we did for the old chunk format when it upgraded to region files)

Again, this is our tentative plan. Things may still change depending on demand or who's willing to do what work or how difficult a task turns out to be.

As always, happy Overviewing!

-brownan

Edit Mar 3 2012: The "anvil" branch has been merged into master. This post edited to reflect that.

Edit: Mar 1 2012, updated this post to reflect the new "anvil" branch.

In our efforts to rewrite the internals of The Overviewer, we have stripped overviewer.py of almost all its command line options and opted to require everything but the simplest renders into a new config file format. This post goes over the rationale and how to get started with the new format.

Why?

Before it was possible to run the Overviewer without a configuration file at all. Every option was on the command line, and the only thing you needed the config file for was custom rendermodes.

But as we were thinking about supporting multi-world, where a server may run many Minecraft worlds, we wanted Overviewer to handle options in a more general way. Some options may only apply to one render of one world, others may apply to all renders.

We briefly considered how to support this on a command line, perhaps with something like this:

./overviewer.py --world=/path/world1 --opt=1 --world=/path/world2 --opt=2

but this seems cumbersome and confusing. It seems obvious that a more structured method of configuring your renders is needed.

The Config File

So here's the solution we came up with. It lets you individually specify "renders", which is a rendering of a world with a set of options. You can specify multiple renders of a single world with different options, renders of different worlds, etc. We tried to leave it as customizable as possible.

The configuration file is, as before, parsed as a regular python file, meaning you can put any extra complicated logic you want in there. After it's parsed, it expects three things to be defined:

• a dictionary called "worlds" that maps world names to their paths on disk.
• a dictionary called "renders" that maps render names to a dictionary of options.
• a string called "outputdir" containing the path to the directory to place the output

I have written up further details about the config file on the documentation site: http://docs.overviewer.org/en/latest/config/. Head there and have a look over it to get an idea of what's possible. I don't want to repeat what's there, and I think that's a pretty good place to start.

Converting your existing setup to a config file

Most likely you have some setup where you run overviewer.py from a cron or on a schedule with a bunch of options. Let's say you're running this:

overviewer.py -v --north-direction=upper-right --imgformat=jpg --rendermodes=smooth-lighting,smooth-night /path/to/myworld /path/to/mymap

To migrate to the new branch, you should first create a config file. It can be named anything you want. If your editor has syntax highlighting, it will be helpful to give it the extension .py, but it's not necessary.

Say you create "myovconfig.py". This is what you'd add to that file to duplicate your setup:

worlds["myworld"] = "/path/to/myworld"

renders["dayrender"] = {
        "world": "myworld",
        "title": "Daytime",
        "rendermode": smooth_lighting,
        "imgformat": "jpg",
        "northdirection": "upper-right",
        }

renders["nightrender"] = {
        "world": "myworld",
        "title": "Nighttime",
        "rendermode": smooth_night,
        "imgformat": "jpg",
        "northdirection": "upper-right",
        }

outputdir = "/path/to/mymap"

Note: the 'world' option was named 'worldname' up until recently.

Then you run Overviewer with this command:

overviewer.py --config=/path/to/myovconfig.py

Yes, it is a bit more verbose, but you can see how it is much more customizable than before. You can change the options for the individual renders, add renders for other worlds, add additional renders for the same world (perhaps with a different north-direction!) It's up to you!

As always, join us in IRC if you have any questions!

I've written up a guide that assumes next to nothing about windows command prompts.

The Overviewer is a command-line program, and that is a barrier for a lot of people. While we have to compromise at some level -- not all the documentation can be written assuming no command line experience -- we do want to lower that barrier.

So with that, I present the first draft of the Windows Noob Guide to The Overviewer. Hopefully that will be enough to get more people started.

We love feedback. Please join us on IRC and help us improve the documentation!

About a GUI: We would love to make a GUI frontend for The Overviewer, but nobody has put forth the time and effort yet. Several people have started a GUI in the past, but nothing has materialized. If you are interested in helping us out on this front, please join us in IRC and discuss your ideas.

Edit: Mar 3 2012: The new beta has now been merged into master, and as such, some parts of this post (like how to try it out) are outdated. See this post.

Edit: Mar 1 2012: updated this post for the Anvil format. -brownan

We've been working hard for the last two months to almost completely re-write a lot of the internals of The Overviewer. And now we need your help to test it out, and give us feedback!