Skip to content

Installation for SpongeForge Server

Daniel Simmons edited this page Feb 23, 2016 · 3 revisions

Overview

There are 2 primary implementations of SpongeAPI available, these are SpongeForge and SpongeVanilla (for more info see Choosing an Implementation). I have only tested IslandCraft with SpongeForge. I am unsure if SpongeVanilla currently implements the World-Generator API. These instructions will guide you through the process of setting up your own SpongeForge server and creating a new world using IslandCraft.

If you would like to use IslandCraft for a singleplayer world, you can follow these instructions instead.

References

If the information on this page is out of date, or you'd rather read it from the source, check out these links.

Installing Java

At the time of writing SpongeForge requires at least Java 1.8.0_40. You can check your current Java version by typing "java -version" in a command line console. If your version is less than 1.8.0_40 (or you do not have Java installed), please download the latest Java SE Runtime from here: http://www.oracle.com/technetwork/java/javase/downloads/index.html

Downloading SpongeForge

SpongeForge is available from http://files.minecraftforge.net/spongepowered. Select the link "Download Recommended > Mod". At the time of writing this is version "1.8.9 - 3.1.0-BETA-1046". If you are having trouble running IslandCraft with the latest recommended version, you can try getting this exact version from the "Show all downloads" section on the same page.

You should now have downloaded a file with a name similar to "spongeforge-1.8.9-1691-3.1.0-BETA-1046.jar". Take note of the number I have emboldened. This is the version of MinecraftForge required to use this build of SpongeForge. You will need to know this for the next step. For more information about these numbers see Reading the Download Filename.

Downloading MinecraftForge

SpongeForge (an implementation of the SpongeAPI) is itself a MinecraftForge mod. This means you need to setup a MinecraftForge server to run SpongeForge.

IMPORTANT: you need to download the exact version of MinecraftForge required by the version of SpongeForge you have downloaded. In my case this is 1691, but please check the MinecraftForge version number in the name of the SpongeForge file you have downloaded. For more information about these numbers see Reading the Download Filename.

Now that you know which MinecraftForge version you need to download, please look for this version under the "Show all downloads" section on this page: http://files.minecraftforge.net/. In my case this is version "11.15.0.1691". As I am running Microsoft Windows, I select the "Installer-win" link next to this version. The file I have downloaded is "forge-1.8.9-11.15.0.1691-installer-win.exe".

Installing MinecraftForge Server

Now that you have downloaded the correct version of MinecraftForge for the latest recommended release of SpongeForge, it's time to install the MinecraftForge server.

Run installer you have downloaded, it should have a name similar to "forge-1.8.9-11.15.0.1691-installer-win.exe". Select the "Install server" option and browse for an empty directory to install the server, I will refer to this directory as <server>. Click OK. Wait for the installer to finish.

Installing SpongeForge

If you are following carefully, you should have already downloaded SpongeForge. The file should have a name similar to "spongeforge-1.8.9-1691-3.1.0-BETA-1046.jar". Move this file from your downloads folder to "<server>/mods" (this "mods" folder will not exist yet, you have to create it now).

Running the MinecraftForge Server

Create a new text file in the directory "<server>". Name this file "run.bat" and write in it:

java -jar <name-of-forge-jar>
pause

(where <name-of-forge-jar> is something similar to "forge-1.8.9-11.15.0.1691-universal.jar"). Save this file, then run it.

The first time you run the server it will crash as you need to accept the Minecraft EULA. If you do choose the except this EULA, open the file "<server>/eula.txt" and set "eula=true". Save, then run the server again.

When the server has finished initializing, fire up a vanilla Minecraft client and connect to your server using the address "localhost". If this works, you're ready to install IslandCraft!

Installing IslandCraft

Download the latest IslandCraft JAR from here: https://github.com/hoqhuuep/IslandCraft/releases.

If your MinecraftForge server is still running, stop it by typing "stop" into the server's console.

Copy the IslandCraft JAR file into "<server>/mods", you should already have the SpongeForge file in this folder.

Navigate to "<server>/config/sponge/worlds/overworld/world/" and open world.conf using your favorite text editor (if you wish to enable IslandCraft on a different world, go to the config folder for that world instead). Scroll to the bottom of the file and add a line world-generation-modifiers=["islandcraft:biomes"] just before the final "}". Like this:

        # Enable if this world should be registered.
        world-enabled=true
    }
    world-generation-modifiers=["islandcraft:biomes"]
}

Save this file.

Finally we need to reset the world to get the new IslandCraft terrain generation. You can do this by deleting the folder "<server>/world". Now run the server again using the "run.bat" file you created. When it has finished initializing, you can connect again with your client. You should find yourself in a world filled with islands!