Tutorials/Setting up a server

= Download the Minecraft Server = Download Minecraft_Server.exe or minecraft_server.jar from the Minecraft downloads page.

Windows users can use either the exe or the jar, while OSX and Linux users can use only the jar.

It is recommended that you create a folder either on your computer's desktop, or elsewhere in your computer, for the server files. The server app should go in the folder you create.

Note: There is also custom server software available, but note that these applications are not supported by Mojang.

= Windows Instructions =

Downloading
Ensure you have the latest server application software. Look under "Download the Minecraft Server" above for instructions.

Verifying and Installing the Latest Java

 * 1) Make sure that you have Java 6 installed. To do so, we first need to open up CMD.
 * 2) * In Vista/7 open the start menu and enter cmd in the search field, and press enter.
 * 3) * In XP open the start menu and click Run, then enter cmd and press enter. You can also hold the Windows key down and press R to open Run.
 * 4) * At the command prompt, enter the following command, and press enter:
 * 5) * Java then should display its version, and should read "java version 1.6"
 * 6) If you have a previous version (less than 1.6) or you get this error: " ", then you need to install/update the computers java version. You can do so at the java download page.
 * 7) After you installed the latest java try again with.
 * If you get an error at this point, try the following to add java to your system path.
 * 1) Right click Computer
 * 2) Click properties
 * 3) Click "Advanced system settings"
 * 4) Click "Environment Variables"
 * 5) Under system variables, find the Path variable.
 * 6) Click edit, and append to the end of the value: ";C:\Program Files (x86)\Java\jre6\bin"
 * 7) Now re-open the command prompt and try again.

Start the Minecraft Server (exe version on Windows)
Double click on the "Minecraft_Server.exe" and the server should start.

Start the Minecraft Server (jar version on Windows)
You will need to have a path variable set up for Java in order to start the jar version of the server. Refer to step 3 of "Verifying and Installing the Latest Java" above to set up a path variable.

To start the jar version of Minecraft on Windows, create a new file in Notepad, and paste in " "

Save the file as start.bat, and place the file in the same folder as minecraft_server.jar. The .bat extension saves the file as a batch file.

Double click start.bat, and the Minecraft server will run.

Starting the jar version with more/less memory
Edit the code in the batch file you created, and increase/decrease the numbers to greater or less than 1024. The default amount, 1024, allocates 1 GB to the server application.

Don't allocate more memory than you currently have!

Starting the jar version without altering your system path
To start minecraft.jar server without having to change your system path variable you need to instead express the path variable for Java in the "start.bat" file. This is handy because it allows you to still run commands from command prompt using the default system path, without having to constantly edit the system path.
 * 1) To do this open your start.bat file (or whatever you've named it) with Notepad.
 * 2) On the very first line add the command, then following with the system location of Java.
 * 3) Most commonly this path will look like "C:\Program Files (x86)\Java\jre6\bin", so what you would then write is.
 * 4) Make sure that on the following line you still have the code  to run the actual server file.

Configure and connect
Now it is time to configure and connect.

= Linux Instructions = This tutorial for how to set up a Minecraft server on Linux was designed for people who don't have a lot of experience with Linux. There is a more advanced tutorial in the forums. This tutorial was tested on Ubuntu 9.10 32-bit but should work with the descendants of Debian.

Downloading
Ensure you have the latest server application software. Look under "Download the Minecraft Server" above for instructions.

Verifying Java version
Open the terminal from Applications > Accessories > Terminal. Enter.

Make sure that you have version 1.6

Installing Java
If you get  (which may be followed by more text) or if you do have another Java version than 1.6 then you need to install or update java. The official Sun Java is recommended. Quite a few individuals have experienced issues with OpenJDK. If OpenJDK is installed, remove it before installing the official Sun Java.

Debian
To install Java, simply type this in terminal and press enter:

