mIRC Addon Geliştirme: Kendi Eklentinizi Yazmak

Kendi ihtiyacınız için yazdığınız bir script işinize yarıyorsa, onu başkalarının da kullanabileceği bir addon hâline getirmeyi düşünebilirsiniz. mIRC addon geliştirme, teknik olarak script yazmaktan farklı değildir; fark, kodu başkası için hazır hâle getirmektedir. Bu rehberde bir scripti kullanılabilir bir addon'a dönüştürmenin adımlarını anlatıyoruz.

Planlama

Kod yazmaya başlamadan önce birkaç soruya cevap vermek, sonradan büyük yeniden yazımlardan kurtarır:

Addon ne yapacak? Tek bir işi iyi yapmak, on işi yarım yapmaktan iyidir. Kapsamı net tutun.

Kim kullanacak? Scripting bilen kullanıcılar mı, hiç bilmeyenler mi? İkinci grup için ayar penceresi neredeyse zorunludur.

Hangi ayarlar gerekecek? Kullanıcıların değiştirmek isteyeceği her şeyi baştan listeleyin.

Hangi veriler saklanacak? Kalıcı veri gerekiyorsa nasıl saklanacağına baştan karar verin.

Hangi mIRC sürümü? Kullanacağınız özelliklerin hangi sürümden itibaren mevcut olduğunu kontrol edin.

Dosya Yapısı

Düzenli bir dosya yapısı, addon'unuzun hem geliştirilmesini hem de kurulmasını kolaylaştırır:

addonadi/
  addonadi.mrc      (ana script)
  ayarlar.mrc       (ayar penceresi)
  okubeni.txt       (kurulum ve kullanım kılavuzu)
  degisiklikler.txt (sürüm geçmişi)
  veri/             (veri dosyaları için klasör)

Küçük addon'larda tek dosya yeterlidir. Büyüdükçe işlevlere göre dosyalara bölmek, kodu yönetilebilir tutar. Ana dosyanın diğerlerini kendisi yüklemesi, kullanıcının tek komutla kurulum yapmasını sağlar.

Veri ve ayar dosyalarını ayrı bir klasörde tutmak, güncelleme sırasında üzerine yazılmasını önler. Dosya yollarında $scriptdir identifier'ını kullanmak, addon'un her kurulumda çalışmasını sağlar.

İsimlendirme ve Önek

Bu, addon geliştirmenin en önemli teknik kuralıdır: Bütün alias, identifier, değişken, hash tablosu, timer ve pencere adlarınıza addon'unuza özgü kısa bir önek verin.

Bu tek alışkanlık, addon'unuzun başka addon'larla çakışmasını neredeyse tamamen önler. Çakışma sorunları için mIRC addon çakışmaları yazımıza bakın.

Önek seçerken kısa ve ayırt edici olmasına dikkat edin: Üç dört harf yeterlidir ve yaygın kısaltmalardan kaçınmak çakışma riskini azaltır.

Ayar Yönetimi

Ayarları koddan ayırmak, addon'unuzu kullanılabilir kılan en önemli adımdır. Üç seviye vardır:

Seviye 1: Dosya başında ayar bloğu. En basit yol. Kullanıcı kodu açıp değerleri değiştirir. Küçük addon'lar için kabul edilebilir ama kullanıcı yanlış satırı değiştirip addon'u bozabilir.

Seviye 2: Ini dosyası. Kullanıcı kodu hiç açmaz; ayrı bir ayar dosyasını düzenler. İlk çalıştırmada varsayılan değerlerle dosya oluşturmak, kullanıcıya neyi değiştirebileceğini gösterir. Bkz. mIRC ini dosyaları.

Seviye 3: Ayar penceresi. En konforlu çözüm. Kullanıcı bir komutla pencere açar, değerleri arayüzden değiştirir. Hata yapma riski en düşüktür. Bkz. mIRC addon ayar penceresi.

Addon'unuzu yaygın kullanım için hazırlıyorsanız üçüncü seviyeyi hedeflemenizi öneririz.

Varsayılan Değerler

Addon'unuz kurulduğu anda, hiç ayar yapılmadan makul şekilde çalışmalıdır. Kullanıcıların çoğu varsayılan ayarları hiç değiştirmez; bu yüzden varsayılanlar güvenli ve nazik olmalıdır.

Pratik kurallar:

• Sessiz başlayın: Kanala mesaj gönderen özellikler varsayılan olarak kapalı olsun.
• Kanal filtresi boş olsun: Addon hangi kanallarda çalışacağını kullanıcı belirtene kadar hiçbir kanalda çalışmasın.
• Flood korumalı eşikler: Mesaj aralıkları ve sayı sınırları güvenli değerlerde başlasın.
• Veri biriktirmeyi sınırlayın: Varsayılan boyut sınırları makul olsun.

Bu yaklaşım, kullanıcınızın addon'unuz yüzünden kanaldan uyarı almasını önler.

