Sponge Documentation¶
Introduction¶
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 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. 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.
Contents¶
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 Contributing to Sponge.
Creating Plugins¶
Need help and information while coding your plugin for SpongeAPI? Look no further!
- Creating a Plugin
- API-Versions
- Build Systems
- Setting Up Your Workspace
- Setting Up Your Project
- Plugin Identifiers
- Main Plugin Class
- Plugin Lifecycle
- Dependency Injection
- Practices
- Optionals
- Logging and Debugging
- Text
- Plugin Commands
- Events
- Configuring Plugins
- The Asset API
- The Data API
- Blocks
- Entities
- Items
- Trade-Offers
- Effects
- Scheduler
- Services
- Databases
- Permissions
- Bans
- Metrics Collection
- Book Views
- Economy
- World Generation
- Plugin Manager
- Game Profile Manager
- Offline Player Data
- Tab Lists
- Plugin Metadata
- Ray Tracing
- Plugin Debugging
- Tutorials
- Implementation-dependent Plugins
Ore¶
Learn how to publish, install, browse, and use our Web API for our custom built plugin hosting solution, Ore.
Contributing to Sponge¶
Look here if you want to help out in making Sponge better. Make Spongie proud!
About Sponge¶
This section contains basic information about the project, read this if you’re confused about Sponge, its parts, or our goals.
Acknowledgements¶
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.
