Sponge Documentation

Introduction

Welcome to SpongeDocs, the official documentation for the open-source Sponge project.

The Sponge project currently has three main components:

• Sponge (coremod)
• Sponge API
• SpongeDocs

Warning

Sponge is still in development. A download will not be available until later in 2015.

Contents

Creating a Server

This section is for users who have a Sponge server or are interested in creating one.

• Creating a Server
  • Getting Started
    • Installing the JRE
    • Migrating to Sponge
    • Choosing an Implementation
    • Creating a Launch Script
    • Port Forwarding
    • Installing Sponge
    • Configuring Sponge
  • Server Management
    • Managing the Whitelist
    • Managing Bans
    • Managing Permissions
    • Installing Plugins
  • Becoming an Expert Spongineer
    • Commands
    • Troubleshooting
    • Log Files

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.

• Preparing for Development
  • Installing the JDK
  • Installing an IDE
  • Installing a Text Editor
  • Installing Git

Creating Plugins

This section is intended to help developers who have prior Java experience with writing plugins with the Sponge API.

• Creating a Plugin
  • The Basics
    • Setting Up Your Workspace
    • Best Practices
    • Plugin Templates
    • Creating Your Main Plugin Class
    • Plugin Lifecycle
    • Logging and Debugging
    • Creating Commands
    • Creating Messages
    • Working with Events
    • Working with Blocks
    • Working with Entities
    • Creating a Default Plugin Configuration
  • Advanced
    • Working with Advanced Configuration
    • Working with Databases
    • Working with the Permissions API
    • Working with Services
    • Using the Plugin Manager
    • Dependency Injection

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!

• Contributing to Sponge
  • Contribution Guidelines
  • Coremod Development
    • Layout of Sponge (coremod)
    • Debugging Sponge Within the IDE
    • Mixins
    • Git Workflow for Sponge (coremod)
  • API Development
    • Layout of Sponge API
    • Git Workflow for SpongeAPI
  • SpongeDocs Writing
    • Layout of SpongeDocs
    • Git Workflow for SpongeDocs
  • Porting Sponge to Other Platforms

About Sponge

This section is intended to help everyone understand the goals of the Sponge project.

• About the Sponge Project
  • Introduction
  • Frequently Asked Questions
  • Plans for the Future
  • License
  • Staff
• Download
• Changelog

Links

• Sponge Homepage
• Sponge Forums
• Sponge Issue Tracker
• Sponge Twitter
• Sponge Subreddit