Jak používat: generátor plugin.yml pro Spigot a Paper
plugin.yml je malý YAML soubor, který říká Spigotu, Paperu a Purpuru, jak načíst váš plugin: název, hlavní třídu, verzi, cílovou verzi API, příkazy a oprávnění. Tento generátor vyplní tyto obvyklé pole, abyste nemuseli ručně psát křehký YAML po každém přejmenování projektu. Negeneruje Java kód, nesestavuje jar ani neopravuje chybnou cestu k hlavní třídě.
Zadáte název pluginu, hlavní třídu, verzi, volitelně autory, popis, web, api-version, seznamy depend/softdepend, a pak příkazy a oprávnění, pokud je potřebujete. Stránka vytvoří plugin.yml, který si můžete stáhnout nebo vložit do src/main/resources. To zkrátí první nastavení projektu i opravy typu "potřebuji přidat jeden příkaz do /help".
Negeneruje váš plugin kód. Pokud je příkaz uveden zde, ale není zaregistrován v Javě, hráči uvidí nefunkční položku. Pokud hlavní třída neodpovídá balíčku, který jste zkompilovali, server odmítne plugin povolit. Berte soubor jako metadata, ne jako kouzelný instalátor.
api-version by mělo být blízko verzi Minecraftu, proti které sestavujete, aby Paper mohl varovat před nekompatibilními API. depend a softdepend pomáhají pouze tehdy, když tyto pluginy skutečně existují na cílovém serveru. Chybná jména zde nic nestahují; mění pouze pořadí načítání a chování při povolení.
Každý příkaz může mít popis, řádek použití a uzel oprávnění. Každé oprávnění může mít výchozí hodnotu (op, true, false, not op). Udržujte názvy stabilní, jakmile je začnou používat hráči a skupiny LuckPerms; pozdější přejmenování uzlu znamená migraci konfigurací na živých serverech.
V běžném projektu Maven nebo Gradle soubor leží ve složce resources, takže skončí v kořeni jar jako plugin.yml. Po přebuildování ověřte, že jar stále obsahuje tento soubor, než budete vinit generátor. Hostingové panely, které nahrávají "složky pluginů", stále potřebují správný jar pro pluginy typu Spigot.
Časté dotazy k plugin.yml
Píše to za mě Java kód?
Ne. Pouze plugin.yml. Kód, kompilaci a nasazení jar si stále děláte sami.
Paper nebo Spigot?
Základní pole jsou stejná rodina. Nastavte api-version na řádek, který podporujete, a otestujte na svém skutečném jar.
Kam soubor umístit?
Obvykle do src/main/resources/plugin.yml, aby se dostal do kořene jar.
Proč se plugin nepovolí?
Špatná hlavní třída, chybějící depend nebo chyba při načítání v onEnable. Zkontrolujte serverový log poté, co soubor vypadá správně.
Mohu YAML po stažení upravit?
Ano. Generátor je výchozí bod. Uchovejte kopii v gitu spolu se zbytkem projektu.