Eklentiler için önemli olan plugin.yml güncelleme işlemi hakkında bilinmesi gerekenleri bu başlık altında rehber olarak hazırladık.
Minecraft sunucusu yönetirken Spigot veya Bukkit gibi bir yazılım kullanıldığında eklenti desteğine yer verilir. Plugin olarak isimlendirilen bu eklentilerin içerisinde “plugin.yml” isminde bir dosya olur. Bu dosya, eklenti için çeşitli ayarlara yer veriyor. Eğer bu dosya olmasaydı eklentinin nasıl çalışacağı belirlenemezdi. Özetle “plugin.yml” dosyası, eklentiler için oldukça önemli bir yapı sunuyor.
Buna şu şekilde örnek verelim: Bir ürün satın aldınız diyelim. Ürün montajlanmamış olsun. Ürünün nasıl kurulacağını öğrenmek için bir kılavuz kullanırsınız. İşte bu kılavuz, eklenti için “plugin.yml” olarak adlandırılıyor.
Plugin.yml Nedir?
Öncelikle bu dosyanın ne olduğundan ve içeriğinden kısaca bahsedelim. Bu dosya, eklenti ile ilgili çeşitli bilgiler içeren bir format sunuyor. YML biçiminde kayıt edilen bu dosyada eklentinin ana sınıfı, eklenti sürümü, API sürümü ve bağımlılıklar gibi birçok bilgiye yer veriliyor.
Şöyle bir örnek vererek YML dosyasının ne işe yaradığını daha iyi anlamanızı istiyoruz. Bu dosya ile birlikte hangi eklentilerin gerekli olduğu belirlenebiliyor. Sunucu başlatılırken bu eklenti için diğer eklentilerin varlığı incelenir. Sonrasında ana eklenti başlar.
Plugin.yml Nerede Yer Alır?
Sizlere plugin.yml güncelleme hakkında bilgiler sunmadan önce bu dosyanın nerede yer aldığını açıklamak istiyoruz. Bu dosyanın konumu eklenti dosyasının içerisindedir. Eklenti, JAR dosyası olarak bulunuyor. Eğer bu dosyaya WinRar gibi bir uygulama ile girilir ise ana dizinde “plugin.yml” dosyasıyla karşılaşılacak. Eklenti kodlarken de bu dosya, gerektiğinde güncellenmeli.
Plugin.yml Güncelleme Nasıl Yapılır?
Bu dosyayı güncellemek için eklentiyi geliştirirken eklentinin ana dizinindeki “plugin.yml” dosyası açılmalı ve istenen değişkenler ile değerler eklenmeli. Bunları sizler için bu başlık altında tek tek açıklamış olacağız. Öncelikle olmazsa olmaz değişkenlerden bahsedelim. Sonrasında diğer değişkenleri açıklayalım.
Bir değişken eklemek için satır şu şekilde olmalı: “name: PluginName”. YML’de format genel olarak bu şekilde olsa da şunu belirtelim ki değişkenlerin alt değişkenleri de olabiliyor. Bir değişkene birden fazla değişken eklemek için değişkeni ekledikten sonra alt satıra geçip TAB tuşuna basılmalı.
İlk değişkenimiz “name”. Bu değişken, eklentinin adını belirliyor. Bir diğer değişken ise “author” olarak yer alıyor. Bu da eklentinin sahibini belirtmek için kullanılıyor. Eklenti sürümünü belirtmek için ise “version” değişkeni eklenmeli.
En önemli değişkenlerden birisi “main” olarak yer almakta. Bu değişken, ana eklenti sınıfını belirtmek için kullanılıyor. Örneğin eklenti, proje içerisinde “plugin/main.java” olarak yer alabilir. Bu durumda yapılması gereken şey değer olarak “plugin.main” eklemek. Evet, slash işareti yerine nokta kullanmak ve uzantıyı eklememek gerekiyor.
Bir diğer değişken “commands” olmakta. Bu değişkenin alt değişkenleri bulunuyor. Alt değişkenler, komutlar olacak. Eklentide yer alan tüm komutlar buraya eklenmeli, yoksa kod olarak eklenen komut çalışmaz.
Bunlar, kullanılması gereken değişkenler olsa da 1.13 sürümünden sonra “api-version” değişkenini de kullanmak gerekiyor. Bu değişken, eklentinin API sürümünü belirtir. Yani sunucuyu geliştirirken hangi sürüm kullanılacak ise o API sürümüne yer verilmeli.
“Plugin.yml” dosyasında zorunlu olarak bulunması gereken 3 değişken var. Bunlar “main, name ve version”. Diğer değişkenler eğer gerekirse eklenmeli. Misal eğer komutlar eklediyseniz “commands” değişkenine yer vermelisiniz.
Aşağıdaki tabloda plugin.yml güncelleme işlemi yapmak isteyenler için tüm değişkenlerin bir listesini yayınlıyoruz.
main | Eklentinin ilk olarak çalıştırılacak olan sınıfının yolunu belirtir. |
name | Eklenti ismidir. |
version | Eklenti sürümüdür. |
description | Eklenti için açıklama ekler. |
api-version | 1.13 ve sonraki sürümler için Spigot API sürümünü belirtir. |
load | Eklentinin ne zaman yükleneceğini açıklar. “STARTUP” başlangıçta, “POSTWORLD” ise dünya yüklendikten sonra eklentiyi yükler. |
author | Eklenti sahibidir. |
authors | Birden fazla eklenti sahibi var ise yazılmalı. |
website | Web sitesi paylaşmak için kullanılmalı. |
depend | Gerekli olan eklentiler buraya eklenmeli. |
softdepend | Zorunlu olmayan fakat olduğunda ek özellikler açılacak ise bu eklentiler bu değişkenin içerisine yazılmalı. |
prefix | Eklentiye ön ek eklemek için kullanılır. |
loadbefore | Eğer eklenti yüklendikten sonra yüklenmesi gereken eklentiler var ise buradan belirtilmeli. Bu, öncelik sırasını ayarlar. |
libraries | Eklentinin ihtiyaç duyduğu kitaplıklara burada yer verilmeli. |
commands | Komut listesi burada bulunmalı. |
permissions | Komutların yetkileri buraya eklenmeli. |
Örnek Plugin.yml Dosyası
main: plugin.batihostplugin.core.main
name: Batıhost Plugin
version: 1.0
description: Batıhost oyuncularına özel eklenti.
load: POSTWORLD
author: Erkan_Babadagi
depend: [WorldEdit, WorldGuard, Essentials]
commands:
Ekonomi:
description: Ekonomi bilgileri yer alır.
permission: batihost.economy
Hesap:
Yardım:
Eğer sen de sunucu kurmak istiyorsan hemen Minecraft server kirala!