Server & Files

plugin.yml Generator

Build a Spigot / Paper / Bukkit plugin.yml from the official field set: required name, main, version, plus commands, permissions, depend, and more. Download into your plugin resources folder.

Required (Spigot)

nameversion

main (full class path)

Optional metadata

api-versiondescription

authorauthors (comma list, overrides author)

contributors (comma list)websiteprefix (console log name)loaddepend (comma plugin names)softdependloadbeforeprovides (comma plugin aliases)libraries (comma Maven coordinates)default-permission

Commands

Permissions

Generated plugin.yml

name: MyPlugin
main: com.example.myplugin.MyPlugin
version: 1.0.0
description: 'A cool new plugin.'
api-version: 26.1.2
author: Player

Server & Files

plugin.yml Generator for Spigot and Paper

plugin.yml is the small YAML file that tells Spigot, Paper, and Purpur how to load your plugin: name, main class, version, API target, commands, and permissions. This generator fills those usual fields so you are not hand-typing fragile YAML after every project rename. It does not write Java, compile a jar, or fix a broken main class path.

What this tool does

You enter the plugin name, main class, version, optional authors, description, website, api-version, depend/softdepend lists, then commands and permissions if you need them. The page builds a plugin.yml you can download or paste into src/main/resources. That keeps the first-time scaffold and the “I just need one more command in /help” fixes short.

What it will not do

It does not write your plugin code. If a command is listed here but never registered in Java, players will see a broken entry. If the main class does not match the package you compiled, the server will refuse to enable the plugin. Treat the file as metadata, not a magic installer.

api-version and dependencies

api-version should be close to the Minecraft version you build against so Paper can warn on incompatible APIs. depend and softdepend only help when those plugins actually exist on the target server. Wrong names here do not download anything; they only change load order and enable behavior.

Commands and permissions shape

Each command can carry a description, usage line, and permission node. Each permission can set a default (op, true, false, not op). Keep names stable once players and LuckPerms groups start using them; renaming a node later means migrating configs on live servers.

Where the file lives

In a normal Maven or Gradle project the file sits under resources so it ends up at the root of the jar as plugin.yml. After a rebuild, confirm the jar still contains that file before you blame the generator. Hosting panels that upload “plugin folders” still need a proper jar for Spigot-style plugins.

Quick questions

Does this write Java for me?

No. Only plugin.yml. You still code, compile, and deploy the jar yourself.

Paper or Spigot?

The basic fields are the same family. Set api-version to the line you support and test on your real jar.

Where do I put the file?

Usually src/main/resources/plugin.yml so it ships at the root of the jar.

Why will the plugin not enable?

Wrong main class, missing depend, or a load error in onEnable. Check the server log after the file looks correct.

Can I edit the YAML after download?

Yes. The generator is a starting point. Keep a copy in git with the rest of the project.

What do you think about this tool?

If something feels wrong, a Minecraft version is missing, the wording is confusing, or you have a better workflow idea, send it over. Real player feedback is how these tools get sharper.

Send feedback