Installation

Feb 19, 2017
Installation
  • Spigot Installation

    A guide



    Spigot is a fork of CraftBukkit with extra optimizations and more features sprinkled on top. Installing it is simple because it is a drop-in replacement for your typical CraftBukkit JAR.

    If you already have CraftBukkit successfully installed, installing Spigot is usually as simple as replacing your server JAR with the new one.

    If you are upgrading from a pre-UUID version of Spigot or CraftBukkit to 1.7.9+, please read the UUID conversion guide.

    Keep in mind that Java 8 is the recommended Java version for all Minecraft applications.
    Java 8 contains many improvements to java which can overall improve the performance of your server, as well as ensure that you're capable of running plugins which are compiled with newer features of Java. Please also note that Mojang is set to remove support for Java 6/7!

    The instructions for running and compiling Spigot/CraftBukkit have been changing over the past few months. Please make sure to check out the BuildTools wiki page for latest compilation instructions.

    These instructions will not work with java 6! While the current documentation will work on Java 7+, it is recommended to update to ensure that your setup will remain supported. If you wish to dismiss this warning, you will need to replace the startup command in the examples

    "java -Xmx1G -XX:MaxPermSize=128M -jar spigot.jar".


    Installation(top)


    It is highly recommended to run your server in a directory other than the one you run Buildtools in. Not only is it better from an organizational standpoint, but running the server and Buildtools in the same directory can cause Buildtools to fail and / or make troubleshooting issues harder.

    Windows(top)

    1. Paste the following text into a text document. Save it as start.bat in the same directory as spigot.jar:
      You will need to rename your jar to spigot.jar, or modify the file in the bat file to point to the correct file.
      nb: Windows (by default) will hide the .jar extension of the file.
    2. Code (Example):
      @echo off
      java -Xmx1G -jar spigot.jar
      pause
    3. Double click the batch file.
    4. Windows (optional) (use this if you want /restart to work)
      The following will work as well:
      Code (Example):
      @echo off

      :restart
      java -Xmx1G -jar spigot.jar

      goto restart

    Linux(top)

    1. As a prerequisite, install Java 7 or above if you don't have it already [Ubuntu, CentOS].
    2. Compile the latest build by following the BuildTools wiki page.
    3. Place the file in a new directory dedicated to Spigot.
    4. After running BuildTools you will find the Spigot/CraftBukkit server jar files in the same directory.
    5. Create a new startup script (start.sh) in the directory to launch the the JAR:
      Code (Example):
      #!/bin/sh

      java -Xmx1G -jar spigot.jar
    6. Open your terminal and execute the following in the directory:
      Code (Make executable):
      chmod +x start.sh
    7. Run your start up script:
    8. Code (Run command):
      ./start.sh

    Mac OS X(top)

    1. As a prerequisite, install Java 7 or above if you don't have it already [OS X].
    2. Compile the latest build by following the BuildTools wiki page.
    3. Place the file in a new directory dedicated to Spigot.
    4. Create a new startup script (start.command) to launch the JAR:
      Code (Example):
      #!/bin/sh

      cd "$( dirname "$0" )"
      java -Xmx1G -jar spigot.jar

    5. Open Terminal and type into it: (Don't hit enter!)
      Code (Text):
      chmod a+x
    6. Drag your startup script file into the Terminal window. (Be sure to put a space between chmod a+x and your startup script!)
    7. Double click your startup script.

    Multicraft(top)

    Depending on your Minecraft host's configuration, you will have two ways to enable the use of Spigot through Multicraft.
    • If there's already an option for Spigot in the JAR file selection menu, you can simply select it and restart your server upon save. However, this may not be recommended if your host does not keep up to date with the latest Spigot builds.
    • If you have access to upload custom server JARs (FTP), download the Spigot JAR and enter in the name of the file via the JAR file input box located on the index of the panel. Some hosts may require you to rename your JAR to a specific name (like custom.jar) and then select it from the dropdown menu.
    • If your personal server you have root to, place the spigot.jar.conf in your daemon jar directory, then update the jar using the admin panel. The jar should now be the clients jar selection.

    Post-Installation(top)

    After the Spigot.jar has been run the first time, folders and config files will be created. You will need to edit these config files to have the server work properly in your environment.
    For information on:
  • Loading...
  • Loading...