Installation

Aug 9, 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.

    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.


    Installation(top)


    Windows(top)

    1. Paste the following text into a text document. Save it as start.bat in the same directory as spigot.jar:
    2. Code (Example):
      @echo off
      java -Xms512M -Xmx1G -XX:+UseConcMarkSweepGC -jar spigot.jar
      pause
    3. Double click the batch file.
    4. Windows (optional)
      The following will work as well:
      Code (Example):
      @echo off

      :restart
      java -Xms512M -Xmx1G -XX:+UseConcMarkSweepGC -jar spigot.jar

      goto restart

    Linux(top)

    1. As a prerequisite, install Java 8 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 JAR:
      Code (Example):
      #!/bin/sh

      java -Xms512M -Xmx1G -XX:MaxPermSize=128M -XX:+UseConcMarkSweepGC -jar spigot.jar
    6. Note: MaxPermSize is no longer needed or supported in Java 8, and for Debian this start.sh script code will not work.
    7. Open your terminal and execute the following in the directory:
      Code (Make executable):
      chmod +x start.sh
    8. Run your start up script:
    9. Code (Run command):
      ./start.sh

    Mac OS X(top)

    1. As a prerequisite, install Java 8 or above if you don't have it already [OS X].
    2. Compile the latest build of spigot by doing the following: a. Creating a start.command script in a folder with buildtools.
      Code (Example):
      #!/bin/sh

      cd "$( dirname "$0" )"
      java -Xms512M -Xmx1G -XX:MaxPermSize=128M -XX:+UseConcMarkSweepGC -jar spigot.jar
    b. putting in BuildTools.jar c. save the script into the folder that has buildtools. d. giving yourself permission using chmod a+x in terminal, and dragging the command script into the terminal window. e. double click on the script, and wait for 5-10 minutes for the files to download.
    1. Create a new startup script (start.command) to launch the JAR:
      Code (Example):
      #!/bin/sh

      cd "$( dirname "$0" )"
      java -Xms512M -Xmx1G -XX:+UseConcMarkSweepGC -jar spigot.jar
    2. Open Terminal and type into it: (Don't hit enter!)
      Code (Text):
      chmod a+x
    3. Drag your startup script file into the Terminal window. (Be sure to put a space between chmod a+x and your startup script!)
    4. 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:
    If the server is working incorrectly, be sure you have port forwarded and you have followed the steps closely. If you are having issues, you can create a help thread in the Spigot forum or come chat to us in IRC.

    Due to the inefficiency of the Windows and Mac OS X kernels (e.g. high overhead, poor resource allocation, and such), it is not recommended to host on these platforms for a serious/dedicated server.

    Plugins(top)

    In practically all cases, your Bukkit plugins will work on Spigot, unless the author of one of your plugins uses certain internal CraftBukkit/Minecraft code.

    Check out our Resources section or BukkitDev to find a wide variety of plugins, that range from helping with administration to adding completely new gamemodes. If you cannot find anything there you could request a plugin to be made on Spigot's Services & Recruitment forum or Bukkit's Plugin Requests Forum. Please be sure to follow the guidelines on how to setup a request.

    You can add your plugins by dropping the JAR file into your plugins folder in your server directory and restarting the server. If it does not work or if you see errors seek help on the Spigot Forum
  • Loading...
  • Loading...