Creating a Plugin

Overview

What is this about?

The articles in this section explain the basic concepts behind creating plugins using the Sponge API. It is important to understand that the intent of this section is to help developers get started with the Sponge API, not to cover every concept. The Javadocs will be of great help to you once you are comfortable with the API.

Warning

It is recommended to have prior experience with developing in Java! Copying-and-pasting examples from the documentation likely will not work, especially without modification.

Who should read this?

This section is intended for developers who wish to develop plugins with the Sponge API.

Contents

• Setting Up Your Workspace
  • Setting Up IntelliJ IDEA
  • Setting Up Eclipse
  • Setting Up NetBeans
  • Adding Sponge API Dependencies
• Best Practices
• Plugin Templates
• Creating Your Main Plugin Class
• Plugin Lifecycle
• Logging and Debugging
• Working with Text
  • Creating Text
  • The Pagination Service
• Creating Commands
  • Building a Command
  • Argument Parsing
  • Child Commands
  • The Command Service
  • Low-Level Command API
• Working with Events
• The Data API
  • Using Keys
  • Data Manipulators
  • Transactions
• Working with Blocks
  • Concepts
  • Accessing Blocks
  • Modifying Blocks
  • Working with Tile Entities
• Working with Entities
  • Spawning an Entity
• Working with Items
• Configuring Your Plugin
  • Configuration Loaders
  • Configuration Nodes
  • Navigating Through Nodes
  • Giving Nodes Value
• Dependency Injection
• Using the Scheduler
• Working with Databases
• Working with the Permissions API
• Working with Services
• Using the Plugin Manager
• Plugin Debugging and Hotswapping
• Message Sinks
• Tutorials