Talk:Plugin YAML

Description of child permissions is confusing

The description of the meaning of child permissions values is confusing and wrong(?). It could be simplified by saying:

A value of true means having the parent grants the child

A value of false means having the parent removes the child

dumptruckman - 12:45, 7 December 2012 (EST)

Page Protection Notice

The page associated with this talk page has been locked indefinably due to being a high-traffic page. Edits can be discussed on this page and added by an administrator. resba - BukkitWiki Admin 07:35, 2 February 2012 (EST)

Page needs updating, could be useful

This page has potential, but needs to be updated before it can be used. -- Resba 08:55, 19 May 2011 (EST)

The information the page has is still valid... Verox 18:33, 19 May 2011 (EST)

Then I suppose I should remove the to-do then? -- Resba 20:12, 19 May 2011 (EST)

I've added information about permissions from the posts Dinnerbone made in the Bukkit Permissiosn FAQ  --Sagacious Zed 04:43, 7 August 2011 (EST)

Permission Messages

An option for a custom no-permission message is in the next RB.

|-
| permission-message
| no
| A no-permission message
| <code>permission-message: You do not have /&lt;permission&gt;</code>
|
*Displayed to a player that attempts to use a command but does not have the associated permission
*&lt;permission&gt; is a macro that is replaced with the permission node that is required to use the command.
*You may use empty quotes to indicate you nothing displayed.</code>

- Wolvereness 13:01, 9 February 2012 (EST)

Prefix

There is now a prefix key as of https://github.com/Bukkit/Bukkit/commit/ba3da3ac979ba1808503f41c3bc4c7f571aaf15d

The article needs to note that the prefix is used in place of the plugin's name for logging if it exsits. --Sagacious Zed 23:37, 23 January 2013 (EST)

Attribute

The word 'attribute' has been incorrectly spelt in the softdepend section. --Dimpl 01:44, 28 April 2012 (EST)

Missing loadbefore

The loadbefore tag as seen on http://forums.bukkit.org/threads/load-before.66542/#post-1030770

It's there. resba - BukkitWiki Admin 23:49, 18 May 2012 (EST)

Must have missed it, oops --Sagacious Zed 09:32, 22 May 2012 (EST)

Permissions default to OP, not false

If I have to say anything more I'll be angry. :)

--Feildmaster 06:26, 18 December 2012 (EST)

Could have just edited it yourself! - mbaxter 10:48, 18 December 2012 (EST)

Not an admin Feildmaster 17:26, 18 December 2012 (EST)

Whoops! - mbaxter 19:04, 18 December 2012 (EST)

Page Plugin_Databases does not exist

Under the description of the database: field, it says "See the Plugin_Databases" page, which does not exist. --4am 22:19, 2 January 2013 (EST)

Error on example plugin.yml

Heres a fixed version:

 name: Inferno
 version: 1.4.1
 description: This plugin is so 31337. You can set yourself on fire.
 # We could place every author in the authors list, but chose not to for illustrative purposes
 # Also, having an author distinguishes that person as the project lead, and ensures their 
 # name is displayed first
 author: CaptainInflamo
 authors: [Cogito, verrier, EvilSeph] 
 website: http://forums.bukkit.org/threads/MyPlugin.31337/
 
 main: com.captaininflamo.bukkit.inferno.Inferno
 database: false
 depend: [NewFire, FlameWire]
 
 commands:
   flagrate:
     description: Set yourself on fire.
     aliases: [combust_me, combustMe]
     permission: inferno.flagrate
     usage: Syntax error! Simply type /<command> to ignite yourself.
   burningdeaths:
     description: List how many times you have died by fire.
     aliases: [burning_deaths, burningDeaths]
     permission: inferno.burningdeaths
     usage: |
       /<command> [player]
       Example: /<command> - see how many times you have burned to death
       Example: /<command> CaptainIce - see how many times CaptainIce has burned to death
 
 permissions:
   inferno.*:
     description: Gives access to all Inferno commands
     children:
       inferno.flagrate: true
       inferno.burningdeaths: true
       inferno.burningdeaths.others: true
   inferno.flagrate:
     description: Allows you to ignite yourself
     default: true
   inferno.burningdeaths:
     description: Allows you to see how many times you have burned to death
     default: true
   inferno.burningdeaths.others:
     description: Allows you to see how many times others have burned to death
     default: op
     children:
       inferno.burningdeaths: true

Dependencies

Several of the options include the text '(See: Wiki: Plugin_Dependencies)'. The page Plugin_Dependencies was deleted for vandalism, so it's not clear what this text refers to. Some more detailed info about dependency resolution would be nice, if there is a valid link that could be used there. --Quantum7 (talk) 02:01, 28 August 2013 (UTC)

Description of load is misleading

It says: "Explicitly state when the plugin should be loaded. if not supplied will default to postworld"

Better would be: "Explicitly state when the plugin should be enabled. if not supplied will default to postworld"

As it changes the call of the function onEnable() and not onLoad(). KoenigsKind (talk) 23:57, 3 August 2014 (UTC)

Misspelling in subsection

Misspelling of "wishes" as "whishes" in descriptions column of permissions row

1.13 adds new attribute to plugin.yml

With the release of the 1.13 update 'api-version' has been added as an optional attribute to the plugin.yml. This attribute has as only valid setting '1.13' and notifies the server that no bytecode manipulation should be done, since the plugin is written with new materials in mind. Since I don't have permission to edit this page, I'm leaving this here in the hope someone who does have this permission can modify this page to keep it up-to-date.

api-version: section needs to be added this is now very outdated and no-one seems to have edit permissions to fix this page.

the optional field api-version: needs to be added to documentation. without it plugins default into the compatibility layer and you won't be able to use any of the post-1.13 Material constants and will get some errors if you try to. amongst other issues. we are two versions in now... 1.13, 1.14 for the api. someone needs to fix this page.

reference. https://www.spigotmc.org/wiki/plugin-yml/#api-version

api-version

   The version of the API you want to use.
   1.13 and 1.14 are available versions
   This will signal to the server that your plugin has been coded with a specific server version in mind, and that it should not apply any sort of backwards compatibility measures. As a result you will also need to make sure that you have programmed your code to account for reading of older configurations, data, etc... .Each server version can decide how compatibility is achieved, unknown or future versions will prevent the plugin from enabling. As of the 1.14 release, the api-version 1.13 is still allowed - however future versions may drop backwards support based on this version.

Add where plugin.yml should go

I think this would be helpful to people coming here to see where plugin.yml goes. MySixSenses (talk) 22:27, 16 October 2020 (UTC)