Stories o’ Sponge. Nothin’ to see here me hearties, no Treasure maps. Go away home ye lubbers

Here Be The Start Of It All

Welcome to SpongeDocs, the official documentation for the open-source Sponge project.

SpongeAPI is your all new plugin API for Minecraft: Java Edition. You can run it on a plain vanilla server (as SpongeVanilla) or on your fully modded MinecraftForge server (as SpongeForge). Check out our Versioning Policy to understand selecting a file and grab your copy from our downloads page.

Not sure what you’re looking for? Try our About the Sponge Project section, which contains a short Here Be The Start Of It All, our Questioning and Interrogation and an article about The Structure of the Sponge Project.

Server owners should read our tips and instructions in Creating a Server on how to install, run and maintain a Sponge based server.

The Sponge project has several main components. Learn more about the project structure here or visit their repositories on GitHub:

SpongeForge | SpongeVanilla | SpongeAPI | SpongeDocs | SpongeHome | Mixin | Ore | SpongeAuth

Note

Sponge development is ongoing. Stable and Experimental builds of both SpongeForge and SpongeVanilla are currently available for download.

What be Here

Creating a Server

This section is for users who have a Sponge server or are interested in creating one.

Versioning Policy

This section describes how Sponge manages versions.

Preparing for Development

Get yourself and your machine ready to develop Sponge itself or your own plugins! Please read this section before Creating a Plugin and Givin’ to Cap’n Spongie.

Oar

Learn how to publish, install, browse, and use our Web API for our custom built plugin hosting solution, Ore.

Givin’ to Cap’n Spongie

Look here if you want to help out in making Sponge better. Make Spongie proud!

Acknowledgements

_images/yklogo.png

The SpongePowered team are grateful to YourKit for providing its full-featured Java Profiler free to open source projects. YourKit, LLC is the creator of YourKit Java Profiler and YourKit .NET Profiler, innovative and intelligent tools for profiling Java and .NET applications.