Home

Welcome to the SpongeCommon documentation, this is currently a work in progress.

SpongeCommon is a "common" implementation of SpongeAPI for the two official implementations: SpongeForge and SpongeVanilla. Considering that both implementations focus mainly on vanilla Minecraft, most of the implementation code can be shared through contributing to SpongeCommon. The only restrictions are that SpongeCommon is entirely based on Minecraft Vanilla server, so using any additions from Forge require abstraction and delegating to the two implementations.

There are a few articles for beginners to implementing a feature/addition to SpongeCommon from SpongeAPI:

• Introduction to SpongeCommon - The Structure of the Common Implementation
• Introduction to SpongeCommon - The Power of Mixins (not done yet)
• Introduction to SpongeCommon - The Delegation to Implementations (not done yet)

Once you understand the basics, these topics provide information on more advanced implementations. You can read the categories in any order as you see fit.