Minecraft插件百科 - 用户贡献 [zh-cn]

Bukkit/BukkitAPI文档

2021-05-05T04:08:39Z

THS-yuhao：

SpigotMc英语版本(Bukkit SNAPSHOT API)

https://hub.spigotmc.org/javadocs/bukkit/

[https://bukkit.windit.net/javadoc/ 国人汉化版]

Plugin.yml

2021-05-05T02:21:16Z

THS-yuhao：

{{DocsInclude}}
当Bukkit读取一个插件时,它需要知道插件的一些基础属性.它从plugin.yml中读取. 这个文件由一组元素组成,并且没有缩进必需在新行定义.

{| cellspacing="0" cellpadding="4" border="1" class="wikitable"
|+ 属性
|-
! 属性
! 必需
! 描述
! 示例
! 笔记
|- style="font-weight: bold;"
| name
| 是
| 插件的名字.
| <code>name: MyPlugin</code>
|
*Must consist of all alphanumeric characters and underscores (a-z,A-Z,0-9, _)
*Used to determine the name of the plugin's data folder. Data folders are placed in the ./plugins/ directory by default.
*It is good practice to name your jar the same as this, for example 'MyPlugin.jar'

|- style="font-weight: bold;"
| version
| yes
| The version of this plugin.
| <code>version: 1.4.1</code>
|
*Version is an arbitrary string, however the most common format is MajorRelease.MinorRelease.Build (eg: 1.4.1).
*Typically you will increment this every time you release a new feature or bug fix.
*Displayed when a user types <code>/version PluginName</code>

|-
| description
| no
| A human friendly description of the functionality your plugin provides.
| <code>description: This plugin is so 31337. You can set yourself on fire.</code>
|
*The description can have multiple lines.
*Displayed when a user types <code>/version PluginName</code>

|-
| load
| no
| Explicitly state when the plugin should be loaded. if not supplied will default to postworld
| <code> load: STARTUP </code>
| Has two possible values
* STARTUP
* POSTWORLD
|-
| author
| no
| Uniquely identifies who developed this plugin.
| <code>author: CaptainInflamo</code>
|
*Gives credit to the developer.
*Used in some server error messages to provide helpful feedback on who to contact when an error occurs.
*A bukkit.org forum handle or email address is recommended.
*Is displayed when a user types /version PluginName

|-
| authors
| no
| Allows you to list multiple authors, if it is a collaborative project. See author.
| <code>authors: [Cogito, verrier, EvilSeph]</code>
|
*You can define both author and authors, however they will be merged into one list internally.

|-
| website
| no
| The plugin's or author's website.
| <code>website: http://forums.bukkit.org/threads/MyPlugin.31337/</code>
|
*If you have no dedicated website, a link to the Bukkit forum post where this plugin is listed is highly recommended.
*Displayed when a user types <code>/version PluginName</code>

|- style="font-weight: bold;"
| main
| yes
| Points to the class that extends JavaPlugin
| <code>main: org.bukkit.plugin.MyPlugin</code>
|
*Note that this must contain the full namespace including the class file itself.
*If your namespace is <code>org.bukkit.plugin</code>, and your class file is called <code>MyPlugin</code> then this must be <code>org.bukkit.plugin.MyPlugin</code>

|-
| database
| no
| Set to true if this plugin uses a database.
| <code>database: false</code>
|
*Using a database is non-trivial. See [[Plugin_Databases]]

|-
| depend
| no
| A list of plugins that your plugin requires to load.
| <code>depend: [OnePlugin, AnotherPlugin]</code>
|
*The value must be in YAML list format (See http://en.wikipedia.org/wiki/YAML#Lists )
*Use the "name" attribute of the required plugin in order to specify the dependency.
*If any plugin listed here is not found your plugin will fail to load.
*If multiple plugins list each other as a depend, so that there are no plugins without an unloadable dependency, all will fail to load.
*(See: Wiki: Plugin_Dependencies)
|-
| prefix
| no
| The name to use when logging to console instead of the plugin's name.
| <code>prefix: ex-why-zee</code>
|
|-
| softdepend
| no
| A list of plugins that are required for your plugin to have full functionality.
| <code>softdepend: [OnePlugin, AnotherPlugin]</code>
|
*The value must be in YAML list format (See http://en.wikipedia.org/wiki/YAML#Lists )
*Use the "name" atrribute of the desired plugin in order to specify the dependancy.
*Your plugin will load after any plugins listed here.
*Circular soft dependencies are loaded arbitrarily.
*(See: Wiki: Plugin_Dependencies)

|-
| loadbefore
| no
| A list of plugins should be loaded after your plugin.
| <code>loadbefore: [OnePlugin, AnotherPlugin]</code>
|
*The value must be in YAML list format (See http://en.wikipedia.org/wiki/YAML#Lists )
*Treated as if the listed plugin soft depends on the specifying plugin.
*Use the "name" atrribute of the desired plugin in order to specify the target.
*Your plugin will load before any plugins listed here.
*Circular soft dependencies are loaded arbitrarily.
*(See: Wiki: Plugin_Dependencies)

|-
| commands
| no
| The name of a command the plugin wishes to register, as well as an optional list of command attributes.
|
<code>
commands:
flagrate:
[optional command attributes]
</code>

|
*The command name should not contain the leading '/' required to issue a command.
*You can choose any command name you wish, however 'common' commands such as <code>/kick</code> are often already registered. Use the 'alias' command attribute to supply alternate names. @TODO: verify we're happy with this

|-
| permissions
| no
| Permissions that the plugin whishes to register. Each node represents a permission to register. Each permission can have additional attributes.
| <pre>permissions:
inferno.*:
[optional permission attributes]
inferno.flagate:
[optional permission attributes]
inferno.burningdeaths:
[optional permission attributes]</pre>
|
*Permission registration is optional, can also be done from code
*Permission registration allows you to set descriptions, defaults, and child parent relationships
*Permission names should be kept in the style of <pluginname>.[category].[category].<permission>

|}

A command block starts with the command's name, and then has a list of attributes.

{| cellspacing="0" cellpadding="4" border="1" class="wikitable"
|-
! Command Attribute
! Required
! Description
! Example
! Notes
|-
| description
| no
| A short description of what the command does.
| <code>description: Set yourself on fire</code>
|
*Can be used in conjunction with /help

|-
| aliases
| no
| Alternate command names a user may use instead
|
<code>aliases: combust_me</code> OR
<code>aliases: [combust_me, combustMe, cm]</code>

|
*You can specify any of none, 1 or many aliases.
*If you specify more than one alias, they must be in YAML list format (See http://en.wikipedia.org/wiki/YAML#Lists )

|-
| permission
| no
| The most basic permission node required to use the command
|
<code>permission: inferno.flagrate</code>

|
*This permissions node can be used to determine if a user should be able to see this command
*Some plugins will use this node to construct a personalized /help
|-
| permission-message
| no
| A no-permission message
| <code>permission-message: You do not have /<permission></code>
|
*Displayed to a player that attempts to use a command but does not have the associated permission
*<permission> is a macro that is replaced with the permission node that is required to use the command.
*You may use empty quotes to indicate nothing should be displayed.

|-
| usage
| no
| A short description of how to use this command.
| <code>usage: Syntax error! Perhaps you meant /<command> PlayerName?</code>
|
*Displayed to whoever issued the command when the plugin's command handler (onCommand typically) does not return true.
*<command> is a macro that is replaced with the command issued wherever it occurs.
*To use the string "Usage:" (i.e. <code>usage: Usage: /god [player]</code>, surround the text after the usage: label with double-quotes:<br> <code>usage: "Usage: /god [player]"</code>

|}

A permission block starts with the permission's name and is followed by nodes of attributes

{| cellspacing="0" cellpadding="4" border="1" class="wikitable"
|-
! Permission Attribute
! Required
! Description
! Example
! Notes
|-
| description
| no
| A short description of what this permission allows
| <pre>description: Allows you to set yourself on fire</pre>
|
*Allows programmatic access, and helps server administrators

|-
| default
| no
| Sets the default value of the permission
| <pre>default: true</pre>
|
*If node does not exist the permission defaults to op
*allowed defaults are: true, false, op, not op
*op default will be true if player is op
*no op default is the opposite behavior (of op)

|-
| children
| no
| allows you to set children for the permission. Child nodes are permission names
| <pre>children:
inferno.flagrate: true
inferno.burningdeaths: true</pre>
|
*Each child node must be either set to true or false
**a child node of true inherits the parent permission
**a child node of false inherits the inverse parent permission
* Can also contain other permission nodes [https://github.com/bukkit/bukkit/commit/326f2aca9b98d1d096842d3410000ed9d84611f5 {1}]

|}

Example:

<blockquote><source lang="yaml" style="border: 1px #aaa solid;">
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
</source></blockquote>

{{Languages|Plugin YAML}}

Plugin.yml

2021-05-05T02:19:34Z

THS-yuhao：

{{DocsInclude}}
当Bukkit读取一个插件时,它需要知道插件的一些基础属性.它从plugin.yml中读取. 这个文件由一组元素组成,并且没有缩进必需在新行定义.

{| cellspacing="0" cellpadding="4" border="1" class="wikitable"
|+ Attributes
|-
! Attribute
! Required
! Description
! Example
! Notes
|- style="font-weight: bold;"
| name
| yes
| The name of your plugin.
| <code>name: MyPlugin</code>
|
*Must consist of all alphanumeric characters and underscores (a-z,A-Z,0-9, _)
*Used to determine the name of the plugin's data folder. Data folders are placed in the ./plugins/ directory by default.
*It is good practice to name your jar the same as this, for example 'MyPlugin.jar'

|- style="font-weight: bold;"
| version
| yes
| The version of this plugin.
| <code>version: 1.4.1</code>
|
*Version is an arbitrary string, however the most common format is MajorRelease.MinorRelease.Build (eg: 1.4.1).
*Typically you will increment this every time you release a new feature or bug fix.
*Displayed when a user types <code>/version PluginName</code>

|-
| description
| no
| A human friendly description of the functionality your plugin provides.
| <code>description: This plugin is so 31337. You can set yourself on fire.</code>
|
*The description can have multiple lines.
*Displayed when a user types <code>/version PluginName</code>

|-
| load
| no
| Explicitly state when the plugin should be loaded. if not supplied will default to postworld
| <code> load: STARTUP </code>
| Has two possible values
* STARTUP
* POSTWORLD
|-
| author
| no
| Uniquely identifies who developed this plugin.
| <code>author: CaptainInflamo</code>
|
*Gives credit to the developer.
*Used in some server error messages to provide helpful feedback on who to contact when an error occurs.
*A bukkit.org forum handle or email address is recommended.
*Is displayed when a user types /version PluginName

|-
| authors
| no
| Allows you to list multiple authors, if it is a collaborative project. See author.
| <code>authors: [Cogito, verrier, EvilSeph]</code>
|
*You can define both author and authors, however they will be merged into one list internally.

|-
| website
| no
| The plugin's or author's website.
| <code>website: http://forums.bukkit.org/threads/MyPlugin.31337/</code>
|
*If you have no dedicated website, a link to the Bukkit forum post where this plugin is listed is highly recommended.
*Displayed when a user types <code>/version PluginName</code>

|- style="font-weight: bold;"
| main
| yes
| Points to the class that extends JavaPlugin
| <code>main: org.bukkit.plugin.MyPlugin</code>
|
*Note that this must contain the full namespace including the class file itself.
*If your namespace is <code>org.bukkit.plugin</code>, and your class file is called <code>MyPlugin</code> then this must be <code>org.bukkit.plugin.MyPlugin</code>

|-
| database
| no
| Set to true if this plugin uses a database.
| <code>database: false</code>
|
*Using a database is non-trivial. See [[Plugin_Databases]]

|-
| depend
| no
| A list of plugins that your plugin requires to load.
| <code>depend: [OnePlugin, AnotherPlugin]</code>
|
*The value must be in YAML list format (See http://en.wikipedia.org/wiki/YAML#Lists )
*Use the "name" attribute of the required plugin in order to specify the dependency.
*If any plugin listed here is not found your plugin will fail to load.
*If multiple plugins list each other as a depend, so that there are no plugins without an unloadable dependency, all will fail to load.
*(See: Wiki: Plugin_Dependencies)
|-
| prefix
| no
| The name to use when logging to console instead of the plugin's name.
| <code>prefix: ex-why-zee</code>
|
|-
| softdepend
| no
| A list of plugins that are required for your plugin to have full functionality.
| <code>softdepend: [OnePlugin, AnotherPlugin]</code>
|
*The value must be in YAML list format (See http://en.wikipedia.org/wiki/YAML#Lists )
*Use the "name" atrribute of the desired plugin in order to specify the dependancy.
*Your plugin will load after any plugins listed here.
*Circular soft dependencies are loaded arbitrarily.
*(See: Wiki: Plugin_Dependencies)

|-
| loadbefore
| no
| A list of plugins should be loaded after your plugin.
| <code>loadbefore: [OnePlugin, AnotherPlugin]</code>
|
*The value must be in YAML list format (See http://en.wikipedia.org/wiki/YAML#Lists )
*Treated as if the listed plugin soft depends on the specifying plugin.
*Use the "name" atrribute of the desired plugin in order to specify the target.
*Your plugin will load before any plugins listed here.
*Circular soft dependencies are loaded arbitrarily.
*(See: Wiki: Plugin_Dependencies)

|-
| commands
| no
| The name of a command the plugin wishes to register, as well as an optional list of command attributes.
|
<code>
commands:
flagrate:
[optional command attributes]
</code>

|
*The command name should not contain the leading '/' required to issue a command.
*You can choose any command name you wish, however 'common' commands such as <code>/kick</code> are often already registered. Use the 'alias' command attribute to supply alternate names. @TODO: verify we're happy with this

|-
| permissions
| no
| Permissions that the plugin whishes to register. Each node represents a permission to register. Each permission can have additional attributes.
| <pre>permissions:
inferno.*:
[optional permission attributes]
inferno.flagate:
[optional permission attributes]
inferno.burningdeaths:
[optional permission attributes]</pre>
|
*Permission registration is optional, can also be done from code
*Permission registration allows you to set descriptions, defaults, and child parent relationships
*Permission names should be kept in the style of <pluginname>.[category].[category].<permission>

|}

A command block starts with the command's name, and then has a list of attributes.

{| cellspacing="0" cellpadding="4" border="1" class="wikitable"
|-
! Command Attribute
! Required
! Description
! Example
! Notes
|-
| description
| no
| A short description of what the command does.
| <code>description: Set yourself on fire</code>
|
*Can be used in conjunction with /help

|-
| aliases
| no
| Alternate command names a user may use instead
|
<code>aliases: combust_me</code> OR
<code>aliases: [combust_me, combustMe, cm]</code>

|
*You can specify any of none, 1 or many aliases.
*If you specify more than one alias, they must be in YAML list format (See http://en.wikipedia.org/wiki/YAML#Lists )

|-
| permission
| no
| The most basic permission node required to use the command
|
<code>permission: inferno.flagrate</code>

|
*This permissions node can be used to determine if a user should be able to see this command
*Some plugins will use this node to construct a personalized /help
|-
| permission-message
| no
| A no-permission message
| <code>permission-message: You do not have /<permission></code>
|
*Displayed to a player that attempts to use a command but does not have the associated permission
*<permission> is a macro that is replaced with the permission node that is required to use the command.
*You may use empty quotes to indicate nothing should be displayed.

|-
| usage
| no
| A short description of how to use this command.
| <code>usage: Syntax error! Perhaps you meant /<command> PlayerName?</code>
|
*Displayed to whoever issued the command when the plugin's command handler (onCommand typically) does not return true.
*<command> is a macro that is replaced with the command issued wherever it occurs.
*To use the string "Usage:" (i.e. <code>usage: Usage: /god [player]</code>, surround the text after the usage: label with double-quotes:<br> <code>usage: "Usage: /god [player]"</code>

|}

A permission block starts with the permission's name and is followed by nodes of attributes

{| cellspacing="0" cellpadding="4" border="1" class="wikitable"
|-
! Permission Attribute
! Required
! Description
! Example
! Notes
|-
| description
| no
| A short description of what this permission allows
| <pre>description: Allows you to set yourself on fire</pre>
|
*Allows programmatic access, and helps server administrators

|-
| default
| no
| Sets the default value of the permission
| <pre>default: true</pre>
|
*If node does not exist the permission defaults to op
*allowed defaults are: true, false, op, not op
*op default will be true if player is op
*no op default is the opposite behavior (of op)

|-
| children
| no
| allows you to set children for the permission. Child nodes are permission names
| <pre>children:
inferno.flagrate: true
inferno.burningdeaths: true</pre>
|
*Each child node must be either set to true or false
**a child node of true inherits the parent permission
**a child node of false inherits the inverse parent permission
* Can also contain other permission nodes [https://github.com/bukkit/bukkit/commit/326f2aca9b98d1d096842d3410000ed9d84611f5 {1}]

|}

Example:

<blockquote><source lang="yaml" style="border: 1px #aaa solid;">
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
</source></blockquote>

{{Languages|Plugin YAML}}

Plugin.yml

2021-05-05T02:16:28Z

THS-yuhao：

{{DocsInclude}}
When Bukkit loads a plugin, it needs to know some basic information about it. It reads this information from a YAML file, 'plugin.yml'. This file consists of a set of attributes, each defined on a new line and with no indentation.

{| cellspacing="0" cellpadding="4" border="1" class="wikitable"
|+ Attributes
|-
! Attribute
! Required
! Description
! Example
! Notes
|- style="font-weight: bold;"
| name
| yes
| The name of your plugin.
| <code>name: MyPlugin</code>
|
*Must consist of all alphanumeric characters and underscores (a-z,A-Z,0-9, _)
*Used to determine the name of the plugin's data folder. Data folders are placed in the ./plugins/ directory by default.
*It is good practice to name your jar the same as this, for example 'MyPlugin.jar'

|- style="font-weight: bold;"
| version
| yes
| The version of this plugin.
| <code>version: 1.4.1</code>
|
*Version is an arbitrary string, however the most common format is MajorRelease.MinorRelease.Build (eg: 1.4.1).
*Typically you will increment this every time you release a new feature or bug fix.
*Displayed when a user types <code>/version PluginName</code>

|-
| description
| no
| A human friendly description of the functionality your plugin provides.
| <code>description: This plugin is so 31337. You can set yourself on fire.</code>
|
*The description can have multiple lines.
*Displayed when a user types <code>/version PluginName</code>

|-
| load
| no
| Explicitly state when the plugin should be loaded. if not supplied will default to postworld
| <code> load: STARTUP </code>
| Has two possible values
* STARTUP
* POSTWORLD
|-
| author
| no
| Uniquely identifies who developed this plugin.
| <code>author: CaptainInflamo</code>
|
*Gives credit to the developer.
*Used in some server error messages to provide helpful feedback on who to contact when an error occurs.
*A bukkit.org forum handle or email address is recommended.
*Is displayed when a user types /version PluginName

|-
| authors
| no
| Allows you to list multiple authors, if it is a collaborative project. See author.
| <code>authors: [Cogito, verrier, EvilSeph]</code>
|
*You can define both author and authors, however they will be merged into one list internally.

|-
| website
| no
| The plugin's or author's website.
| <code>website: http://forums.bukkit.org/threads/MyPlugin.31337/</code>
|
*If you have no dedicated website, a link to the Bukkit forum post where this plugin is listed is highly recommended.
*Displayed when a user types <code>/version PluginName</code>

|- style="font-weight: bold;"
| main
| yes
| Points to the class that extends JavaPlugin
| <code>main: org.bukkit.plugin.MyPlugin</code>
|
*Note that this must contain the full namespace including the class file itself.
*If your namespace is <code>org.bukkit.plugin</code>, and your class file is called <code>MyPlugin</code> then this must be <code>org.bukkit.plugin.MyPlugin</code>

|-
| database
| no
| Set to true if this plugin uses a database.
| <code>database: false</code>
|
*Using a database is non-trivial. See [[Plugin_Databases]]

|-
| depend
| no
| A list of plugins that your plugin requires to load.
| <code>depend: [OnePlugin, AnotherPlugin]</code>
|
*The value must be in YAML list format (See http://en.wikipedia.org/wiki/YAML#Lists )
*Use the "name" attribute of the required plugin in order to specify the dependency.
*If any plugin listed here is not found your plugin will fail to load.
*If multiple plugins list each other as a depend, so that there are no plugins without an unloadable dependency, all will fail to load.
*(See: Wiki: Plugin_Dependencies)
|-
| prefix
| no
| The name to use when logging to console instead of the plugin's name.
| <code>prefix: ex-why-zee</code>
|
|-
| softdepend
| no
| A list of plugins that are required for your plugin to have full functionality.
| <code>softdepend: [OnePlugin, AnotherPlugin]</code>
|
*The value must be in YAML list format (See http://en.wikipedia.org/wiki/YAML#Lists )
*Use the "name" atrribute of the desired plugin in order to specify the dependancy.
*Your plugin will load after any plugins listed here.
*Circular soft dependencies are loaded arbitrarily.
*(See: Wiki: Plugin_Dependencies)

|-
| loadbefore
| no
| A list of plugins should be loaded after your plugin.
| <code>loadbefore: [OnePlugin, AnotherPlugin]</code>
|
*The value must be in YAML list format (See http://en.wikipedia.org/wiki/YAML#Lists )
*Treated as if the listed plugin soft depends on the specifying plugin.
*Use the "name" atrribute of the desired plugin in order to specify the target.
*Your plugin will load before any plugins listed here.
*Circular soft dependencies are loaded arbitrarily.
*(See: Wiki: Plugin_Dependencies)

|-
| commands
| no
| The name of a command the plugin wishes to register, as well as an optional list of command attributes.
|
<code>
commands:
flagrate:
[optional command attributes]
</code>

|
*The command name should not contain the leading '/' required to issue a command.
*You can choose any command name you wish, however 'common' commands such as <code>/kick</code> are often already registered. Use the 'alias' command attribute to supply alternate names. @TODO: verify we're happy with this

|-
| permissions
| no
| Permissions that the plugin whishes to register. Each node represents a permission to register. Each permission can have additional attributes.
| <pre>permissions:
inferno.*:
[optional permission attributes]
inferno.flagate:
[optional permission attributes]
inferno.burningdeaths:
[optional permission attributes]</pre>
|
*Permission registration is optional, can also be done from code
*Permission registration allows you to set descriptions, defaults, and child parent relationships
*Permission names should be kept in the style of <pluginname>.[category].[category].<permission>

|}

A command block starts with the command's name, and then has a list of attributes.

{| cellspacing="0" cellpadding="4" border="1" class="wikitable"
|-
! Command Attribute
! Required
! Description
! Example
! Notes
|-
| description
| no
| A short description of what the command does.
| <code>description: Set yourself on fire</code>
|
*Can be used in conjunction with /help

|-
| aliases
| no
| Alternate command names a user may use instead
|
<code>aliases: combust_me</code> OR
<code>aliases: [combust_me, combustMe, cm]</code>

|
*You can specify any of none, 1 or many aliases.
*If you specify more than one alias, they must be in YAML list format (See http://en.wikipedia.org/wiki/YAML#Lists )

|-
| permission
| no
| The most basic permission node required to use the command
|
<code>permission: inferno.flagrate</code>

|
*This permissions node can be used to determine if a user should be able to see this command
*Some plugins will use this node to construct a personalized /help
|-
| permission-message
| no
| A no-permission message
| <code>permission-message: You do not have /<permission></code>
|
*Displayed to a player that attempts to use a command but does not have the associated permission
*<permission> is a macro that is replaced with the permission node that is required to use the command.
*You may use empty quotes to indicate nothing should be displayed.

|-
| usage
| no
| A short description of how to use this command.
| <code>usage: Syntax error! Perhaps you meant /<command> PlayerName?</code>
|
*Displayed to whoever issued the command when the plugin's command handler (onCommand typically) does not return true.
*<command> is a macro that is replaced with the command issued wherever it occurs.
*To use the string "Usage:" (i.e. <code>usage: Usage: /god [player]</code>, surround the text after the usage: label with double-quotes:<br> <code>usage: "Usage: /god [player]"</code>

|}

A permission block starts with the permission's name and is followed by nodes of attributes

{| cellspacing="0" cellpadding="4" border="1" class="wikitable"
|-
! Permission Attribute
! Required
! Description
! Example
! Notes
|-
| description
| no
| A short description of what this permission allows
| <pre>description: Allows you to set yourself on fire</pre>
|
*Allows programmatic access, and helps server administrators

|-
| default
| no
| Sets the default value of the permission
| <pre>default: true</pre>
|
*If node does not exist the permission defaults to op
*allowed defaults are: true, false, op, not op
*op default will be true if player is op
*no op default is the opposite behavior (of op)

|-
| children
| no
| allows you to set children for the permission. Child nodes are permission names
| <pre>children:
inferno.flagrate: true
inferno.burningdeaths: true</pre>
|
*Each child node must be either set to true or false
**a child node of true inherits the parent permission
**a child node of false inherits the inverse parent permission
* Can also contain other permission nodes [https://github.com/bukkit/bukkit/commit/326f2aca9b98d1d096842d3410000ed9d84611f5 {1}]

|}

Example:

<blockquote><source lang="yaml" style="border: 1px #aaa solid;">
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
</source></blockquote>

{{Languages|Plugin YAML}}

Config.yml

2021-05-04T23:58:19Z

THS-yuhao：创建页面，内容为“{{DocsInclude}} The Configuration API is a set of tools to help developers quickly parse and emit configuration files that are human readable and editable. Despite t…”

{{DocsInclude}}
The Configuration API is a set of tools to help developers quickly parse and emit configuration files that are human readable and editable. Despite the name, the API can easily be used to store plugin data in addition to plugin configuration. Presently only [http://en.wikipedia.org/wiki/YAML YAML] configurations can be used. The API however was designed to be extensible and allow for other implementations.

The Configuration API can be found in the org.bukkit.configuration and org.bukkit.configuration.file packages. Plugins that were created before version 1.1-R5 may have used an older and different implementation that resided in org.bukkit.util.configuration. These implementations are not compatible and the old package has since been removed.

This introduction assumes that you have some knowledge about proper object oriented design, Java, and the core design of Bukkit plugins. This page is not a substitute for the JavaDocs for the [http://jd.bukkit.org/apidocs/index.html?org/bukkit/configuration/file/FileConfiguration.html FileConfiguration Class]

== Basic Topics ==

=== The Configuration Object ===

Your plugin extends [http://jd.bukkit.org/doxygen/d7/deb/classorg_1_1bukkit_1_1plugin_1_1java_1_1JavaPlugin.html JavaPlugin], and in doing so, you inherited methods and fields from JavaPlugin. The inherited method, ''[http://jd.bukkit.org/doxygen/d7/deb/classorg_1_1bukkit_1_1plugin_1_1java_1_1JavaPlugin.html#a79493f3bc9db2acbf9405c3a33e0acfd getConfig()]'' returns an object of type [http://jd.bukkit.org/doxygen/dd/d7c/classorg_1_1bukkit_1_1configuration_1_1file_1_1FileConfiguration.html FileConfiguration]. This is the object that represents ''config.yml'' inside your plugin's data folder.

The first time ''getConfig()'' is invoked on your plugin, ''config.yml'' is loaded from disk, and default values are loaded from the jar. Subsequent invocations of ''getConfig()'' will return the existing ''FileConfiguration'' object that is in memory. Operations performed on this object will not be written to disk unless explicitly saved. Likewise, any modifications done after the file has been loaded will not be reflected in the object. If ''config.yml'' does not exist in your data folder, it is equivalent to an empty ''config.yml'', and will load an empty ''FileConfiguration''.

{{warning}} if you assign the returned object from ''getConfig()'' DO NOT assign it to a static field<br> {{warning}} if you do the above, assign ''getConfig()'' to the variable AGAIN after a reloadConfig
{{note|it is better to just use ''getConfig()'' instead of assigning it to an instance variable}}

=== Keys ===

A configuration file is organized into key value pairs where all keys are Strings. The value for the other keys may be a ConfigurationSection or a single piece of data. The ''getKeys(boolean)'' method returns the set of keys for the current ''FileConfigurationSection''. The boolean value determines if the returned set is recursive, if true it will return the keys of the given section and their children keys, if false will only return keys of the given section. To get the keys of a particular section, the ''getKeys(boolean)'' method must be invoked on that particular section. To get the section you will have to invoke ''getConfigurationSection(String)''.

{{note|The getKeys method returns a [http://download.oracle.com/javase/1,5.0/docs/api/java/util/Set.html Set] of Strings}}

=== Paths ===

The Configuration API uses Paths to form a unique key to value pairs. A path is the set of keys used to associate a value. Each level is separated by the path separator, which is by default the '.' (period). For example the following YAML file has the following set of paths.
<blockquote><source lang="yaml">key: value
one:
two: value
three:
- values
- values
- values
four:
five: value
*:
six: value
seven: value
</source></blockquote>

*key
*one
*one.two
*one.three
*one.four
*one.four.five
*one.*
*one.*.six
*one.*.seven

=== Default Values ===

A default ''config.yml'' should be provided in your jar for users. In the case that a config.yml is missing or incomplete, values will be loaded from included ''config.yml''. The provided file must be named ''config.yml'' and be placed in the same directory as your [[Plugin YAML|plugin.yml]]. The file should have the intended structure of your ''config.yml''. This file can be copied as is into the datafolder by invoking saveDefaultConfig() on the Appropriate instance of JavaPlugin.
<blockquote><source lang="java">this.saveDefaultConfig()</source></blockquote>

If dynamic key-value pairs are required as default values, they can added as defaults to the configuration with invocations of ''addDefault(String, Object)'' and ''addDefaults(Map<String,Object>)'' methods.

In certain cases if you wish to append new key-value pairs to an existing config.yml you can set the copyDefaults to true for the ConfigurationOptions object.
<blockquote><source lang="java">this.getConfig().options().copyDefaults(true)</source></blockquote>

==== Creating a copy of config.yml ====
You can create a copy of config.yml from the jar into the plugin's data folder by invoking JavaPlugin's saveDefaultConfig() method. saveDefaultConfig() will not overwrite an existing file.

=== Getting Values ===

Reading values from the configuration involves invoking one of the many getter methods. A complete list of getters can be found [http://jd.bukkit.org/doxygen/dd/d7c/classorg_1_1bukkit_1_1configuration_1_1file_1_1FileConfiguration.html here]. Every getter method takes a configuration path detailed above. Some of the commonly used getter methods are as follows

*getBoolean(String)
*getInt(String)
*getString(String)
*getList(String)
*getStringList(String)

==== HashMaps ====

In the case of HashMaps as a value, they are treated differently than other forms of data. There is a restriction for Map types. It must use a String as a key, and the value but be either a boxed primitive, String, List, Map, or a ConfigurationSerializable type. They will lose their type.

To get a ''HashMap'', a ''ConfigurationSection'' must must first be retrieved. You can return the configuration with getConfigurationSection method. The getValues method will return the values in the ConfigurationSection as a map, it takes a boolean which controls if the nested maps will be returned in the map. You can obtain the original map by invoking getValues(false) on the returned ConfigurationSection. Due to the way Java handles generic classes, type information will be lost, thus a cast will need to be performed to set the original type information. The API makes no guarantees that the cast you perform will be safe.
<blockquote><source lang="java">this.getConfig().getConfigurationSection("path.to.map").getValues(false)</source></blockquote>

=== Setting Values ===

Writing values involves invoking the ''set(String, Object)'' method on an instance of Configuration. Unlike the different get methods that ''FileConfiguration'' has, there is only one set method. Not all objects can be set, only primitive types, ''String'', ''Lists'', and types that implement ''ConfigurationSerializable'', such as ''Vector'' and ''ItemStack'', can be set. To erase a value supply null as a parameter. All changes made by set will only affect the copy of the configuration in memory, and will not persist beyond restarting the server until the configuration is saved. Following are some example uses:
<blockquote><source lang="java">// setting a boolean value
this.getConfig().set("path.to.boolean", true);

// setting a String
String stringValue = "Hello World!";
this.getConfig().set("path.to.string", stringValue);

// setting an int value
int integerValue = 8;
this.getConfig().set("path.to.integer", integerValue);

// Setting a List of Strings
// The List of Strings is first defined in this array
List<String> listOfStrings = Arrays.asList("Hello World", "Welcome to Bukkit", "Have a Good Day!");
this.getConfig().set("path.to.list", listOfStrings);

// Setting a vector
// event is assumed to be an existing event inside an "onEvent" method.
Vector vector = event.getPlayer().getLocation().toVector();
this.getConfig().set("path.to.vector", vector);

// Erasing a value
this.getConfig().set("path.to.value", null);</source></blockquote>
<br>

==== HashMaps ====

When HashMaps are used as a value, they are treated slightly differently. The Map must parameterized with a String type for the key, and the value must be parameterized as a boxed primitive, String, List, Map, or a ConfigurationSerializable.

While you can use the set method to directly set a HashMap to a key, you cannot directly retrieve the Map back with the get method after reading directly from disk. The [[#HashMaps|context above]] is to minimize unpredictability.

To set a ''HashMap'', a ''ConfigurationSection'' must be created for that HashMap. You can only set HashMap where the key is a string the the value is something that is ConfigurationSerializable. The createSectionMethod
<blockquote><source lang="java">this.getConfig().createSection(String path, Map< String, Object > map)</source></blockquote>

=== Saving the File ===
If any changes are made to the ''FileConfiguration'' with the set methods, or any ''Lists'' are mutated, you will need to save the changes to disk if you wish to keep these changes after the plugin is disabled. To save the file to disk, invoke the saveConfig method for your plugin, it will overwrite the file already there.<blockquote><source lang="java">this.saveConfig();</source></blockquote>

=== Reloading from Disk ===

If you suspect that users have made changes to the ''config.yml'' in the data folder, those changes are not reflected in memory. Invoke the ''reloadConfig()'' method of your plugin to load from the disk again. It will destroy all changes in memory. <blockquote><source lang="java">this.reloadConfig();</source></blockquote>

=== Using an alternate configuration file ===

If for whatever reason you need another configuration file, you can use YamlConfiguration to make a new one.
<blockquote><source lang="java">FileConfiguration data = YamlConfiguration.loadConfiguration(new File(getDataFolder(), "data.yml"));</source></blockquote>
This reads the file data.yml from your data folder, and returns a FileConfiguration. If the file does not exist, the FileConfiguration is empty. If you need a pre-made FileConfiguration to be used, you can instead use an InputStream.
<blockquote><source lang="java">FileConfiguration data = YamlConfiguration.loadConfiguration(getResource("data.yml"));</source></blockquote>
This takes the InputStream from getResource, which gets a file embedded in the jar, and retreives a FileConfiguration from that.

== Advanced Topics ==

The following are some more advanced topics, meant for more advanced plugins. If you only require the default ''config.yml'', creating custom methods for reading, and saving, you will not need to go this far.

=== Options ===

Every ''FileConfiguration'' instance is associated with a [http://jd.bukkit.org/apidocs/index.html?org/bukkit/configuration/file/FileConfigurationOptions.html FileConfigurationOptions] object. The ''FileConfigurationOptions'' object controls the behavior of the ''FileConfiguration'' it is associated with. ''FileConfiguration'''s ''options()'' method returns the ''FileConfigurationOption's'' responsible for it. With it you can check and set each option. There are currently four options. Be aware that the methods are overloaded, for example ''copyDefaults()'' which returns a boolean and ''copyDefaults(boolean)'' which returns it self, but has a side effect which changes the state.

==== CopyDefaults ====

The ''copyDefaults'' option changes the behavior of Configuration's save method. By default, the defaults of the configuration will not be written to the target save file. If set to true, it will write out the default values, to the target file. However, once written, you will not be able to tell the difference between a default and a value from the configuration.

==== PathSeperator ====

PathSeperator changes the character that is used to separate the different levels of the configuration. By default it is the "." (period) but it can be changed to any char.

==== Header ====

Header is the comment block at the top of a YAML file, it is applied to the save output. The header is the only comment that Configuration API knows how to copy.

==== copyHeader ====

If ''copyHeader()'' returns true then the header will be copied on save, from the default source.

=== Arbitrary Configurations ===

If you require additional YAML files, for storing configuration information or persisting additional game information you will need to write your own methods for accessing the additional configuration files. Modeled after JavaPlugin getConfig, reloadConfig, saveConfig methods, the following is an example how to write your own methods to read and save to custom configuration files. Since these config files belong to your plugin, you can put this method in your main class so that you can have the same access as you have with config.yml. You will have to write a set of these methods for each YAML file. The advantage here, is that you can use each set in the same manner as the provided methods for the default config.yml. Alternately, adding additional methods can keep the method count lower and allow access to multiple files.

==== Mirroring the JavaPlugin implementation ====
JavaPlugin implements methods for config.yml. A plugin needs to implement its own methods to access configuration files unique to the plugin. After implementing the methods for the plugin, they can be invoked in the same context as the inherited ''getConfig()'', ''reloadConfig()'', ''saveConfig()'', and ''saveDefaultConfig()'' methods from JavaPlugin. The following can be made into a single class which allows access to any yaml file. Such a class can be found [https://gist.github.com/3174347 here]

First you will need to declare two fields and initialize them to null for each of the custom configuration files. One to hold the ''FileConfiguration'' object and one to hold the ''File'' object. The File object represents the file on the disk, and the FileConfiguration represents the contents of the configuration.
<blockquote><source lang="java">private FileConfiguration customConfig = null;
private File customConfigFile = null;</source></blockquote>

===== Implementation for Reloading =====
Then, write the method that is responsible for loading the config from disk. It will load the file, and search the jar for a default customConfig.yml. <blockquote><source lang="java">
public void reloadCustomConfig() {
if (customConfigFile == null) {
customConfigFile = new File(getDataFolder(), "customConfig.yml");
}
customConfig = YamlConfiguration.loadConfiguration(customConfigFile);

// Look for defaults in the jar
Reader defConfigStream = new InputStreamReader(this.getResource("customConfig.yml"), "UTF8");
if (defConfigStream != null) {
YamlConfiguration defConfig = YamlConfiguration.loadConfiguration(defConfigStream);
customConfig.setDefaults(defConfig);
}
}</source></blockquote>

===== Implementation for Getting =====
Next, you need to write the getter method. Check if ''customConfig'' is null, if it is load from disk. <blockquote><source lang="java">
public FileConfiguration getCustomConfig() {
if (customConfig == null) {
reloadCustomConfig();
}
return customConfig;
}</source></blockquote>

===== Implementation for Saving =====
Finally, write the save method, which saves changes and overwrites the file on disk. <blockquote><source lang="java">public void saveCustomConfig() {
if (customConfig == null || customConfigFile == null) {
return;
}
try {
getCustomConfig().save(customConfigFile);
} catch (IOException ex) {
getLogger().log(Level.SEVERE, "Could not save config to " + customConfigFile, ex);
}
}</source></blockquote>

===== Implementation for Defaults =====
Optionally, you may want to write a method that mimics JavaPlugin's saveDefaultConfig() method. <blockquote><source lang="java">public void saveDefaultConfig() {
if (customConfigFile == null) {
customConfigFile = new File(getDataFolder(), "customConfig.yml");
}
if (!customConfigFile.exists()) {
plugin.saveResource("customConfig.yml", false);
}
}</source></blockquote>

=== Serializing and Deserializing Objects ===

The Configuration API, as mentioned above can store Java objects that implement the ''ConfigurationSerializable'' Interface. Object serialization facilitates easy saving and loading so plugin authors can focus on other parts of their plugin. It greatly simplifies tasks such as storing a ''[http://jd.bukkit.org/doxygen/da/dac/classorg_1_1bukkit_1_1Location.html Location]'' in YAML, a developer can serialize a wrapper class, which provide methods to retrieve a ''Location''.<br>

Classes, in addition to implementing the ''ConfigurationSerializable'' interface must also implment one of the following as noted in the Javadoc, so that they can be serialized by the API:

*A constructor that accepts a single ''Map''.
*A static method "deserialize" that accepts a single ''Map'' and returns the class.
*A static method "valueOf" that accepts a single Map and returns the class.

In order for a serialized object to be deserialized, it must also be registered with ConfigurationSerialization. The static registerClass method must be invoked once per class that has been serialized.

This statement must be placed in your onEnable method or some other location that gets called every time your plugin is initialized:
<blockquote><source lang="java">ConfigurationSerialization.registerClass(Class<? extends ConfigurationSerializable>)</source></blockquote>
{{warning}}Do not use a static block to execute the above; if you do so, it will not be called a second time when <code>/reload</code> is used and you will encounter errors due to it not being registered!

==== Aliases ====

When classes are serialized they are marked with their fully qualified name.
You can provide an alias to your class so that it does not serialize with the fully qualified name of your class, but the alias instead. You provide the alias with the ''SerializableAs'' annotation to the class implementing ''ConfigurationSerializable''. <source lang="java">@SerializableAs(String)</source> When registering a class with an alias, the alias must be provided on registration. <blockquote><source lang="java">ConfigurationSerialization.registerClass(Class<? extends ConfigurationSerializable>, String)</source></blockquote>

== Example Use ==

Below is the an example plugin that uses the new Configuration API to be display messages as an MOTD as players join, and for the player to retrieve the rules on command. It does not follow proper style and plugin layout to keep the number of lines to a minimum.

<blockquote><source lang="java">import java.util.*;
import org.bukkit.command.*;
import org.bukkit.event.*;
import org.bukkit.plugin.java.JavaPlugin;
import org.bukkit.configuration.file.FileConfiguration;

public class SimpleMOTD extends JavaPlugin {

@Override
public void onEnable() {
// Save a copy of the default config.yml if one is not there
this.saveDefaultConfig();

// Register a new listener
getServer().getPluginManager().registerEvents(new Listener() {

@EventHandler
public void playerJoin(PlayerJoinEvent event) {
// On player join send them the message from config.yml
event.getPlayer().sendMessage(this.getConfig().getString("message"));
}
}, this);

// Set the command executor for the rules command
this.getCommand("rules").setExecutor(new CommandExecutor() {

public boolean onCommand(CommandSender sender, Command command, String label, String[] args) {
// On command send the rules from config.yml to the sender of the command
List<String> rules = this.getConfig().getStringList("rules");
for (String s : rules){
sender.sendMessage(s);
}
return true;
}
});
}
}</source></blockquote> The default config.yml that is in the plugin's jar
<source lang="yaml"># default config.yml
message: Hello World and Welcome! :)
rules:
- Play Nice
- Respect others
- Have Fun
- Dont swear</source>
{{Languages|Introduction_to_the_New_Configuration}}

Citizens/角色/DtlTraders

2021-05-04T16:22:40Z

THS-yuhao：/* 如何用: */

<div class="infobox" style="width: 295; font-size: 12px; background: #FFFFFF; float: right; border: 1px solid #CCCCCC; margin-left:2.5em; padding: 9px;">
{{Box|
BORDER = #ccc|
BACKGROUND = #aaa|
WIDTH = 275|
ALIGN = RIGHT|
ICON = |
HEADING = ''' dtlTraders ''' |
CONTENT =
<div class="padded" style="padding: 19px; font-family:camingodos-web, Helvetica; font-size:110%;">

''' dtlTraders ''' 是Citizens2的一个特性可以创建一个简单的商店或者高级商店系统.

''' 状态: ''' 已发布

''' 版本: ''' 3.5.2

''' 作者: ''' 4Creation

''' 前作者: ''' Dandielo

''' License: ''' [http://opensource.org/licenses/MIT MIT License]

''' 源码: ''' 源码可以在GitHub [https://github.com/Dandielo/dtlTraders GitHub] 上找到

''' Issues and tickets: ''' Any tickets should be created on this page [https://dev.bukkit.org/projects/dtltraders/issues Bukkit Issues]

''' C联系: ''' 你可以发送到我邮箱: support@4Creation.pro

''' 网页: ''' [http://www.4Creation.pro/ 4Creation Portal]dtlTraders 将在以后发布 ;)

</div>
}}
</div>

== 关于 ==

'''dtlTraders''' is trait for Citizens2 allowing to use NPCs as merchants.

Creating a basic trader and managing his stock is really easy, you need to know only one simple command (/trait trader) and all other things are achieved by using the provided '''GUI'''.

However you are not forced to use the trader interface if you don't want to, this plugin comes along with a bunch of commands, and a templating feature called '''patterns''', this allows you to create, change, extend, merge shops in any way you want!
You can also manage items and prices in shops using permissions, allowing you to change the shop content depending when a player has the required permission!

Also if you want you can translate each end-user part of the plugin into your language, as a result, this plugin also comes along with ready and built in translations into some languages.
If you want to contribute a translation send US a mail to support@4Creation.pro .

== 功能 ==

All working features, you can use with version '''3.0.8'''

* '''Selling''' items to players
* '''Buying''' items from players
* Easy adding, editing and removing items from a trader stock
* Easy price setting mechanism
* Allowing to open and set a '''sub-inventory''' with more specific amount choices for items
* Prices set can apply to a unit or to the whole stack
* Prices are calculated always for each added amount ''(in the sub-inventory)'' automatically and on the fly
* Supporting '''ALL custom items''' the bukkit API provides!
* Supporting '''4 attribute modifiers''' described [http://minecraft.gamepedia.com/Attribute here]!
* A lot of '''settings''', you can change to fit your needs
* A '''advanced translation system''' allowing almost everything to translate!
* Patterns allowing to '''setup traders even faster and permissions specific'''!
* Pattern system along with the '''default-pattern''' allows to create shops using '''just one command'''!!!
* The plugin has it's own API allowing to create custom Trader types and item attributes!
* Much more incoming!

== 使用前 ==

To get this plugin working you will need to get the following plugins:
* '''Citizens2'''
* '''Vault'''
* Vault supported economy plugin, like '''''BOSEconomy, Fe'''''
* Vault supported permission plugin, like '''''PermissionEx, Groupmanager'''''

After you got all of them you can just simply put the '''dtlTradersx.x.x.jar''' into the plugin directory and start using this plugin.

For the most basic setup you need only to know one command, '''/trader create <name>''' that creates a trader or simply create an NPC and add the '''/trait trader''' to it.

== 如何用: ==

这里有一堆有用的教程和链接，可以帮助你建立一个交易员。你也可以在这里找到关于这个插件的高级设置的信息。

如果缺少一些信息你可以发送邮件 support@4Creation.pro

=== 基本设置 ===

This [http://wiki.citizensnpcs.co/DtlTraders/basics tutorial] shows how to create a trader from scratch, how to add, edit and remove items.
It shows you how to set prices, manage stock item flags and how to use the '''multiple amounts''' feature.

I will also describe some config values, how they affect the game and '''in-game management''' of a trader and also which of them are trader specific.

=== 配置 ===

http://wiki.citizensnpcs.co/DtlTraders/config

=== 命令和权限 ===

http://wiki.citizensnpcs.co/DtlTraders/Commands

http://wiki.citizensnpcs.co/DtlTraders/permissions

=== 语言和翻译 ===

=== 高级设置 ===

=== Patterns ===

=== Extending ===

== Credits and thanks ==

Citizens/角色/DtlTraders

2021-05-04T16:19:33Z

THS-yuhao：

<div class="infobox" style="width: 295; font-size: 12px; background: #FFFFFF; float: right; border: 1px solid #CCCCCC; margin-left:2.5em; padding: 9px;">
{{Box|
BORDER = #ccc|
BACKGROUND = #aaa|
WIDTH = 275|
ALIGN = RIGHT|
ICON = |
HEADING = ''' dtlTraders ''' |
CONTENT =
<div class="padded" style="padding: 19px; font-family:camingodos-web, Helvetica; font-size:110%;">

''' dtlTraders ''' 是Citizens2的一个特性可以创建一个简单的商店或者高级商店系统.

''' 状态: ''' 已发布

''' 版本: ''' 3.5.2

''' 作者: ''' 4Creation

''' 前作者: ''' Dandielo

''' License: ''' [http://opensource.org/licenses/MIT MIT License]

''' 源码: ''' 源码可以在GitHub [https://github.com/Dandielo/dtlTraders GitHub] 上找到

''' Issues and tickets: ''' Any tickets should be created on this page [https://dev.bukkit.org/projects/dtltraders/issues Bukkit Issues]

''' C联系: ''' 你可以发送到我邮箱: support@4Creation.pro

''' 网页: ''' [http://www.4Creation.pro/ 4Creation Portal]dtlTraders 将在以后发布 ;)

</div>
}}
</div>

== 关于 ==

'''dtlTraders''' is trait for Citizens2 allowing to use NPCs as merchants.

Creating a basic trader and managing his stock is really easy, you need to know only one simple command (/trait trader) and all other things are achieved by using the provided '''GUI'''.

However you are not forced to use the trader interface if you don't want to, this plugin comes along with a bunch of commands, and a templating feature called '''patterns''', this allows you to create, change, extend, merge shops in any way you want!
You can also manage items and prices in shops using permissions, allowing you to change the shop content depending when a player has the required permission!

Also if you want you can translate each end-user part of the plugin into your language, as a result, this plugin also comes along with ready and built in translations into some languages.
If you want to contribute a translation send US a mail to support@4Creation.pro .

== 功能 ==

All working features, you can use with version '''3.0.8'''

* '''Selling''' items to players
* '''Buying''' items from players
* Easy adding, editing and removing items from a trader stock
* Easy price setting mechanism
* Allowing to open and set a '''sub-inventory''' with more specific amount choices for items
* Prices set can apply to a unit or to the whole stack
* Prices are calculated always for each added amount ''(in the sub-inventory)'' automatically and on the fly
* Supporting '''ALL custom items''' the bukkit API provides!
* Supporting '''4 attribute modifiers''' described [http://minecraft.gamepedia.com/Attribute here]!
* A lot of '''settings''', you can change to fit your needs
* A '''advanced translation system''' allowing almost everything to translate!
* Patterns allowing to '''setup traders even faster and permissions specific'''!
* Pattern system along with the '''default-pattern''' allows to create shops using '''just one command'''!!!
* The plugin has it's own API allowing to create custom Trader types and item attributes!
* Much more incoming!

== 使用前 ==

To get this plugin working you will need to get the following plugins:
* '''Citizens2'''
* '''Vault'''
* Vault supported economy plugin, like '''''BOSEconomy, Fe'''''
* Vault supported permission plugin, like '''''PermissionEx, Groupmanager'''''

After you got all of them you can just simply put the '''dtlTradersx.x.x.jar''' into the plugin directory and start using this plugin.

For the most basic setup you need only to know one command, '''/trader create <name>''' that creates a trader or simply create an NPC and add the '''/trait trader''' to it.

== 如何用: ==

Here are a bunch of helpful tutorials and links that can you help setting up a trader. You can also find here information about the advanced setup of this plugin.

If you lack some information you can always send US a mail to support@4Creation.pro

=== 基本设置 ===

This [http://wiki.citizensnpcs.co/DtlTraders/basics tutorial] shows how to create a trader from scratch, how to add, edit and remove items.
It shows you how to set prices, manage stock item flags and how to use the '''multiple amounts''' feature.

I will also describe some config values, how they affect the game and '''in-game management''' of a trader and also which of them are trader specific.

=== 配置 ===

http://wiki.citizensnpcs.co/DtlTraders/config

=== 命令和权限 ===

http://wiki.citizensnpcs.co/DtlTraders/Commands

http://wiki.citizensnpcs.co/DtlTraders/permissions

=== 语言和翻译 ===

=== 高级设置 ===

=== Patterns ===

=== Extending ===

== Credits and thanks ==

ImageOnMap

2021-05-04T15:47:23Z

THS-yuhao：

{{Bukkit Plugin Infobox
|插件名=ImageOnMap
|图标=[[File:ImageOnMap.png]]
|版本=3.0
|兼容服务端版本=1.6.4-1.8.3
|作者=[https://dev.bukkit.org/members/ProkopyL Prokopy]
|網址=[https://dev.bukkit.org/projects/imageonmap BukkitDev]
}}
{{待完善}}

你是否想要在游戏里的地图上浏览图片？ImageOnMap可以让你这样做！(由ImgMap制作)

==特点==

* ImageOnMap允许你在MC地图中加载网络图片

* 将网站上的图片载入到地图里.支持的格式 PNG JPEG GIF

* 这些图片将会保存在你的服务器里并在重载时重新加载（意思是加载图片后需要重载插件）

* 大图片会被分成好几份! 例如一个 1024x1024 大的图片将会被分成16个地图.

* 你的图片将会居中.

* 你可以将地图放在物品展示框里.

==快速指南==

* 请确保你的背包有足够的空位! ImageOnMap 将会把你的图片分成几个部分 (取决于图片的大小) 然后放到你的背包里.

* Type /tomap URL, URL是你想要呈现的图片的链接地址 (见下文).

* 欣赏你的图片! 如果你想的话你可以将它放在物品展示框里制作一个漂亮的海报.

==命令和权限==

===/tomap===

/tomap [url]

[url]:

* 链接必需完整, 不要忘记聊天字符限制是240个哦.

* 你可以使用像 tinyURL 类似的短网址生成器.

* 如果你想在一张地图里显示图片, 在链接后面输入 resize .

* 权限节点: imageonmap.userender

实例:

/tomap http://www.kde.org/stuff/clipart/klogo-official-lineart_detailed-128x128.png

===/maptool===

* /maptool

* /maptool delete [id]: 删除一个地图 (id为 [id] 的地图).

* /maptool list: 展示你拥有的所有地图

* /maptool get [id]: 获取一个地图的id

==配置==

* Limit-map-by-server => 设置服务器的ImageOnMap总量. 0为无限制.（直译不太好于是用插件名来代替咯）

* Limit-map-by-player => 设置玩家拥有的ImageOnMap总量. 0为无限制.

==数据采集==

* ImageOnMap 使用 metrics 收集有关插件使用的基本信息.
* 你可以在config.yml中将 "collect-data:"设置为 false 禁用（默认为true）
* 了解收集到的全部内容 http://mcstats.org/plugin/ImageOnMap

==计划功能==

* 完成: 选择是否调整图像大小;

* 完成: 添加选项限制每个玩家 / 服务器所拥有的图像数量

* 完成: 权限支持

==已知BUG==

* 有时重定向URL会无法加载图像;

* 也许还有!

非常感谢您的反馈. :) GitHub repo: [https://github.com/Coutume/ImageOnMap http://jenkins.carrade.eu/job/ImageOnMap/]

Jenkins 开发构建地址 : [http://jenkins.carrade.eu/job/ImageOnMap/ http://jenkins.carrade.eu/job/ImageOnMap/]

汉化完发现插件大更新了凸(艹皿艹 ) 现插件Bukkit地址[https://dev.bukkit.org/projects/imageonmap]

ImageOnMap

2021-05-04T15:34:29Z

THS-yuhao：

ImageOnMap

2021-05-04T15:29:29Z

THS-yuhao：

{{Bukkit Plugin Infobox
|插件名=ImageOnMap
|图标=[[File:ImageOnMap.png]]
|版本=3.0
|兼容服务端版本=1.6.4-1.8.3
|作者=[https://dev.bukkit.org/members/ProkopyL Prokopy]
|網址=[https://dev.bukkit.org/projects/imageonmap BukkitDev]
}}
{{待完善}}

你是否想要在游戏里的地图上浏览图片？ImageOnMap可以让你这样做！(由ImgMap制作)

==特点==

ImageOnMap允许你在MC地图中加载网络图片

将网站上的图片载入到地图里.支持的格式 PNG JPEG GIF

这些图片将会保存在你的服务器里并在重载时重新加载（意思是加载图片后需要重载插件）

大图片会被分成好几份! 例如一个 1024x1024 大的图片将会被分成16个地图.

你的图片将会居中.

你可以将地图放在物品展示框里.

==快速指南==

请确保你的背包有足够的空位! ImageOnMap 将会把你的图片分成几个部分 (取决于图片的大小) 然后放到你的背包里.

Type /tomap URL, URL是你想要呈现的图片的链接地址 (见下文).

欣赏你的图片! 如果你想的话你可以将它放在物品展示框里制作一个漂亮的海报.

German speakers, you can watch this video (thanks to StarlessMiner) English speakers? Watch this one ! (thanks to bebosny) Another tutorial in english (thanks to ltjim007)没有翻译必要

==命令和权限==

===/tomap===

/tomap [url]

[url]:

链接必需完整, 不要忘记聊天字符限制是240个哦.

你可以使用像 tinyURL 类似的短网址生成器.

如果你想在一张地图里显示图片, 在链接后面输入 resize .

权限节点: imageonmap.userender

实例:

/tomap http://www.kde.org/stuff/clipart/klogo-official-lineart_detailed-128x128.png

===/maptool===

/maptool

/maptool delete [id]: 删除一个地图 ((id是 [id] 的地图).

/maptool list: 展示你拥有的所有地图

/maptool get [id]: 获取一个地图的id

==配置==

Limit-map-by-server => 设置服务器的ImageOnMap总量. 0为无限制.（直译不太好于是用插件名来代替咯）

Limit-map-by-player => 设置玩家拥有的ImageOnMap总量. 0为无限制.

==数据采集==

ImageOnMap 使用 metrics 收集有关插件使用的基本信息.你可以在config.yml中将 "collect-data:"设置为 false 禁用（默认为true） * 了解收集到的全部内容 http://mcstats.org/plugin/ImageOnMap

==计划功能==

完成: 选择是否调整图像大小;

完成: 添加选项限制每个玩家 / 服务器所拥有的图像数量

完成: 权限支持

==已知BUG==

有时重定向URL会无法加载图像;

也许还有!

非常感谢您的反馈. :) GitHub repo: [https://github.com/Coutume/ImageOnMap http://jenkins.carrade.eu/job/ImageOnMap/]

Jenkins 开发构建 : [http://jenkins.carrade.eu/job/ImageOnMap/ http://jenkins.carrade.eu/job/ImageOnMap/]

ImageOnMap

2021-05-04T15:28:18Z

THS-yuhao：/* 快速指南 */

{{Bukkit Plugin Infobox
|插件名=ImageOnMap
|图标=[[File:ImageOnMap.png]]
|版本=3.0
|兼容服务端版本=1.6.4-1.8.3
|作者=[https://dev.bukkit.org/members/ProkopyL Prokopy]
|網址=[https://dev.bukkit.org/projects/imageonmap BukkitDev]
}}
{{待翻译}}
{{待完善}}

你是否想要在游戏里的地图上浏览图片？ImageOnMap可以让你这样做！(由ImgMap制作)

==特点==

ImageOnMap允许你在MC地图中加载网络图片

将网站上的图片载入到地图里.支持的格式 PNG JPEG GIF

这些图片将会保存在你的服务器里并在重载时重新加载（意思是加载图片后需要重载插件）

大图片会被分成好几份! 例如一个 1024x1024 大的图片将会被分成16个地图.

你的图片将会居中.

你可以将地图放在物品展示框里.

==快速指南==

请确保你的背包有足够的空位! ImageOnMap 将会把你的图片分成几个部分 (取决于图片的大小) 然后放到你的背包里.

Type /tomap URL, URL是你想要呈现的图片的链接地址 (见下文).

欣赏你的图片! 如果你想的话你可以将它放在物品展示框里制作一个漂亮的海报.

German speakers, you can watch this video (thanks to StarlessMiner) English speakers? Watch this one ! (thanks to bebosny) Another tutorial in english (thanks to ltjim007)没有翻译必要

==命令和权限==

===/tomap===

/tomap [url]

[url]:

链接必需完整, 不要忘记聊天字符限制是240个哦.

你可以使用像 tinyURL 类似的短网址生成器.

如果你想在一张地图里显示图片, 在链接后面输入 resize .

权限节点: imageonmap.userender

实例:

/tomap http://www.kde.org/stuff/clipart/klogo-official-lineart_detailed-128x128.png

===/maptool===

/maptool

/maptool delete [id]: 删除一个地图 ((id是 [id] 的地图).

/maptool list: 展示你拥有的所有地图

/maptool get [id]: 获取一个地图的id

==配置==

Limit-map-by-server => 设置服务器的ImageOnMap总量. 0为无限制.（直译不太好于是用插件名来代替咯）

Limit-map-by-player => 设置玩家拥有的ImageOnMap总量. 0为无限制.

==数据采集==

ImageOnMap 使用 metrics 收集有关插件使用的基本信息.你可以在config.yml中将 "collect-data:"设置为 false 禁用（默认为true） * 了解收集到的全部内容 http://mcstats.org/plugin/ImageOnMap

==计划功能==

完成: 选择是否调整图像大小;

完成: 添加选项限制每个玩家 / 服务器所拥有的图像数量

完成: 权限支持

==已知BUG==

有时重定向URL会无法加载图像;

也许还有!

非常感谢您的反馈. :) GitHub repo: [https://github.com/Coutume/ImageOnMap http://jenkins.carrade.eu/job/ImageOnMap/]

Jenkins 开发构建 : [http://jenkins.carrade.eu/job/ImageOnMap/ http://jenkins.carrade.eu/job/ImageOnMap/]

ImageOnMap

2021-05-04T15:27:21Z

THS-yuhao：

{{Bukkit Plugin Infobox
|插件名=ImageOnMap
|图标=[[File:ImageOnMap.png]]
|版本=3.0
|兼容服务端版本=1.6.4-1.8.3
|作者=[https://dev.bukkit.org/members/ProkopyL Prokopy]
|網址=[https://dev.bukkit.org/projects/imageonmap BukkitDev]
}}
{{待翻译}}
{{待完善}}

你是否想要在游戏里的地图上浏览图片？ImageOnMap可以让你这样做！(由ImgMap制作)

==特点==

ImageOnMap允许你在MC地图中加载网络图片

将网站上的图片载入到地图里.支持的格式 PNG JPEG GIF

这些图片将会保存在你的服务器里并在重载时重新加载（意思是加载图片后需要重载插件）

大图片会被分成好几份! 例如一个 1024x1024 大的图片将会被分成16个地图.

你的图片将会居中.

你可以将地图放在物品展示框里.

==快速指南==

请确保你的背包有足够的空位! ImageOnMap 将会把你的图片分成几个部分 (取决于图片的大小) 然后放到你的背包里.

Type /tomap URL, URL是你想要呈现的图片的链接地址 (see the section below).

欣赏你的图片! 如果你想的话你可以将它放在物品展示框里制作一个漂亮的海报.

German speakers, you can watch this video (thanks to StarlessMiner) English speakers? Watch this one ! (thanks to bebosny) Another tutorial in english (thanks to ltjim007)

==命令和权限==

===/tomap===

/tomap [url]

[url]:

链接必需完整, 不要忘记聊天字符限制是240个哦.

你可以使用像 tinyURL 类似的短网址生成器.

如果你想在一张地图里显示图片, 在链接后面输入 resize .

权限节点: imageonmap.userender

实例:

/tomap http://www.kde.org/stuff/clipart/klogo-official-lineart_detailed-128x128.png

===/maptool===

/maptool

/maptool delete [id]: 删除一个地图 ((id是 [id] 的地图).

/maptool list: 展示你拥有的所有地图

/maptool get [id]: 获取一个地图的id

==配置==

Limit-map-by-server => 设置服务器的ImageOnMap总量. 0为无限制.（直译不太好于是用插件名来代替咯）

Limit-map-by-player => 设置玩家拥有的ImageOnMap总量. 0为无限制.

==数据采集==

ImageOnMap 使用 metrics 收集有关插件使用的基本信息.你可以在config.yml中将 "collect-data:"设置为 false 禁用（默认为true） * 了解收集到的全部内容 http://mcstats.org/plugin/ImageOnMap

==计划功能==

完成: 选择是否调整图像大小;

完成: 添加选项限制每个玩家 / 服务器所拥有的图像数量

完成: 权限支持

==已知BUG==

有时重定向URL会无法加载图像;

也许还有!

非常感谢您的反馈. :) GitHub repo: [https://github.com/Coutume/ImageOnMap http://jenkins.carrade.eu/job/ImageOnMap/]

Jenkins 开发构建 : [http://jenkins.carrade.eu/job/ImageOnMap/ http://jenkins.carrade.eu/job/ImageOnMap/]

Studio讨论:互助客栈

2021-05-04T14:47:13Z

THS-yuhao：/* 在下面留名 */

{{模板:互助客栈提示}}

{{Comment Title}}

== 插件百科新图标设计意见征求 ==

''百科图标许久未变，初始是为kaho同学所协助编辑，但时至今日，此图标显得并不正式，且未显示出插件百科值特色与理念。

故在此征求大家对新图标的意见。

意见初步统一之后将创建投票，最终全部通过后由指定成员（小组）进行创作。
''
[[用户:Iwar|Re_]]（[[用户讨论:Iwar|讨论]]） 2015年9月2日 (三) 14:19 (HKT)

图标早就有啦 =A=

[[用户:LocusAzzurro|LocusAzzurro]]（[[用户讨论:LocusAzzurro|讨论]]） 2016年9月26日 (一) 02:51 (CST)
== 成员名单贴 ==

因为不知道有多少人在这里...

所以在此留下你的ID...

......

正经点吧

用5级标题写自己的名字

除管理员外请不要删除别人的名字

本人为例

作者seesaw_233 2015-10-16
::可以在[[特殊:贡献得分|这里]]了解下最近活跃的成员 [[用户:Iwar|Re_]]（[[用户讨论:Iwar|讨论]]） 2015年10月25日 (日) 11:10 (HKT)
=== 在下面留名 ===
===== Stydxm =====
===== seesaw_233 =====
===== LocusAzzurro =====
===== Lzs =====
===== Lichi2050 路过看看 =====
===== SYS_TEM =====
===== Leo =====
===== Mecho =====
===== Salt_lovely =====
===== D0048 =====
===== MiaoDaze =====
=====Jeason_Lan=====
===== zythonc =====
===== THS-yuhao =====
[[用户:SYS TEM|SYS TEM]]（[[用户讨论:SYS TEM|讨论]]） 2016年3月25日 (五) 23:09 (CST)

== 凉了？留名！ ==

大哥大姐们别吓唬我啊，这站凉了？

没凉的话来下面留个签名戳呗
----
[[用户:MiaoDaze|MiaoDaze]]（[[用户讨论:MiaoDaze|讨论]]） 2018年9月24日 (一) 18:11 (CST)
----

: 本页面用于成员间沟通正式的百科事务，在此处讨论之意义便是公开与存档，谢绝闲聊。

: <span style="box-shadow:0px 0px 30px #0FA;font: 12px 微软雅黑">[[用户:iwar|<span style="background:#0FA;padding:0 19px;color:#fff">iwar</span>]][[用户讨论:iwar|<span style="padding:0 19px;color:#0FA">讨论</span>]]</span> 2018年9月25日 (二) 08:41 (CST)

:: Ironically, LK-chan has just left her name here :D --[[用户:Henry5041|Henry5041]]（[[用户讨论:Henry5041|讨论]]） 2018年9月29日 (六) 14:57 (CST)

== 建议 ==

各位插件wiki管理员：

各位好！

我是来自中文wiki的电量233，我有对贵wiki的几个建议要提：

1.主页

拜托各位建立主页的/editcopy，让每位用户都可以编辑主页。

2.模板

关于模板，在插件wiki也是这缺那缺，所以各位可以建立一个页面，专门放从其他wiki盗窃（划掉）借鉴的template。

3.制度

我观察到贵wiki仍没有一个详细、明确的管理制度，希望各位可以盗窃（划掉）借鉴一个管理制度，这样可以免一些杂事。

[[User:电量233|<span style="font:83% Times;line-height:1.1em;border-radius:9em;padding:0 4em;box-shadow:0 2px 9px #ace;background:linear-gradient(40deg,#396cdb,#2c58cc 60%,#39f 60%,#4dbeff 75%,#3df 75%,#3cf);color:#fff">电量233</span>]] <sup>[[User talk:电量233|讨论]]</sup>•<sub>[[Special:%E7%94%A8%E6%88%B7%E8%B4%A1%E7%8C%AE/电量233|贡献]]</sub> 2019年3月10日 (日) 07:52 (CST)

: 你好，感谢你的建议，也可以加主群278733923进行讨论。
<span style="box-shadow:0px 0px 30px #0FA;font: 12px 微软雅黑">[[用户:iwar|<span style="background:#0FA;padding:0 19px;color:#fff">iwar</span>]][[用户讨论:iwar|<span style="padding:0 19px;color:#0FA">讨论</span>]]</span> 2019年3月16日 (六) 19:48 (CST)

: 值得注意的是，Minecraft Wiki采用CC_BY-NC-SA协议，而本wiki采用CC_BY-SA协议，无法从Minecraft Wiki直接复制粘贴模板。--[[用户:Jingkaimori|Jingkaimori]]（[[用户讨论:Jingkaimori|讨论]]） 2020年4月17日 (五) 08:51 (CST)

== 收不到确认电子邮件 ==

试过好几次了，收不到确认电子邮件，导致电子邮件无法确认。--[[用户:SolidBlock|SolidBlock]]（[[用户讨论:SolidBlock|讨论]]） 2020年1月31日 (五) 12:38 (CST)

== 收不到邮件+1 ==

注册以来已经一个多星期了，试了好几次，换了好几个邮箱都不能收到邮件，能否解决一下？
:[[User:XinuGod|XinuGod]]，请留言时不要忘记签名。--[[用户:SolidBlock|SolidBlock]]（[[用户讨论:SolidBlock|讨论]]） 2020年9月16日 (三) 17:59 (CST)

== 强烈建议启用Scribunto ==

Scribunto是用于实现用Lua编写模板的扩展程序。这将简化一些复杂代码，同时实现一些复杂功能。建议启用Scribunto扩展。--[[用户:SolidBlock|SolidBlock]]（[[用户讨论:SolidBlock|讨论]]） 2020年9月16日 (三) 17:57 (CST)

== 首页“百科有话说”栏目缺少更新 ==

首页“百科有话说”栏目最新还是2017年的，需要更新。——[[用户:SolidBlock|SolidBlock]]（[[用户讨论:SolidBlock|讨论]]） 2020年9月18日 (五) 18:47 (CST)

Plugin.yml

2021-05-04T14:39:26Z

THS-yuhao：/* Plugin.yml */

=== Plugin.yml ===

-----

Plugin.yml 文件包含了你的插件信息，没有这个文件，你的插件将'''不会正常工作'''，它由一组属性组成，'''注意！！！''' 这些属性是严格区分大小写的。接下来粗体是必需属性（缺了就会有问题），斜体是可选属性(但有一些在一些特定的情况下必须要有)

<h3>
目录：
</h3>
* [[#Required|必需属性]]
* [[#Optional|可选属性]]
* 命令
* 权限
* 实例

<h4 id="Required">
必需属性
</div>
要想 plugin.yml 有效则有三个属性必须存在

<u>'''main：'''</u>

* 指插件的主类名
* 在插件中主类名有且仅有一个，而且需要继承<code>JavaPlugin</code>类
* 主类名是插件的“入口” 反正这玩意在插件启动时执行

''例：''

<syntaxhighlight lang="yaml">main: org.mineplugin.testplugin.Test
# 格式是包名加上主类名你可别说你不知道什么是包和主类</syntaxhighlight>
<u>'''name：'''</u>

* 插件的名称
* 必须由(a-z,A-Z,0-9, _)组成这里建议写“''一个特殊''”一点名字避免和其它插件重名

''例：''

<syntaxhighlight lang="yaml">name: MinePlugin</syntaxhighlight>
<u>'''version'''</u>

* 这是你插件的版本
* 理论上可以填写任何String类型 [https://semver.org/lang/zh-CN/ 参考文献]

<syntaxhighlight lang="yaml">version: 1.0.0</syntaxhighlight>
<h4 class="Optional">
可选属性
</h4>

Plugin.yml

2021-05-04T14:37:16Z

THS-yuhao：/* Plugin.yml */

=== Plugin.yml ===

-----

Plugin.yml 文件包含了你的插件信息，没有这个文件，你的插件将'''不会正常工作'''，它由一组属性组成，'''注意！！！''' 这些属性是严格区分大小写的。接下来粗体是必需属性（缺了就会有问题），斜体是可选属性(但有一些在一些特定的情况下必须要有)

<h3>
目录：
</h3>
* [[#Required|必需属性]]
* [[#Optional|可选属性]]
* 命令
* 权限
* 实例

<h4 id="Required">
必需属性
</div>
要想 plugin.yml 有效则有三个属性必须存在

<u>'''main：'''</u>

* 指插件的主类名
* 在插件中主类名有且仅有一个，而且需要继承<code>JavaPlugin</code>类
* 主类名是插件的“入口” 反正这玩意在插件启动时执行

''例：''

<syntaxhighlight lang="yaml">main: org.mineplugin.testplugin.Test
# 格式是包名加上主类名你可别说你不知道什么是包和主类</syntaxhighlight>
<u>'''name：'''</u>

* 插件的名称
* 必须由(a-z,A-Z,0-9, _)组成这里建议写“''一个特殊''”一点名字避免和其它插件重名

''例：''

<syntaxhighlight lang="yaml">name: MinePlugin</syntaxhighlight>
<u>'''version'''</u>

* 这是你插件的版本
* 理论上可以填写任何String类型

<syntaxhighlight lang="yaml">version: 1.0.0</syntaxhighlight>
<h4 class="Optional">
可选属性
</h4>

Plugin.yml

2021-05-04T14:36:16Z

THS-yuhao：/* Plugin.yml */

=== Plugin.yml ===

-----

Plugin.yml 文件包含了你的插件信息，没有这个文件，你的插件将'''不会正常工作'''，它由一组属性组成，'''注意！！！''' 这些属性是严格区分大小写的。接下来粗体是必需属性（缺了就会有问题），斜体是可选属性(但有一些在一些特定的情况下必须要有)

<h3>
目录：
</h3>
* [[#Required|必需属性]]
* [[#Optional|可选属性]]
* 命令
* 权限
* 实例

<h4 id="Required">
必需属性
</div>
要想 plugin.yml 有效则有三个属性必须存在

<u>'''main：'''</u>

* 指插件的主类名
* 在插件中主类名有且仅有一个，而且需要继承<code>JavaPlugin</code>类
* 主类名是插件的“入口” 反正这玩意在插件启动时执行

''例：''

<syntaxhighlight lang="yaml">main: org.mineplugin.testplugin.Test
# 格式是包名加上主类名你可别说你不知道什么是包和主类</syntaxhighlight>
<u>'''name：'''</u>

* 插件的名称
* 必须由(a-z,A-Z,0-9, _)组成这里建议写“''一个特殊''”一点名字避免和其它插件重名

''例：''

<syntaxhighlight lang="yaml">name: MinePlugin</syntaxhighlight>
<u>'''version'''</u>

* 这是你插件的版本
* 理论上可以填写任何String类型 [[https://semver.org/lang/zh-CN/|参考]]

<syntaxhighlight lang="yaml">version: 1.0.0</syntaxhighlight>
<h4 class="Optional">
可选属性
</h4>

Plugin.yml

2021-05-04T14:34:37Z

THS-yuhao：

=== Plugin.yml ===

-----

Plugin.yml 文件包含了你的插件信息，没有这个文件，你的插件将'''不会正常工作'''，它由一组属性组成，'''注意！！！''' 这些属性是严格区分大小写的。接下来粗体是必需属性（缺了就会有问题），斜体是可选属性(但有一些在一些特定的情况下必须要有)

<h3>
目录：
</h3>
* [[#Required|必需属性]]
* [[#Optional|可选属性]]
* 命令
* 权限
* 实例

<h4 id="Required">
必需属性
</div>
要想 plugin.yml 有效则有三个属性必须存在

<u>'''main：'''</u>

* 指插件的主类名
* 在插件中主类名有且仅有一个，而且需要继承<code>JavaPlugin</code>类
* 主类名是插件的“入口” 反正这玩意在插件启动时执行

''例：''

<syntaxhighlight lang="yaml">main: org.mineplugin.testplugin.Test
# 格式是包名加上主类名你可别说你不知道什么是包和主类</syntaxhighlight>
<u>'''name：'''</u>

* 插件的名称
* 必须由(a-z,A-Z,0-9, _)组成这里建议写“''一个特殊''”一点名字避免和其它插件重名

''例：''

<syntaxhighlight lang="yaml">name: MinePlugin</syntaxhighlight>
<u>'''version'''</u>

* 这是你插件的版本
* 理论上可以填写任何String类型 <a href="https://semver.org/lang/zh-CN/" target="iframe">参考</a>

<syntaxhighlight lang="yaml">version: 1.0.0</syntaxhighlight>
<h4 class="Optional">
可选属性
</h4>