Installing SpongeForge

SpongeForge integrates Minecraft Forge so you can also run Minecraft Forge mods. In fact, it’s more like Sponge itself is a Forge mod that then loads Sponge plugins, but this is a technical detail.

Users who do not want to use Minecraft Forge can consider SpongeVanilla.

Изтегляне

Grab your copy of Sponge Forge here.

Reading the Download Filename

When you download SpongeForge, the name of the file will provide some important version information. It includes a Forge build number which this version of SpongeForge is compatible with. Other builds, even ones differing by only a few build numbers are not officially supported.

However, SpongeForge usually updates to a new Forge build fairly soon after it’s released, so you needn’t worry about always having to run an outdated Forge version in order to use SpongeForge.

The format of the filename is spongeforge-<MCVersion>-<ForgeBuildId>-<SpongeAPIVersion>-BETA-<SpongeBuildId>.jar

MCVersion

The Minecraft version. Only clients compatible with this version can connect.

ForgeBuildId

Preferably your server should run this exact version of Forge (which can be identified in the last part of Forge’s version string).

SpongeAPIVersion

The version of the SpongeAPI implemented by this file. This is what Sponge plugins depend on.

SpongeBuildId

The build number of Sponge. This is what you should supply when reporting bugs or seeking support.

Example

SpongeForge 的 Jar 文件的命名始终遵循此结构，这样做有助于判断兼容性。

例如，文件名 “spongeforge-1.10.2-2254-5.2.0-BETA-2234.jar” 意味着了此版 SpongeForge 为其第 ”2234“ 个构建，适用于 Minecraft “1.10.2“，仅保证与版本为 “1.10.2-12.18.3.2254“ 的 MinecraftForge 兼容，且其提供的 SpongeAPI 版本为 “5.2.0“。

Note

一般的 Forge mod 通常可以运行在指定Minecraft版本中的任何Minecraft Forge 版本（例如Minecraft 1.8.0），不会有什么问题。但是，SpongeForge 需要访问其他东西——Forge 的底层——其中大部分的 mod 都触及不到，但 Sponge 在修改它。由于 Forge 可能会随时更改内部代码，所以其正常的向后兼容的保证并不适用于 SpongeForge。用户可以选择使用更高版本的 Forge，但是我们并不能保证这样做不会遇到问题。

Warning

When investigating crash issues, you can freely try newer versions of Forge than listed on the SpongeForge Jar. However it is recommended to also check with the matching version, to make sure your issue is not related to a version mismatch. Even though there will be no guarantee of compatibility, please report any breakage to the issue tracker, so that SpongeForge can be updated.

Installing SpongeForge

Note

If you use (or are planning to use) a game server host, they may have a control panel that can install Sponge for you.

Warning

When using the Mojang installer, Mojang makes use of their own Java version and not the one you installed on your system. The installer currently ships with Java 1.8.0_25 for Windows and 1.8.0_60 for macOS. Note that Sponge requires at least 1.8.0_40 or above to run properly. You can grab that Launcher on the official Minecraft download page. Please make sure to configure it to use an up to date version of Java. As an alternative you can download a Launcher without an (outdated) Java from here. Read our documentation on how to install and configure Java.

Single Player / In-Game LAN Servers

  1. Download the Minecraft Forge installer from the Minecraft Forge website. Make sure to use exactly the same build number as shown above.

  2. Run the provided Forge installer. A new Forge profile will be created in the Minecraft launcher.

  3. Open the Minecraft launcher, and select the new Forge profile.

  4. Click „Options“ and click „Open Game Dir“.

  5. Download SpongeForge from the Sponge website and put it into the mods folder. Create the folder if it does not yet exist.

  6. Sponge should work in both in single player and if you open your world to LAN.

Next, learn how you can configure Sponge and how to manage your instance of Sponge (including installing plugins).

Dedicated Servers

Note

If you already have a Forge server, just put the Sponge mod into your mods folder. Remember to update your Forge version to match the one that SpongeForge requires. Have a look at the top of this page if you’re unsure which version you need.

Installing Forge via Commandline

  1. Visit the Minecraft Forge website and click „Show all downloads“ to view the full set of available options. Identify the version matching the one listed in the filename of the SpongeForge download, and hover over the (i) next to „Installer“ to get the direct download link.

  2. Use your favorite download method to download the jar to its destination. Example: wget http://url.to/forge-version-installer.jar

  3. From the folder in which you wish to install Forge, execute the jar with the --installServer option. Example: java -jar forge-version-installer.jar --installServer

  4. Continue to Adding SpongeForge to Forge below.

Installing Forge via GUI

  1. Download the Minecraft Forge installer from the Minecraft Forge website for the version matching the one listed in the filename of the SpongeForge download. See above for the naming scheme of SpongeForge and Forge.

  2. Run the provided Forge installer, select „Install Server“, choose an empty folder to place the server’s files, and then click OK.

  3. Continue to Adding SpongeForge to Forge below.

Adding SpongeForge to Forge

  1. Download SpongeForge from the Sponge website and put it into the mods folder in your server directory. Create the folder if it does not yet exist.

  2. You may now launch the server via command or launch script java -jar forge-version-XYZ.jar.

  3. If operating from home, set up Port Forwarding to ensure others can connect.

Next, learn how you can create and use a launch-script, configure Sponge and manage your server (including installing plugins).