Sales:  800-573-7846 or Live Chat

The ServInt Source

Install Minecraft Overviewer on cPanel

tech bench game techEditor’s note: this tutorial assumes you are familiar with working on the command line on your server via SSH. If you’re not, you might want to check out this article first to get your feet wet.

In previous Tech Bench posts, we discussed how to install vanilla Minecraft and how to install Bukkit Minecraft, but how can you look at your beautiful server maps and buildings and show them off to your friends? Minecraft Overviewer is one solution.

As I’ve mentioned before, Minecraft is memory intensive. Minecraft Overviewer is also memory intensive. I would recommend at least a Signature VPS for hosting a Minecraft server, but an Ultimate would be better.

mcmap2

Here is how to install Minecraft Overviewer on a cPanel VPS.

Download and install the Minecraft Overviewer repository

wget -O /etc/yum.repos.d/overviewer.repo http://overviewer.org/rpms/overviewer.repo

yum install Minecraft-Overviewer

Note: the wget command works for CentOS, Red Hat EL, and Fedora operating systems. If you are running another OS,  check out the Overviewer downloads page for more help.

Configure Minecraft Overviewer

The configuration of Overviewer can be tricky, but it really boils down to two things:

  1. Where is your Overviewer configuration?
  2. How/where do you want to view the map?

Finding your Overviewer configuration

I have my minecraft server installed in /home/minecraft — a cPanel account. That places my world directory in /home/minecraft/world. Note where your world directory is. Now decide where you want to place your overviewer configuration information — I placed mine in /home/minecraft/overviewer. You will need two files in this directory, the textures file and the overview configuration.

  1. Upload your preferred textures.

You will need to upload the textures you want to use, you can do this with FTP, SCP, rsync, the cPanel file manager — basically anyway you would normally upload files to the server. My preference is to use the default textures for Minecraft, which can be found in your Minecraft game client. For example, my game client is loaded on my home computer running Ubuntu. Here is the location for textures in Ubuntu:

/home/account/.minecraft/versions/1.7.5/1.7.5.jar

I placed this file in my Overviewer directory:

/home/minecraft/overviewer/
  1. Create your configuration file.

The configuration file will tie everything together. Create a file and place it in your chosen directory. I called mine overviewer.cnf and placed it in /home/minecraft/overviewer along with the textures file.

Here is the contents of my configuration file. You can use this as a template or craft a more complex configuration.

worlds["My world"] = "/home/minecraft/world"
renders["normalrender"] = {
 "world": "My world",
 "title": "Normal Render of My World",
 }
outputdir = "/home/minecraft/public_html"
texturepath = "/home/minecraft/overviewer/1.7.5.jar"

The worlds line covers where your Minecraft world is stored, renders covers the type of render and what you want it to be named, the outputdir is where it places the finished render, and texturepath is the location from which Overviewer pulls the map textures to generate the map.

Generate your Minecraft Overviewer map

Once you’ve completed the Minecraft Overviewer configuration, you can run Overviewer with this command:

overviewer.py --config=/home/minecraft/overviewer/overviewer.cnf

mcmap1This will generate the map in the public_html directory of the account you set. If you ran this as the root user you will need to change the owner from root to the cPanel account name. At this point you should be able to view the map in your web browser.

If you want to have this run automatically — and you probably will — you will need to create a cron job in cPanel. Log into cPanel and create a cron job with the command:

overviewer.py --config=/home/minecraft/overviewer/overviewer.cnf

The frequency is up to you, but cPanel will have some examples and recommendations. To view the map from a website the permissions will need to be account:account.

That’s it. Have fun sharing your Minecraft Overviewer maps with your friends and fellow players!





About Bill Brooks

Bill Brooks is an Escalated technician and the Continuing Education Facilitator for ServInt's Managed Services Team. He is a life-long tech enthusiast and enjoys music, video games and hockey on the side.


The ServInt Source | Web Hosting Blog