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/pl

From BukkitWiki
Jump to: navigation, search
This page has been suggested for inclusion in the Official Documentation

This page has been marked for inclusion in the Bukkit Offical Documentation section, Docs. You can deliberate about its inclusion on its Talk page.

Gdy bukkit ładuje plugin, potrzebuje uzyskać kilka informacji o nim. Czyta je z pliku YAML, 'plugin.yml'. Plik ten składa się z zestawu atrybutów, z których każdy znajduje się w osobnej linii.

Attributes
Atrybut Wymagane Opis Przykład Uwagi
name tak Nazwa twojego pluginu. name: MyPlugin
  • Może składać się tylko ze znaków alfanumerycznych i podkreślenia (a-z,A-Z,0-9, _)
  • Służy do określenia nazwy folderu z danymi pluginu, który umieszczany jest w folderze ./plugins/
  • Dobrą praktyką jest nazwanie tak samo pliku .jar, np. "MyPlugin.jar"
version tak Wersja Twojego pluginu. version: 1.4.1
  • Może to być dowolny ciąg znaków, lecz najbardziej popularna jest forma GłówneWydanie.MniejszaZmiana.MalutkaZmiana (np. 1.4.1)
  • Normalnie powinno się ją zwiększać przy każdym wypuszczeniu nowej wersji
  • Wyświetla się gdy gracz wpisze /version PluginName
description nie Przyjazny dla człowieka opis co właściwie potrafi ten plugin description: This plugin is so 31337. You can set yourself on fire.
  • Opis może mieć kilka linii.
  • Wyświetla się gdy gracz wpisze /version PluginName
load nie Jednoznacznie stwierdza kiedy plugin powinien powinien się załadować. Domyślnie jest to POSTWORLD load: STARTUP Są dwie możliwe wartości
  • STARTUP
  • POSTWORLD
author nie Wskazuje kto stworzył ten plugin. author: CaptainInflamo
  • Używane przy kilku errorach serwera w celu wskazania do kogo się zwrócić o pomoc.
  • Zalecana taka sama nazwa jak na Bukkit.org lub email.
  • Wyświetla się gdy gracz wpisze /version PluginName
authors nie Pozwala na podanie kilku autorów. authors: [Cogito, verrier, EvilSeph, regzand]
  • Można podać zarówna jednego jak i kilku autorów.
website nie Strona internetowa pluginu lub autora. website: http://forums.bukkit.org/threads/MyPlugin.31337/
  • Jeżeli nie posiadasz strony internetowej powinieneś podać link do posta na forum.
  • Wyświetla się gdy gracz wpisze /version PluginName
main tak Wskazuje na plik .class który dziedziczy po JavaPlugin main: org.bukkit.plugin.MyPlugin
  • Musi tu być zawarta cała ścieżka łącznie z nazwą pliku
  • Jeżeli twoja ścieżka jest org.bukkit.plugin, a twój plik nazywa się MyPlugin to ścieżka musi wyglądać tak org.bukkit.plugin.MyPlugin
