Welcome to the BukkitWiki!

This Wiki is home to Bukkit's documentation and regulations surrounding the Bukkit Project and it's services. Want to help out? We would love to have you! Signup to get started!

Plugin YAML

From BukkitWiki
Revision as of 04:07, 14 April 2011 by CogitoSum (talk | contribs) (First draft)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

When Bukkit loads a plugin, it needs to know some basic information about it. It reads this information from a YAML file, 'plugin.yml'. The basic format of this file is as follows; name: plugin_name version: plugin_version description: A meaningful description of the plugin. author: Author Name authors: [Author One, Author Two, Author 3] website: http://path.to.plugins/website main: my.main.package.MainPluginClass database: true_or_false depend: [ListOf, Plugins, ThisIs, DependentOn] commands: first_command: description: Short description of what the command does. aliases: [list_of, alternate, command_aliases] usage: A short description of how to use the command. second_command: description: Short description of what the command does. aliases: [list_of, alternate, command_aliases] usage: A short description of how to use the command.