- Java runtime environment
- Minecraft Server JAR
- Screen v4.x
- c10t (for cartography to work)
- brownan's overviewer script (for overviewer to work)
- Donkey Kong's Biome Extractor (for biomes)
- unzip (for auto updating)
- Install the required programs ### Screen and unzip
Try: sudo apt-get install screen unzip
Or: sudo yum install screen unzip
- Download from udoprog's repo:
- Download from brownan's repo:
- Download from Donkey Kong's post (was tested as of 0.6a):
- copy the script into your minecraft server folder.
allow the script to be executed
chmod +x minecraft.sh
check the rights of the script user. Every folder specified in the configuration phase has to be available to him.
- edit the script to configure it (see the configuration section)
- I strongly recommend using crontab to automate some of the process. I prefer to perform logs + cartography + server restart at 4AM every day.
- The 'logs' command should always be used BEFORE a restart, as the restart wipes the previous logs. I'm running hey0's servermod, which allows to have a log history, but thats not the case for everyone.
- I also recommend setting an Internet public folder, for the maps images to be displayed. People on my server love this feature, as they know a new map is generated every day, and they can see the evolution of our world.
- I made an alias to be able to use 'minecraft command' instead of './minecraft.sh command'. It also enables the automatic completion, if you type 'mine' then press tab. Much quicker =) You can do this by editing /home/USER/.bashrc, and adding the line:
(of course, change the path if needed)
If using Brownan's Overviewer to create Google-like maps of your worlds, be sure you are using the --cachedir=/path/to/dir to change the location of the png files as you will start to take up considerable space since it defaults to save the files inside of the world folder. This can grow backups that are only 3mb to 99mb files. If you are not cleaning the logs, this will start to consume a considerable amount of hard drive space.
There are several variables to set before you can run the script for the first time. Open minecraft.sh with a text editor, and edit the following lines, at the beginning of the file :
This is the path to the world folder
This is the name of the screen the server will be run on
This is the maximum size of RAM you want to allow the server to use, if you are not sure, keep this and MEMALOC identical.
This is the size of RAM you want to allocate to the server
Do you want the screen to be displayed each time the server starts? 1 if yes, 0 if no.
This is the path to your minecraft folder
If you are running hey0's servermod, this needs to be set to 1 (better logging and automatic updating of the mod)
If you want your script to update runecraft automatically too, set this to 1
This is the path to the backup folder. Map backups and old log entries will go there.
How long will incremental map backups be kept? (Only used with the './minecraft.sh backup full' command)
How long will full map backups be kept? (Only used with the './minecraft.sh backup full' command)
Naming convention for full backups.
Naming convention for incremental backups.
This is the path to the logs folder
How long will the logs be kept? (Only used with the './minecraft.sh logs clean' command)
This is the path to c10t's cartography script
This is the path to the world maps folder
This contains all of the options you want when running cartography.
This is the path to MinecraftBiomeExtractor.jar
This is the path to Overviewer (gmap.py)
This is the location where Overviewer will render
This is the path for the cache directory for Overviewer
Detailed Command Usage
Without arguments, the script will resume the server screen. (If you want to close the screen without shutting down the server, use CTRL+A then press D to detatch the screen)
Tells you if the servers seems to be running, or not.
./minecraft.sh start [force]
Starts the server. If you know your server is not running, but the script believe it is, use the force option.
./minecraft.sh stop [force]
./minecraft.sh restart [warn]
If the warn option is specified, it will display a warnning 30s & 10s before the restart happens.
./minecraft.sh logs [clean]
Parses logs into several files, grouped into a folder named with the date of the logging. If the clean option is specified, it will move the older folders into the backup folder. Again, this command should be issues before a server restart.
./minecraft.sh backup [full]
Displays a message to the players if the server is online, stops the writing of chunks, create a dated archive and backs up the world folder. If the full option is specified, it will delete the older incremental and full archives based on the settings.
Displays a message to the players if the server is online, stops the writing of chunks, initiates c10t's cartography script. I strongly recommend the MAPS_PATH to be an internet public folder.
Displays a message to the players if the server is online, stops the writing of chunks, initiates Brownan's Overviewer script. I strongly recommend the MCOVERVIER_MAPS_PATH to be an internet public folder as well.
Running the extractor will disable saving, make a copy of your world, run the calculations, move the data into your world folder, before deleting the copy that is made and saving is turned back on.
Stops the server if it is online, backs up the old binairies, downloads the last binaries from mincraft.net and restarts the server.
Future updates :
- Bugfixes ?
- Better log parsing, this one is realy primitive
- Anything you could think of.