Lorsque Bukkit charge un plugin, il a besoin de connaître certains renseignements de base sur celui-ci. Il lit ces informations depuis un fichier YAML, 'plugin.yml'. Ce fichier est constitué d'un ensemble d'attributs, chacun défini sur une nouvelle ligne et sans indentation.
Attributs | Obligatoire | Descriptions | Exemples | Notes |
---|---|---|---|---|
name | oui | Le nom de ce plugin. | name: MonPlugin
|
|
version | oui | La version de ce plugin. | version: 1.4.1
|
|
description | non | Une description facilement compréhensible de la fonctionnalité fournie par votre plugin. | description: Ce plugin est tellement 31337. Vous pouvez vous mettre vous-meme en feu.
|
|
load | non | Définit l'état du serveur où le plugin devrait être chargé. Si non précisé il sera par défaut "postworld". | load: STARTUP
|
A deux valeurs possibles :
|
author | non | Identifie de manière unique qui a développé ce plugin. | author: CaptainInflamo
|
|
authors | non | Permet de lister plusieurs auteurs, s'il s'agit d'un projet collaboratif. Voir author. | authors: [Cogito, verrier, EvilSeph]
|
|
website | non | Le site du plugin ou de l'auteur. | website: http://forums.bukkit.org/threads/MyPlugin.31337/
|
|
main | oui | Pointe vers la classe qui hérite de JavaPlugin | main: org.bukkit.plugin.MonPlugin
|
|
database | non | Affectez la valeur true si ce plugin utilise une base de données. | database: false
|
|
depend | non | Une liste de plugins que requiert votre plugin pour se charger. | depend: [UnPlugin, AutrePlugin]
|
|
softdepend | non | Une liste de plugins qui sont requis pour votre plugin pour être pleinement fonctionnel. | softdepend: [UnPlugin, AutrePlugin]
|
|
commands | non | Le nom de la commande que le plugin souhaite enregistré, ainsi qu'une liste facultative d'attributs de commande. |
|
|
permissions | non | Les permissions que le plugin souhaite enregistrer. Chaque noeud représente une permission. Chaque permission peut avoir des attributs additionnels. | permissions: inferno.*: [attributs d'autorisation facultatif] inferno.flagate: [attributs d'autorisation facultatif] inferno.burningdeaths: [attributs d'autorisation facultatif] |
|
Un bloc de commande commence par le nom de la commande et possède ensuite une liste d'attributs.
Attribut de Commande | Obligatoire | Description | Exemple | Notes |
---|---|---|---|---|
description | non | Une courte description de ce que la commande fait. | description: Vous enflamme
|
|
aliases | non | L'alias alternatif à une commande qui sera utilisé si le nom de la commande est déjà pris. |
|
|
permission | non | Le noeud d'autorisation le plus basique requit pour utiliser la commande. |
|
|
usage | non | Une courte description de comment utiliser cette commande. | usage: Erreur de syntaxe ! Peut être que vous vouliez /<command> NomJoueur ?
|
|
Un bloc d'autorisation commence avec le nom de l'autorisation et est suivi par les attributs des noeuds.
Attribut d'Autorisation | Obligatoire | Description | Exemple | Notes | |
---|---|---|---|---|---|
description | non | Une courte description de ce que permet cette autorisation. | description: Vous permet de vous brûlez vous-même. |
| |
default | non | Détermine la valeur par défaut de l'autorisation. | default: true |
|
|
children | non | Vous permet de définir des enfants pour l'autorisation. Les noeuds enfants sont des noms d'autorisations. | children: inferno.flagrate: true inferno.burningdeaths: true |
|
Exemple :
name: Inferno version: 1.4.1 description: This plugin is so 31337. You can set yourself on fire. # On pourrait placer chaque auteur dans la liste "authors", mais j'ai choisi de ne pas # le faire à des fins d'illustrations. Aussi, définir "author" distingue cette personne # comme celle responsable du projet, et assure que son nom soit affiché en premier. 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
Language | English • беларуская • Deutsch • español • suomi • français • italiano • 한국어 • Nederlands • norsk • polski • português • русский • lietuvių • čeština |
---|