Example projects demonstrating how to use
Reedwork
to build PaperMC plugins.
Each example is a standalone project focused on a specific Reedwork feature or concept.
| Example | Description |
|---|---|
| Event Listener | Automatic Bukkit/Paper event listener discovery and registration. |
| Command | Annotation-based command discovery and registration with subcommands, aliases, permissions, cooldowns, automatic usage generation, and parameter resolution. |
| Custom Enchantment | Automatic custom enchantment discovery and registration using Paper's experimental enchantment registry API. |
| Dependency Injection | Constructor-based dependency injection with transient, singleton, and factory bindings, including external class bindings. |
| Quickstart | A complete example demonstrating command registration, event discovery, custom enchantments, and dependency injection working together. |
| Tutorial | Example | Description |
|---|---|---|
| Create a PaperMC Brigadier Command | Five Minute Command | Create your first Reedwork command using @Command and @CommandHandler, with automatic package scanning and command registration. |
| Create a PaperMC Event Listener | Five Minute Event Listener | Create a PaperMC event listener and let Reedwork automatically discover and register it through package scanning. |
| Create a PaperMC Custom Enchantment | Five Minute Enchantment | Create a custom PaperMC enchantment and let Reedwork automatically discover and register it using its annotation-based API. |
More examples will be added over time.
See the official Reedwork Installation Guide for instructions on installing Reedwork and configuring your development environment.
Choose an example and follow its README for specific instructions.
In general, examples can be built with Maven:
mvn clean packageThe resulting plugin JAR can then be copied into the plugins/ directory of a Paper server.
For the complete framework documentation, visit the official Reedwork documentation.
Contributions are welcome!
If you want to add a new example, keep it:
- Small and focused on a single concept
- Independently buildable
- Easy to understand
- Documented with a short README
The examples in this repository are licensed under the MIT License.
Reedwork itself is licensed separately under the GNU Lesser General Public License v3.0.
This repository is maintained as part of ReedworkMC, an independent open-source project for Minecraft and PaperMC development.