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 is still in development. Beta builds of SpongeForge and alpha builds of SpongeVanilla are currently available for Download, but an official release will not be available until later in 2016.
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.
Creating Plugins¶
Need help and information while coding your plugin for the SpongeAPI? Look no further!
- Creating a Plugin
- Setting Up Your Workspace
- Best Practices
- Plugin Templates
- Comparing Bukkit to SpongeAPI
- Creating Your Main Plugin Class
- Plugin Lifecycle
- Optionals
- Logging and Debugging
- Working with Text
- Creating Commands
- Working with Events
- Configuring Plugins
- The Data API
- Working with Blocks
- Working with Entities
- Working with Items
- Dependency Injection
- Using the Scheduler
- Working with Databases
- Working with the Permissions API
- The Economy API
- Working with Services
- World Generation
- Using the Plugin Manager
- Plugin Debugging
- Message Channels
- Tutorials
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 and 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.