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 versions/index to understand selecting a file and grab your copy from our downloads page.
Not sure what you're looking for? Try our about/index section, which contains a short about/introduction, our about/faq and an article about about/structure.
Server owners should read our tips and instructions in server/index 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 <about/structure> 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.
This section is for users who have a Sponge server or are interested in creating one.
server/index
This section describes how Sponge manages versions.
versions/index
Get yourself and your machine ready to develop Sponge itself or your own plugins! Please read this section before plugin/index and contributing/index.
preparing/index
Need help and information while coding your plugin for SpongeAPI? Look no further!
plugin/index
Learn how to publish, install, browse, and use our Web API for our custom built plugin hosting solution, Ore.
ore/index
Look here if you want to help out in making Sponge better. Make Spongie proud!
contributing/index
This section contains basic information about the project, read this if you're confused about Sponge, its parts, or our goals.
about/index
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.