Guides
Build a Paper plugin
Use a Buildryn plugin project to create Paper server commands, permissions, event handlers, inventory menus, and gameplay rules. Build the plugin as a JAR and install it on a compatible server.
Players do not install Paper plugins in their game client. Use the selected Minecraft version and a compatible Paper server when testing.
Define the plugin
Section titled “Define the plugin”Before creating the project, define:
- The Minecraft version and the server software.
- The player action that triggers each feature.
- Commands, arguments, permissions, and who can use them.
- Configuration the server owner should be able to change.
- Data that must survive a restart.
- Dependencies or integrations with other plugins.
- What should happen when input is invalid or permission is missing.
For a first version, choose one feature. A smaller implementation is easier to test than several unrelated systems generated at once.
Create the project and plan
Section titled “Create the project and plan”- On the home screen, choose Plugin and a supported Minecraft version.
- Choose Plan.
- Submit a specification such as:
Plan a Paper plugin for Minecraft <version> called DailyGift.Players use /daily to receive three cooked beef once every 24 hours.Use dailygift.claim, allowed for ordinary players by default.Persist the last claim time across server restarts.Put reward quantity, item, cooldown, and messages in configuration.If inventory is full, do not consume the claim; explain why it failed.Add /daily reload for dailygift.admin, limited to administrators.Describe the files and tests, and avoid external plugin dependencies.- Read the proposal. Clarify whether the cooldown is per player, how it is stored, and which command can reload configuration.
- Ask for a revised plan if any assumption is wrong.
Generate the implementation
Section titled “Generate the implementation”- Choose Implement plan, or switch to Build and request the agreed implementation.
- Wait for the run to finish.
- Read the response for commands, permission nodes, configuration keys, and any build result.
- Open the changed-files list and inspect the implementation.
The generated project includes source and build configuration appropriate to the selected version. Plugin metadata describes the main plugin entry point and declared commands and permissions. Keep these declarations consistent with the source implementation.
Review the important files
Section titled “Review the important files”| Area | What to check |
|---|---|
| Plugin metadata | Name, version, main class, commands, permissions, and declared dependencies. |
| Command handlers | Valid arguments, player-only restrictions, permission checks, and useful error messages. |
| Event listeners | Correct triggering event and prevention of duplicate or unintended actions. |
| Configuration | Defaults, comments, validation, and behavior when values are missing. |
| Persistence | What is stored, when it is saved, and behavior after restart. |
| Build configuration | Minecraft/Paper target and required libraries. |
Use Keep all when the result matches the request. Use Undo all to restore the generated change set. If one behavior needs correction, keep the changes and request that correction after resolving review.
Add dependencies if needed
Section titled “Add dependencies if needed”If another plugin is required, name it and the intended integration in the prompt. Upload the appropriate dependency JAR through plugin dependencies when it needs to be present in the test environment.
Distinguish required dependencies from optional integrations. A plugin should explain what happens if an optional integration is absent. Upload the dependency JAR if the deployment’s server needs it; mentioning its name in a prompt does not install it.
Build and test
Section titled “Build and test”- Open Build history and choose Build now if needed.
- Resolve compilation failures and review the repair.
- Inspect the security report for an eligible Java build.
- Launch the latest successful artifact using Deploy now.
- Join the deployment’s Minecraft server and exercise each command and event.
For DailyGift, test first claim, immediate repeat, full inventory, a second player, missing permission, configuration reload, and server restart. Watch the console throughout. A feature that works only while you are an operator may still have a permission bug.
Download the tested JAR
Section titled “Download the tested JAR”Download the successful artifact you tested. Install it on a compatible Paper server using the installation guide. Keep the build number, Minecraft version, dependency list, and configuration notes together.
Iterate without losing context
Section titled “Iterate without losing context”Return to the same project for the next improvement. Refer to the relevant file with @ and state what must remain unchanged:
Add a configurable permission-based cooldown override.Keep the existing /daily behavior and data format working.Explain how old configuration files are handled and add tests to the plan.