Help/Quick install guide

This is a brief explanation of the most important functions of the GUI. If you want more information, please read the full manual.

Installing the GUI

Downloading

The GUI can be downloaded from bukkitdev.

  • Stable releases will be uploaded to bukkitdev.
  • The latest version is always available as download link in the description.
  • If you have already an older version of the GUI installed, you can use the automatic updater.

Installing

If you run a server on your own computer, but you don't have a server

  • Drop the GUI in an empty folder. This folder will become your server folder.

If you run a server on your own computer, but you do have a server already

  • Drop the GUI in the server folder (the same folder as your startup script)

If you run a server on a different machine

Drop the GUI somewhere on your computer.

First run and configuration

If you run a server on your own computer, but you don't have a server

  • Go to the superstart tab
  • Make sure the server type is set to "Bukkit"
  • Click "Download latest Recommended Build"
  • The latest recommended build will now be downloaded
  • Set minimum RAM to 64MB or higher
  • Set maximum RAM to 1024MB or higher
  • You can now click "Launch server"

If you run a server on your own computer, but you do have a server already

  • Go to the superstart tab
  • Make sure the server type is set to "Bukkit"
  • Enter the path to your craftbukkit.jar file in the textbox (the file CAN have a different name, but it must be your server program)
  • Set minimum RAM to 64MB or higher
  • Set maximum RAM to 1024MB or higher
  • You can now click "Launch server"

If you run a server on a different machine

  • Click here to see "how to configure a server using Remote JSONAPI"
  • You can now click "Launch server"

Running a server using the GUI

The "General" Tab

This tab contains all things needed to run a server. Once your server settings are set, you can run a server in the "general" tab. The upper part of the tab contains server input and output:

  • A list with all online players - A more detailled list is available in the "players" tab
  • A textbox with the server output - All server output will be displayed here. Colors will be assigned depending on the message.
  • A textbox and button for server input - Enter commands in the textbox, and press enter or press the button to send.
  • A checkbox to enable say - If you check this box, everything you type in the input box will be broadcasted on the server (the same as if you would use /say)

The general tab contains 4 buttons in the bottom-left corner:

  • Start/Stop - This button will start or stop the server.
  • Restart - This button will stop, and immediatly restart the server
  • Reload - This button tells the server to reload
  • Kill - If the server does't respond, you can use this button to stop the server. However, use it with caution and at own risk. Using this button might cause data loss!

The general tab shows also 6 bars:

  • GUI CPU usage - CPU usage by the GUI
  • Server CPU usage - CPU usage by the Minecraft server
  • Total CPU usage - Total CPU usage by the computer
  • GUI RAM usage - RAM usage by the GUI
  • Server RAM usage - RAM usage by the Minecraft server
  • Total RAM usage - Total RAM usage by the computer Also shown in the general tab:
  • a small text telling you how long the server has been running since the last start.