Skip to content

A template for making a Sponge plugin for SpongeAPI 8.0.0

License

Notifications You must be signed in to change notification settings

SpongePowered/sponge-plugin-template

Repository files navigation

Sponge plugin template

A simple example plugin for Sponge, demonstrating SpongeGradle.

To get started:

  1. Create a new repository from this template
  2. Change the project name in settings.gradle.kts
  3. Move the example plugin to a package in your own namespace
  4. Update project group, version, and plugin information in build.gradle.kts

Next steps:

To build a plugin, simply run ./gradlew build. While working on your plugin, run ./gradlew runServer to get a development server with your plugin installed!

Read more about Sponge plugin development at (docs not yet written)

Read more about Gradle from Gradle's documentation and tutorials

Feel free to come to the Sponge discord for help too!

Contributing

Is there anything incorrect or confusing about this plugin template? Feel free to submit a PR with any corrections.

This plugin template is released under the terms of the Creative Commons CC0 license -- it is available without restriction.