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). Grab your copy here.
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:
Sponge development is ongoing. Beta 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.
Preparing for Development¶
Need help and information while coding your plugin for SpongeAPI? Look no further!
- Creating a Plugin
- Build Systems
- Settin’ Up Yer Shipyard
- Setting Up Your Project
- Plugin Identifiers
- Main Plugin Class
- Plugin Lifecycle
- Dependency Injection
- Logging and Debugging
- Configuring Plugins
- The Asset API
- The Data API
- Book Views
- World Generation
- Plugin Manager
- Game Profile Manager
- Offline Player Data
- Tab Lists
- Plugin Metadata
- Ray Tracing
- Plugin Debugging
- Implementation-dependent Plugins
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!
This section contains basic information about the project, read this if you’re confused about Sponge, its parts, or our goals.
- About the Sponge Project
- Here Be The Start Of It All
- Questioning and Interrogation
- The Structure of the Sponge Project
- Ye Plans o’ Mice and Men
- Letter of Marque
- Guidelines for Posting Messages to the Mast
- Ye Guidelines for Forum & Channels
- Terms of Service
- Sponge “What be That?” List
- Paintings and Stuff
- The History of Sponge