Ubuntu
For Ubuntu 10.04 LTS and on, the sun-java6 packages have been dropped from the Multiverse section of the Ubuntu archive. You must add these sources: Some distros have the command "add-apt-repository" removed. If this is the case, you will need to add the python properties by running the following command:
 * For Ubuntu 10.04 LTS (Lucid Lynx):
 * For Ubuntu 10.10 (Maverick Meerkat):
 * For Ubuntu 11.04 (Natty Narwhal): Thelongmile 08:48, 22 May 2011 (UTC)

Then you can proceed to add the source:


 * Then install the packages:

openSUSE
Use

Gentoo
First you have to add the Java license to make.conf to be able to emerge the JRE. Be sure to read the license and if you accept it add this into /etc/make.conf:

After this, we can emerge the JRE itself:

If you have other JREs installed use this to display them:

And then use this to set the JRE for either system or user:

Other Distros
Alternatively, you can visit Java's website directly to download the Java package for Linux. Most distros work with this (either 32 or 64-bit). Instructions for the installation of those different packages are given on the site.

If during installation, it asks for a password, enter your password. If you get asked "Is this OK [Y/N]" Enter Y and press enter if required. Java should now be installed.

Start the Minecraft server
Open the terminal again (Applications > Accessories > Terminal). Enter the following commands: (change minecraft_server to the same name of the folder you extracted the server to)

Less than 1GB free RAM
If you have less than 1024MB RAM, the above line may cause problems with swapping and out of memory conditions, which makes the game hard to play. Measure your current free RAM: It may look like this:

You are interested in the last number in the third line, 2163 in this case. Subtract some RAM as safety. On this computer, the server may use up to 1536 MB RAM. Now, replace the 1024 in the above example with the calculated number:

Voila, it should run smoothly now.

Tip: If you want to spare more memory, you may set the -Xms parameter even lower, say:

The parameter controls how much memory is reserved on startup. Your server will start with 32MB RAM and whenever it needs more memory it will allocate some until it reaches the maximum of 512M. However, this will result in a little slowdown whenever the allocation is done.

Startup and maintenance script
Alternatively you can automate the startup of the Minecraft server.

Server startup script

Configure and connect
Now it is time to configure and connect.

= Mac OS X Instructions = Setting a server up in Mac OS X is "more involved" than in Windows because Notch has not provided an executable. For a full video tutorial click here. Keep in mind that the server won't run correctly on OSX 10.4 and may crash your machine.

Downloading
Ensure you have the latest server application software. Look under "Download the Minecraft Server" above for instructions.

Installing Java
Mac OS X already comes with its own version of Java that is updated automatically via Software Update (Apple menu > Software Update).

Setting up the Minecraft Server
Ensure you have followed the download step before proceeding.

Create a folder, if you haven't already, and put minecraft_server.jar into it. For example, create a folder on the Desktop named minecraft_server and drag the jar file into it. Open TextEdit, set the format to plain text (Format > Make Plain Text), copy and paste in the following code, and save the file as "start.command" in the same folder as minecraft_server.jar. cd "$(dirname "$0")" exec java -Xmx1G -Xms1G -jar minecraft_server.jar
 * 1) !/bin/bash

This will give the server enough RAM to run. The amount of RAM can be changed by editing the  to something else, such as   for 2 GB. Open Terminal (in /Applications/Utilities/Terminal). Type in, with a space after it, then drag and drop the start.command file into the terminal window, then press enter. (This gives run permission to the script.)

Double-click the start.command file to start the server.

Run as a daemon
Alternatively you can automate the startup of the Minecraft server.

Create a Mac OS X startup daemon

Configure and connect
Now it is time to configure and connect.

= Configuring the Minecraft Server =
 * 1) Configure the server by editing the server.properties (Use this link to see how it works). Windows may not recognize it, so tell it to open with any word processor (such as Notepad or Notepad++). The server should run fine from the default values.
 * 2) Add your username to the admin.txt and/or ops.txt (newer versions may not have an admin.txt file). Admin.txt allows you to execute server commands, and op privileges allows you to destroy/place blocks. Add the name exactly as it is. From the server gui, you can type "op " and it will automatically update the ops.txt file.

