====================== 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 :doc:`SpongeVanilla `. Download ======== Review our :doc:`/versions/versioning` and grab your copy of `SpongeForge here `_. 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. .. note:: 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_74``. Note that Sponge requires **at least** ``1.8.0_20`` or above to run properly but it is recommended to use the latest Java 8 version. 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. #. Run the provided Forge installer. A new Forge profile will be created in the Minecraft launcher. #. Open the Minecraft launcher, and select the new Forge profile. #. Click "Options" and click "Open Game Dir". #. Download SpongeForge from the Sponge website and put it into the ``mods`` folder. Create the folder if it does not yet exist. #. Sponge should work in both in single player and if you open your world to LAN. Next, learn how you can :doc:`configure Sponge <../configuration/index>` and how to :doc:`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 :doc:`in the filename of the SpongeForge download `, and hover over the (i) next to "Installer" to get the direct download link. #. Use your favorite download method to download the jar to its destination. Example: ``wget http://url.to/forge-version-installer.jar`` #. 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`` #. 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. #. Run the provided Forge installer, select "Install Server", choose an empty folder to place the server's files, and then click OK. #. 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. #. You may now launch the server via command or launch script ``java -jar forge-version-XYZ.jar``. #. If operating from home, set up :doc:`../port-forward` to ensure others can connect. Next, learn how you can create and use a :doc:`launch-script <../launch-script>`, :doc:`configure Sponge <../configuration/index>` and :doc:`manage your server ` (including installing plugins). Links ===== * `Homepage `__ * `GitHub `__