Minecraft 1.12.2, 1.16.5 için Project Intelligence Mod

Project Intelligence'a hoş geldiniz! nam-ı diğer "PI"

Bu projenin amacı, Minecraft topluluğunun gücünden yararlanarak gerçekten evrensel bir dokümantasyon modu oluşturmaktır.

Peki bu nasıl işleyecek? Öncelikle herhangi bir mod geliştiricisi kendi modu için PI'ye dokümantasyon ekleyebilir. Sorun şu ki mod geliştiricileri meşgul insanlardır, bu yüzden çoğunun PI gibi rastgele bir dokümantasyon modu için dokümantasyon yazmaya zamanı olmayacaktır ve bence bu, mevcut dokümantasyon modlarının çoğunda büyük bir sorundur. Doğrudan mod geliştiricileri tarafından desteklenmeleri gerekir. PI bu sorunu, topluluktaki herkesin nispeten basit yerleşik düzenleyiciyi kullanarak çeşitli modlar için dokümantasyon yazmasını mümkün kılarak çözmeyi amaçlar. Ardından dokümantasyonlarını bir pull request aracılığıyla gönderebilirler ve incelemeyi geçerse çevrimiçi depoya eklenir.

PI'nin yaptığı her şey açık kaynaklıdır ve tamamen şeffaftır. Tüm dokümantasyon ham haliyle github'da saklanır. Bu daha sonra bir jenkins sunucusu tarafından derlenir ve covers1624 tarafından kontrol edilen bir web sunucusuna yüklenir, buradan PI tarafından erişilebilir. PI'nin kullandığı her şey, dokümantasyonda kullanılan tüm görseller dahil olmak üzere bu sunucudan gelir. pi.brandon3055.com dışındaki hiçbir sunucuya istek yapılmaz. Bunun tek olası istisnası, aşağıda daha fazla bilgi edinebileceğiniz paket dokümantasyonudur.

Düzenleme: Yukarıdaki ifade, covers pi botunu bitirdiğinde doğru olacaktır; bu bot, pi'de kullanılan tüm görsellerin sunucumuzda barındırılmasını otomatik olarak sağlayacaktır. O zamana kadar bazı dokümantasyonlar imgur.com veya benzeri barındırma sitelerinde barındırılan görseller içerebilir.

Özellikler: (PI geliştikçe bu listenin büyümesini bekleyin)

Yüksek düzeyde özelleştirilebilir Kullanıcı Arayüzü Tüm PI kullanıcı arayüzü yüksek düzeyde kullanıcı tarafından özelleştirilebilir. PI şu anda yalnızca 2 varsayılan stil ön ayarına sahiptir ancak gelecekte daha fazlası eklenecektir. Ayrıca kullanıcılar kendi özel ön ayarlarını kaydetme yeteneğine sahiptir.Yan not: Varsayılan ön ayarlara güzel bir ekleme olacağını düşündüğünüz bir ön ayar oluşturduysanız, github'da paylaşmaktan çekinmeyin.

JEI Entegrasyonu PI tam JEI tarif desteğine sahiptir, yani JEI tarafından desteklenen herhangi bir tarif PI dokümantasyonunda görüntülenebilir.

İçerik Bağlama ve "Bunu Açıkla" Bu, eşyaları, blokları veya varlıkları dokümantasyon sayfalarına bağlamanıza olanak tanır. Bu, "Bunu Açıkla" adlı bir özellikle çalışır; bu özellik, dünyada bir nesneye bakarken veya envanterdeki bir eşyanın üzerine fareyle gelirken basitçe bir tuş atamasına basarak bağlantılı dokümantasyon sayfalarını açmanıza olanak tanır.

Dokümantasyonu Gui'lere Bağlama Bu özellik şu anda modların bunu desteklemesini gerektirir (ancak bu gelecekte değişebilir) Bu özellik, mod geliştiricilerinin kendi modlarındaki gui'lere belirli dokümantasyon sayfalarını bağlamasına olanak tanır. Pi daha sonra desteklenen gui'lere bir "bilgi" düğmesi ekler; bu düğme, gui'ye bağlı sayfaları içeren gui içinde mini bir pi penceresi açar.

Dil Yerelleştirme Desteği

Yerleşik düzenleyici pi doc düzenleyicisinin hala biraz çalışmaya ihtiyacı var ancak şu haliyle düzenleyici, dokümantasyon yazmak ve sürdürmek için gereken tüm temel işlevselliği sağlar.

Birden fazla mod sürümü desteği Bu, sürekli değişen modlar için dokümantasyon yazarken temel bir özelliktir. Bu özellik, bir mod bir şeyi değiştirdiğinde dokümantasyonunuzu modun önceki sürümleriyle uyumluluğu bozmadan güncellemenize olanak tanır.

Paket Dokümantasyonu Bu, mod paketi geliştiricileri için eklenen bir özelliktir. Mod dokümantasyonuyla aynı şekilde dokümantasyon yazmanıza olanak tanır ancak belirli bir moda bağlı değildir ve paket yapılandırmasında yerel olarak saklanır, yani mod paketiyle birlikte gönderilebilir. Mod dokümantasyonundan farklı olarak paket dokümantasyonunda kullanılan görsellerin barındırılması üzerinde hiçbir kontrolüm olmadığını belirtmek gerekir. Bunları imgur.com gibi bir sitede veya kendi özel görsel barındırma sunucusunda barındırmak paket geliştiricisine bağlıdır.

Katkıda Bulunma: PI'nin kendi oyun içi dokümantasyonuna katkıda bulunmakla ilgili ihtiyacınız olan tüm bilgileri bulabilirsiniz.

Kullanıcı tarafından katkıda bulunulan dokümantasyonu kolayca yönetmeyi mümkün kılacak arka uç sisteminin hala covers1624 tarafından geliştirilmekte olduğunu lütfen unutmayın. Dokümantasyonu manuel olarak kabul etme yeteneğim var ancak covers'ın arka ucu bitirmesini beklemenizi öneririm.

Düzenleme: tekrar düşününce covers diğer projelerle biraz meşgul, bu yüzden şimdilik bu manuel bir süreç olarak kalacak.