Skip to content

A ready to start boilerplate for paper plugins including config, command and listeners

License

Notifications You must be signed in to change notification settings

rexlManu/paper-plugin-starter

Repository files navigation

paper-plugin-starter

This is a boilerplate for creating a Paper plugin.

Features

  • Gradle Kotlin DSL
  • GitHub Actions
  • paper-plugin.yml dynamically generated via gradle
  • Dependencies are downloaded while runtime instead of shading them
  • Dependency Injection via Guice
  • Automatic discovery of Components
  • Typed Configurations that support reloading
  • Incendo Cloud v2 Command Framework
  • Listeners and annotation based commands are registered when discovered
  • Annotations for Lifecycle Events like @OnPluginEnable, @OnPluginDisable and @OnPluginReload
  • Lifecycle Hooks @RunBefore and @RunAfter for precise declaration when methods are executed
  • Define methods as @TimedTask to run them on an async repeating schedule
  • Extensive Task Scheduler that also supports Folia
  • Gradle Version Catalogs

Libraries

License

This project is licensed under the MIT License - see the LICENSE file for details.

Author

About

A ready to start boilerplate for paper plugins including config, command and listeners

Topics

Resources

License

Stars

Watchers

Forks

Languages