17-11-2026, 23:36
CounterStrikeSharp Ders 5: Eklenti ayar dosyası (IPluginConfig)#1
Kısa özet: CounterStrikeSharp eklenti ayarlarını JSON dosyasında tutmak için BasePluginConfig'ten türeyen bir ayar sınıfı yazın, eklentiyi IPluginConfig ile bağlayın ve OnConfigParsed içinde değerleri doğrulayın. Dosya configs/plugins/EklentiAdi klasöründe varsayılan değerlerle oluşur; değişiklikten sonra css_plugins reload ile yeniden yükleyin.
Neden ayar dosyası?
Eklenti ayarlarını kodun içine gömmek yerine JSON dosyasında tutmak, sunucu sahiplerinin eklentiyi yeniden derlemeden ayarlamasını sağlar. Bu, paylaştığınız eklentiler için de olmazsa olmazdır.
Ayar sınıfı
KOD
using System.Text.Json.Serialization;
using CounterStrikeSharp.API.Core;
public class HyReklamAyar : BasePluginConfig
{
[JsonPropertyName("Aralik")] public float Aralik { get; set; } = 90f;
[JsonPropertyName("Onek")] public string Onek { get; set; } = "[HY]";
[JsonPropertyName("Mesajlar")] public List<string> Mesajlar { get; set; } = new() { "Hos geldiniz!" };
}Eklentiye bağlama
KOD
public class HyReklam : BasePlugin, IPluginConfig<HyReklamAyar>
{
public override string ModuleName => "HY Reklam";
public override string ModuleVersion => "1.1.0";
public HyReklamAyar Config { get; set; } = new();
public void OnConfigParsed(HyReklamAyar ayar)
{
if (ayar.Aralik < 10) ayar.Aralik = 10;
Config = ayar;
}
}Dosya nerede oluşur?
İlk yüklemede CounterStrikeSharp şu dosyayı varsayılan değerlerle oluşturur:
KOD
addons/counterstrikesharp/configs/plugins/HyReklam/HyReklam.jsonDeğişiklikten sonra eklentiyi yeniden yükleyin:
KOD
css_plugins reload HyReklamDoğrulama
OnConfigParsed içinde değerleri doğrulamak (örneğin aralığın çok küçük olmaması) hatalı ayarların sunucuyu bozmasını engeller. Geçersiz değerleri güvenli varsayılana çekin ve konsola uyarı yazın.
İyi uygulamalar
- Her ayara anlamlı bir varsayılan değer verin.
- Ayar adlarını açıklayıcı seçin.
- Eklenti sürümü arttığında yeni ayarları ekleyip eskileri geriye dönük uyumlu tutun.
- Ayarları README dosyasında açıklayın.
Sık yapılan hatalar
- Ayarları kodun içine gömmek.
- Doğrulama yapmamak.
- Varsayılan değer vermemek.
- Ayar adlarını sık değiştirmek.
- Değişiklik sonrası yeniden yüklememek.
Sık sorulan sorular
Ayar dosyası nerede? configs/plugins klasöründe eklenti adıyla.
Neden JSON? Okunabilir ve CounterStrikeSharp tarafından otomatik işlenir.
Yeniden yükleme? css_plugins reload ile.
Örnek senaryo
Reklam eklentinizin aralığını değiştirmek için sunucu sahibi sizden yeni derleme istiyordu. Ayarı JSON dosyasına taşıyınca sahip dosyayı düzenleyip eklentiyi yeniden yüklüyor ve aralığı kendisi ayarlıyor.
Kontrol listesi
- Ayar sınıfı var mı?
- Varsayılanlar mantıklı mı?
- Doğrulama yapılıyor mu?
- Dosya yolu doğru mu?
- README yazıldı mı?
Ek ipucu
Eklentinizi paylaşırken örnek ayar dosyasını da pakete koyun ve her ayarın ne işe yaradığını yazın; kullanıcılar destek istemeden eklentiyi kendileri yapılandırabilir. Değişikliklerinizi önce test ortamında deneyin, çalışan son hâli yedekte tutun ve işe yarayan çözümü bir not dosyasına yazın. Küçük, tek tek yapılan değişiklikler hataları bulmayı kolaylaştırır; her adımdan sonra sonucu kontrol edin ve emin olmadığınız bir konuda resmî belgelere başvurun.
Takıldığınız bir yer olursa bu konunun altına yazın; ekip ve topluluk yardımcı olur.
Ayar sınıfındaki liste ve metin değerlerinin JSON'da doğru biçimde yazıldığından emin olun; virgül ya da tırnak hatası eklentinin ayar dosyasını okumasını engeller ve konsolda hata görürsünüz.