Belgeleme

Addon'unuzun belgelemesi, kodun kalitesi kadar önemlidir. Çoğu kullanıcı kodu hiç okumaz; okuduğu şey kılavuzdur.

İyi bir kılavuz şunları içerir:

• Addon ne yapar (iki üç cümle).
• Hangi mIRC sürümü gerekir.
• Kurulum adımları, komutlarıyla birlikte.
• Kurulum sonrası yapılması gerekenler.
• Sunulan komutların listesi ve ne yaptıkları.
• Ayarların açıklaması.
• Kaldırma adımları.
• Bilinen sınırlamalar.
• İletişim veya geri bildirim yolu.

Kaldırma adımlarını yazmak sık atlanan ama kullanıcı açısından değerli bir ayrıntıdır. Daha iyisi, addon'unuzun kendi kaldırma komutunu sunmasıdır: Oluşturduğu bütün değişkenleri, tabloları, timer'ları ve pencereleri temizleyen bir komut. Bkz. mIRC addon kaldırma.

Sürümleme

Sürüm numarası, kullanıcıların hangi sürümü kullandığını ve güncellemeye ihtiyaç olup olmadığını anlamasını sağlar. Üç parçalı numaralandırma yaygındır: büyük değişiklik, yeni özellik, hata düzeltmesi.

Sürüm numarasını dosyanın başındaki bilgi bloğunda, bir değişkende ve varsa ayar penceresinin başlığında tutmak iyi bir uygulamadır.

Değişiklik geçmişi dosyası da tutun: Her sürümde neyin değiştiğini listelemek, kullanıcıların güncelleme kararı vermesini sağlar ve sizin de geliştirme geçmişinizi takip etmenize yardımcı olur.

Test

Addon'unuzu yayımlamadan önce temiz bir mIRC kurulumunda test edin. Kendi kurulumunuzda çalışan kod, sizin başka scriptlerinizin sağladığı bir şeye bağımlı olabilir.

Test edilmesi gerekenler:

• Temiz kurulumda ilk çalıştırma.
• Ayar dosyası yokken davranış.
• Geçersiz veya eksik ayarlarla davranış.
• Kanal dışında çalıştırma.
• Parametre verilmeden komut çalıştırma.
• Kalabalık bir kanalda performans.
• Kaldırma işlemi.

Hata ayıklama için mIRC hata ayıklama, performans için mIRC script performansı yazılarımıza bakın.

Güvenlik

Addon'unuzu başkaları kullanacağı için güvenlik sorumluluğunuz artar. Kullanıcı girdisini güvensiz işleyen bir addon, onu kullanan herkesi riske atar.

Temel kurallar: Kullanıcı girdisini doğrulayın, değerlendirme fonksiyonlarından kaçının, dosya yollarını kullanıcı girdisinden oluşturmayın, dış veriyi doğrulamadan kullanmayın. Ayrıntılar mIRC script güvenliği yazımızda.

Ayrıca addon'unuzda parola veya kişisel bilgi bırakmadığınızdan emin olun.

Dağıtım ve Destek

Addon'unuzu paylaşırken ne kadar destek vereceğinize baştan karar verin ve bunu kılavuzda belirtin. Aktif bakım yapacaksanız bir geri bildirim yolu sunun; "olduğu gibi" paylaşıyorsanız bunu da açıkça söylemek kullanıcıların beklentisini doğru kurar.

Bir lisans eklemek, başkalarının kodunuzu nasıl kullanabileceğini netleştirir. Dağıtım ayrıntıları için mIRC script paylaşma yazımıza bakın.

Gerçek Bir Senaryo

Bir kullanıcı, kendisi için yazdığı bir kanal aracını paylaşmaya karar veriyor. İlk sürümde ayarlar kodun içinde, belgeleme yok ve bütün alias adları genel kelimeler. Kullanıcılar kurduğunda iki sorun ortaya çıkıyor: Birçoğu ayarları değiştirirken kodu bozuyor ve bazılarında başka addon'larla çakışma yaşanıyor. Geliştirici addon'u yeniden düzenliyor: Bütün adlara dört harfli bir önek ekliyor, ayarları bir ini dosyasına taşıyıp küçük bir ayar penceresi yazıyor, kurulum ve kaldırma adımlarını belgeliyor ve varsayılan ayarları hiçbir kanalda çalışmayacak şekilde güvenli hâle getiriyor. İkinci sürümden sonra destek talepleri neredeyse tamamen kesiliyor.

Sonuç

Addon geliştirmek, kodu başkası için hazır hâle getirmektir. Kapsamı net tutun, bütün adlara önek verin, ayarları koddan ayırın, varsayılanları güvenli seçin, kurulum ve kaldırmayı belgeleyin, temiz bir ortamda test edin ve güvenlik sorumluluğunu ciddiye alın. Kullanıcı dostu bir arayüz için sıradaki rehberimiz mIRC addon ayar penceresi.