database nie Ustaw na true jeżeli plugin korzysta z bazy danych database: false
depend nie Lista pluginów wymaganych do załadowania pluginu. depend: [OnePlugin, AnotherPlugin]
  • Musi być w formacie listy YAML (Zobacz http://en.wikipedia.org/wiki/YAML#Lists )
  • Używaj "name" pluginów
  • Jeżeli na serwerze nie ma takiego pluginu to wyskoczy błąd przy ładowaniu
  • Jeżeli wiele pluginów jest zależnych od siebie nawzajem, to wszystkim wyskakuje błąd
  • (Zobacz: Wiki: Plugin_Dependencies)
prefix nie Przedrostek pluginu prefix: ex-why-zee
softdepend nie Lista pluginów wymaganych aby plugin był w pełni funkcjonalny softdepend: [OnePlugin, AnotherPlugin]
  • Musi być w formacie listy YAML (Zobacz http://en.wikipedia.org/wiki/YAML#Lists )
  • Używaj "name" pluginów.
  • Twój plugin załaduje się po wszystkich wymienionych tutaj.
  • Gdy pluginy są wzajemnie zależne, to kolejność ich uruchamiania jest narzucona przez bukkit'a.
  • (Zobacz: Wiki: Plugin_Dependencies)
loadbefore nie Lista pluginów które powinny być uruchomione przed twoim loadbefore: [OnePlugin, AnotherPlugin]
  • Musi być w formacie listy YAML (Zobacz http://en.wikipedia.org/wiki/YAML#Lists )
  • Używaj "name" pluginów
  • Traktowane tak ja pluginy słabo zależne od twojego.
  • Gdy pluginy są wzajemnie zależne, to kolejność ich uruchamiania jest narzucona przez bukkit'a.
  • (Zobacz: Wiki: Plugin_Dependencies)
commands nie Lista komend na które reaguje twój plugin

commands:
 flagrate:
   [optional command attributes]

  • Komendy nie powinny zawierać "/" na początku
  • Możesz używać dowolnych nazw komend jakie chcesz, ale takie komendy jak "kick" często się powtarzają więc lepiej używać ich jako aliasów
permissions nie Permissions które zostaną zarejestrowane. Każde permissions może mieć dodatkowe atrybuty.
permissions:
  inferno.*:
    [optional permission attributes]
  inferno.flagate:
    [optional permission attributes]
  inferno.burningdeaths:
    [optional permission attributes]
  • Rejestracja permissions jest opcjonalna, może być także wykonana przez kod.
  • Nazwy permissions powinny trzymać siętego wzorca: <pluginname>.[category].[category].<permission>


Sekcja komendy zaczyna się od jej nazwy, a później jest lista jej atrybutów.

Atrybut Wymagane Opis Przykład Uwagi
description nie Krótki opis co robi dana komenda. description: Set yourself on fire
  • Może być użyte przy wywołaniu komendy /help
aliases nie Alternatywne nazwy komendy.
aliases: combust_me OR 
aliases: [combust_me, combustMe]
permission nie Najbardziej podstawowe permissions potrzebne do użycia permissions
permission: inferno.flagrate
  • Może być to użyte do tego czy gracz widzi tą komende
  • Niektóre pluginy używają tego do wyświetlania pomocy
permission-message nie Wiadomość wyświetlana gdy nie posiada się wystarczających uprawnień permission-message: You do not have /<permission>
  • Wyświetla się graczowi, który próbował użyć komendy do której nie maił prawa
  • <permission> zostaje zamieniane na permissions.
  • Możesz zostawić puste, aby nie wyświetlało się nic.
usage nie Krótki opis jak używać komendę usage: Syntax error! Perhaps you meant /<command> PlayerName?
  • Wyświetlane gdy plugin zwróci false z motody onCommand.
  • <command> zostaje zamienione na komende.


Sekcja permissions zaczyna się od jej nazwy, a później jest lista jej atrybutów.

Atrybuty Wymagane Opis Przykład Uwagi
description nie Krótki opis wskazujący na co pozwala dane permissions
description: Allows you to set yourself on fire
  • Ułatwia administratorom serwerów przyznawanie praw
default nie Ustawia domyślną wartość permissions
default: true
  • Ustawia czy dane permissions ma być z góry dostępne dla wszystkich czy nie
  • Dostępne są następujące opcje: true, false, op, not op
  • gdy op, będzie to domyślne dla op'ów
  • gdy no op. będzie to domyślne dla zwykłych graczy
children nie Pozwala na ustawienie dzieci tego permissions.
children:
  inferno.flagrate: true
  inferno.burningdeaths: true


Przykład:

name: Inferno
version: 1.4.1
description: Ten plugin jest taki 31337. Mozesz sie podpalic.
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: Podpal sie.
    aliases: [combust_me, combustMe]
    permission: inferno.flagrate
    usage: Zla skladnia! Po prostu wpisz /<komenda> aby sie podpalic.
  burningdeaths:
    description: Policz ile razy sie spaliles.
    aliases: [burning_deaths, burningDeaths]
    permission: inferno.burningdeaths
    usage: |
      /<komenda> [gracz]
      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: Daje dostep do wszystkich komand pluginu Inferno
    children:
      inferno.flagrate: true
      inferno.burningdeaths: true
      inferno.burningdeaths.others: true
  inferno.flagrate:
    description: Pozwala Ci na podpalanie sie
    default: true
  inferno.burningdeaths:
    description: Pozwala Ci na sprawdzanie ile razy sie spaliles
    default: true
  inferno.burningdeaths.others:
    description: Pozwala Ci na sprawdzanie ile razy inni sie spalili
    default: op
    children:
      inferno.burningdeaths: true


Language   EnglishбеларускаяDeutschespañolsuomifrançaisitaliano한국어Nederlandsnorsk bokmålpolskiportuguêsрусскийlietuviųčeština