İçeriğe geç
VORQUL
VorqulBOT / Platform

Eklenti sistemi

Tek bir komut eklemek için çekirdeği çatallamayı gerektiren bir bot modüler değildir. Eklenti sistemi, sunucuya özel mantığın sunucuya özel kalması için vardır.

VorqulBOT, kopyala-yapıştır eklentileri destekler. Eklenti, plugins/ altında bir manifest.json ve varsayılan olarak kendi komutlarını, olaylarını ve isteğe bağlı onLoad ile onUnload kancalarını içeren bir nesne dışa aktaran bir JavaScript giriş dosyası (.js veya .mjs, asla .ts değil) barındıran bir klasördür. Eklentiler başlangıçta, bot giriş yapmadan önce yüklenir. Böylece komutları yerleşik olanlarla birlikte Discord'a kaydedilir ve bot çekirdeğinde hiçbir değişiklik gerekmez.

Dil
JavaScript (ESM), TypeScript'i kendiniz derlersiniz
Manifest
manifest.json
Giriş noktası
.js veya .mjs, varsayılan olarak dışa aktarılan nesne
Yüklenme
Başlangıçta, girişten önce

Bir eklentinin yapısı

Manifest altı alan içerir: name, version, author, description, main ve enabled. main ile belirtilen dosya, eklenti klasörü içinde bir .js veya .mjs dosyası olmalıdır. .ts giriş noktası reddedilir, çünkü bot derlenmiş JavaScript çalıştırır. TypeScript tercih ediyorsanız, dağıtmadan önce .js olarak derleyin.

Giriş dosyası tek bir nesneyi varsayılan olarak dışa aktarır. name dışında her şey isteğe bağlıdır, yani bir eklenti yalnızca komut, yalnızca olay ekleyebilir ya da ikisini de eklemeyebilir. Tek komut ekleyen bir eklenti bir manifest, bir index dosyası ve tek bir komut tanımından oluşur. Yükleyici bunu başlangıçta plugins klasöründen alır.

plugins/
  my_plugin/
    manifest.json
    index.js

// manifest.json
{
  "name": "my_plugin",
  "version": "1.0.0",
  "author": "You",
  "description": "What it does",
  "main": "index.js",
  "enabled": true
}

// index.js
import { SlashCommandBuilder } from 'discord.js';

let ctx;

export default {
  name: 'my_plugin',
  version: '1.0.0',
  commands: [
    {
      data: new SlashCommandBuilder().setName('ping').setDescription('Reply with pong'),
      category: 'plugin',
      execute: async (interaction) => {
        await interaction.reply({ embeds: [ctx.embed.success('Pong', 'Still here.')] });
      }
    }
  ],
  events: [],
  onLoad: (context) => { ctx = context; },
  onUnload: () => {}
};

Bir eklentiye neler verilir

onLoad ve onUnload, çıplak istemci yerine bir eklenti bağlamı alır. Bu bağlam discord.js istemcisini, botun geri kalanının kullandığı embed yardımcısını, ad alanlı bir günlükleyiciyi ve t(key, guildId) çeviri fonksiyonunu taşır. Böylece eklenti kendi i18n'ini getirmeden dokuz arayüz dilinin hepsini konuşabilir.

Ayrıca özel bir veri dizini ile readData ve writeData yardımcılarını da taşır. Bir sayacı ya da listeyi hatırlaması gereken eklenti, veritabanı getirmek veya bot depolamasına uzanmak zorunda kalmaz. src/ ya da dist/ içinden hiçbir şey içe aktarmayın. Bu yollar geliştirme ile dağıtılmış sürüm arasında farklıdır ve bağlam nesnesi bunlara hiç ihtiyaç duymamanız için vardır.

  • client: discord.js istemcisi
  • embed: çekirdeğin kullandığı aynı embed yardımcısı
  • logger: info, warn, error ve debug, eklentiye ait ad alanıyla
  • t(key, guildId, vars): çevrilmiş metinler
  • dataDir, readData, writeData: eklentinin özel depolaması

Ortak modül kaydı

Bot ve panel tek bir modül kaydını okur: src/shared/moduleRegistry.ts içindeki 44 anahtar. Bu, botun uymadığı bir anahtarın panelde var olamayacağı anlamına gelir.

İki yarının zamanla birbirinden kopmasını engelleyen ayrıntı budur. Ayrı bir web arayüzü olan botlarda olağan hata türü tam olarak budur.

Yükleme ve kaldırma

Eklentiler başlangıçta, klasör adına göre alfabetik sırayla, bot giriş yapmadan önce yüklenir. Hatalı bir manifest uyarıyla atlanır ve diğer eklentiler yüklenmeye devam eder. Kapanışta ya da kaldırmada onUnload çalışır ve eklentinin dinleyicileri ile komutları kaldırılır. Yeniden yükleme, dosyayı yeni bir önbellek anahtarıyla içe aktarır. Böylece düzenlemeleriniz, arkada yinelenen dinleyiciler bırakmadan devreye girer.

Bir eklenti devre dışı olarak da dağıtılabilir: manifest içinde enabled değerini false yapın, siz aksini söyleyene kadar yükleyici onu atlar. Dahil gelen sample_plugin bilerek bu şekilde dağıtılır. Bir komut eklemek ya da kaldırmak, Discord'un değişikliği görmesi için yeniden başlatma gerektirir.

Bu sayfadaki terimler

Modül kaydı Webhook imzası Kendi sunucunuzda çalışır

Sık sorulan sorular

İlgili sayfalar