= Connect to the Minecraft Server =
 * To test the server, if you are playing on the machine you are hosting on, select the "Multiplayer" option in the game client (or browser client) and type in "localhost".
 * For people connecting from the internet, they must connect using your external IP address. You must port forward for someone outside your network to connect to the server.
 * Users within your network can connect with your internal IP address. You do not need to port forward for connections that are within your local network.

IP address notes

 * Unless you set a static IP for the computer that is hosting the game, the internal IP address can change. This affects port forwarding rules, and can make them invalid. Each modem or router has a different way of setting a static IP address. You should refer to the manual for your device(s) or online documentation for further instruction.
 * If you are having players connect to your external IP, your external IP can change if you do not have a static IP from your internet service provider. Use a tool such as http://mywanip.com/ to periodically check on the external IP address. Alternatively, you can look into a dns service that will allow you to have a name, rather than an IP address, that will remain the same. The name will point to your external IP address, regardless of whether or not it changes (the dns is updated when changes occur). An example of a free dns service is Dyndns.

Firewalling, NATs and external IP addresses

 * You must open the port (default is 25565) in TCP, in the firewall

If the server in question is not reachable via a globally routable address, you will need to add appropriate address and/or port number translation rules to the gateway — usually your router that does have the global address.


 * For help with address translation, opening the firewall and routing (these three make up what people call port mapping/forwarding), portforward.com is a good source. Select your router from that list, skip the ad that comes after selecting the device, and you will see instructions for setting up port forwarding. Alternatively, you can read the documentation supplied with your router, modem, or other ISP related hardware.
 * Verify the port is open, and note your external IP by using a port checker tool, such as http://www.yougetsignal.com/tools/open-ports/. The default port you should test is 25565, unless you specified something else. Have the Minecraft server running when you test the port.
 * You can obtain your external IP address from http://www.yougetsignal.com/what-is-my-ip-address/.

Setting Up a VPN (Hamachi)
An easy way to set up a server between you and your friend is to set up a VPN (virtual private network). A free software utility that can be used to set this up is Hamachi by LogMeIn.

Advantage of doing this saves you configuring ports on your router and if you have a dynamic IP address using Hamachi will provide you with a static IP.


 * 1) Install software on you and your friends computers  https://secure.logmein.com/products/hamachi2/ or https://secure.logmein.com/US/labs/?wt.ac=73-516-440 for Linux (32-bit and 64-bit .deb and .rpm packages are available, you can install it on Gentoo by emerging "net-misc/logmein-hamachi")
 * 2) One person sign up for admin via logmein website
 * 3) Create new network
 * 4) Pass these details onto every person concerned and get them to login
 * 5) One person set up a server.
 * 6) Everyone else connect via their Hamachi ip address and use port number 25565 (default)

= Customization =

Insert a world
To load a level you have in SSP onto your server, copy the world from the saves directory in your minecraft folder and paste it to the server's directory. You can have as many worlds as you want in the server's directory. To switch between them change the name of level-world= in server.properties to the world you wish to play on.

Name the server
To name your server, change the name after server-name=. This is what will appear on the public server list.

Change the start message
To change the Message of the Day, change the text after motd=. This is what will appear when players connect to your server.

Change the number of players
To change the amount of players allowed, change the number after max-players=. This number is how many players (including you) can be in the server at one time.

= Reporting problems in the forum = Before you can ask for help in the forums make sure that your problems is not listed in the Common Problems

If your problem is not listed you can create a new thread asking for help in the Server Administration Make sure to include as much information as possible:


 * Operating system
 * What you were trying to do
 * What you did so far
 * Any errors you encountered
 * Screenshots of the problem (if possible)

= Other tutorials = Here are some other tutorials on how to set up a Minecraft server.


 * Full video tutorial for setting up Minecraft server on Mac OSX, including port forwarding
 * Another Mac OSX and port forwarding tutorial
 * Alternate Mac OSX video
 * Linux tutorial for more advanced users
 * Windows tutorial with focus on how to forward a port
 * Guide to setting up an alpha server using Virtualbox.
 * How to install a Minecraft Server on Debian (German)