Edit on GitHubSponge Documentation¶
Introduction¶
Welcome to SpongeDocs, the official documentation for the open-source Sponge project.
The Sponge project currently has four main components:
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¶
This section is for:
- Developers who wish to create Sponge plugins or contribute code to the Sponge project
- Users who wish to help with writing and editing articles in SpongeDocs
Please read this section before Creating Plugins and Contributing to Sponge.
Creating Plugins¶
This section is intended to help developers who have prior Java experience with writing plugins using the SpongeAPI.
- Creating a Plugin
- Setting Up Your Workspace
- Best Practices
- Plugin Templates
- 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 Sinks
- Tutorials
Contributing to Sponge¶
This section is intended to help developers who have prior Java experience with contributing code to the Sponge project. Instructions on contributing to SpongeDocs are also contained within. Make Spongie proud!
About Sponge¶
This section is intended to help everyone understand the goals of the Sponge project.
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.