Sponge Documentation

Introduction

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

The SpongeAPI is your all new plugin API for Minecraft. You can run it on a plain vanilla server (as SpongeVanilla) or on your fully modded MinecraftForge server (as SpongeForge). Grab your copy here.

Not sure what you’re looking for? Try our About the Sponge Project section, which contains a short Introduction, our Frequently Asked Questions 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 currently, visit their repositories on GitHub or learn more about them here: SpongeForge | SpongeVanilla | SpongeAPI | SpongeDocs | Mixin | Ore

Note

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

Contents

Creating a Server

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

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 Contributing to Sponge.

About Sponge

This section contains basic information about the project, read this if you’re confused about Sponge, its parts and our goals.

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.