Was ist ein Plugin?
Ein Plugin ist ein kleines JavaScript-Programm, das TBot erweitert: Es kann eigene Commands anlegen (mit dem Server-Prefix, z. B. !hallo) und auf Ereignisse reagieren, etwa neue Nachrichten oder neue Mitglieder. Plugins laufen abgeschottet in einer Sandbox auf dem Bot-Server – nie auf deinem PC und nie mit Zugriff auf den Bot-Token.
Dateiformate
Eine einzelne Datei
Perfekt für kleine Plugins. Bis 1 MB.
Ein Paket
Mit plugin.json und .js-, .json-, .md- oder .txt-Dateien. Bis 1 MB gepackt, 3 MB entpackt, 60 Dateien, 512 KB pro Datei.
module.exports und require(). ES-Module (import / export) lehnt der Scan ab.plugin.json
Nur in ZIP-Paketen nötig. Sie beschreibt dein Plugin und nennt die Startdatei.
| Feld | Bedeutung |
|---|---|
name | Name des Plugins |
version | Version, z. B. 1.0.0 |
description | Kurze Beschreibung |
main | Startdatei, meist index.js |
Grundgerüst
Deine Startdatei exportiert eine Funktion. TBot ruft sie einmal mit dem tasty-Objekt auf, über das du Commands und Events anmeldest.
| Funktion | Beschreibung |
|---|---|
tasty.command(name, description, handler) | Meldet einen Command an. Name: Kleinbuchstaben, Ziffern, - und _, max. 32 Zeichen. Aufruf mit dem Server-Prefix, z. B. !name. |
tasty.on(event, handler) | Reagiert auf ein Event: message, memberJoin oder memberLeave. |
Das ctx-Objekt
Jeder Handler bekommt ctx – alles zum aktuellen Ereignis plus die Methoden zum Antworten.
Eigenschaften
| Eigenschaft | Verfügbar bei | Inhalt |
|---|---|---|
ctx.guild | allen | { id, name, memberCount } |
ctx.user | allen | { id, username, name, bot, avatar, roles: [{ id, name }], isAdmin, canManageServer, canManageMessages } |
ctx.channel | command, message | { id, name } |
ctx.message | command, message | { id, content } |
ctx.command | command | Name des Commands |
ctx.args | command | Wörter nach dem Command als Array |
ctx.argsText | command | Alles nach dem Command als Text |
ctx.member | memberJoin, memberLeave | Das Mitglied, das gekommen oder gegangen ist |
Methoden
Alle Methoden geben ein Promise zurück – nutze await.
| Methode | Beschreibung |
|---|---|
ctx.reply(msg) | Antwortet auf die Nachricht (command, message) |
ctx.send(msg) | Sendet in denselben Kanal (command, message) |
ctx.react(emoji) | Reagiert auf die Nachricht (command, message) |
ctx.sendTo(channel, msg) | Sendet in einen Kanal per ID oder Name, z. B. 'willkommen' |
ctx.storage | Speichert Daten pro Server, siehe Speicher |
Nachrichten & Embeds
msg ist entweder einfacher Text (bis 2000 Zeichen) oder ein Objekt mit content und einem embed:
- Farbe als Hex, z. B.
'#4DD4E6' - Bilder (
image,thumbnail) nur alshttps://-Link - Erwähnungen von
@everyone,@hereund Rollen werden blockiert
Slash-Commands
Mit tasty.slash() bekommt dein Plugin echte Discord-Slash-Commands mit Optionen. Sie werden auf jedem Server, der das Plugin installiert, automatisch registriert (es kann ein paar Sekunden dauern, bis Discord sie anzeigt). Bis zu 10 pro Plugin; Namen von eingebauten TBot-Commands sind nicht möglich.
tasty.slash({
name: 'umfrage',
description: 'Startet eine Umfrage',
options: [
{ name: 'frage', description: 'Was willst du fragen?', type: 'string', required: true, max: 200 },
{ name: 'kanal', description: 'Wo posten?', type: 'channel' },
],
permission: 'ManageMessages', // optional: nur sichtbar mit diesem Recht
ephemeral: false, // "denkt nach …" nur für die Person sichtbar?
run: async (ctx) => {
const ziel = ctx.options.kanal?.id || ctx.channel.id;
await ctx.sendTo(ziel, { embed: { title: 'Umfrage', description: ctx.options.frage } });
await ctx.reply('Umfrage gepostet!', { ephemeral: true });
},
});
// Mit Unter-Commands: /todo neu text:… und /todo liste
tasty.slash({
name: 'todo',
description: 'Deine To-do-Liste',
subcommands: [
{ name: 'neu', description: 'Eintrag hinzufügen', options: [{ name: 'text', description: 'Was?', type: 'string', required: true }] },
{ name: 'liste', description: 'Alle Einträge' },
],
run: async (ctx) => {
if (ctx.subcommand === 'neu') { /* ctx.options.text … */ }
},
});
- Options-Typen:
string,integer,number,boolean,user,channel,role– dazuchoices,min,max - In
ctx.optionsstehen die Werte nach Namen; Nutzer/Kanal/Rolle kommen als{ id, name }.ctx.subcommand: gewählter Unter-Command - Mit
ctx.reply(msg, { ephemeral: true })sieht nur diese Person die Antwort. Antwortest du nicht innerhalb von 2 s, zeigt TBot für dich „denkt nach …“ - Für
permissiongehen:Administrator,ManageGuild,ManageMessages,ManageRoles,ManageChannels,KickMembers,BanMembers,ModerateMembers
Speicher
Mit ctx.storage speicherst du JSON-Daten – getrennt für jeden Server. Ideal für Zähler, Einstellungen oder Listen.
| Methode | Beschreibung |
|---|---|
await ctx.storage.get(key) | Liest einen Wert (oder null) |
await ctx.storage.set(key, value) | Speichert einen JSON-Wert |
await ctx.storage.delete(key) | Löscht einen Wert |
await ctx.storage.keys() | Listet alle Schlüssel |
Limits: bis 200 Schlüssel pro Server, 4 KB pro Wert. Wird das Plugin auf einem Server entfernt, werden seine Daten dort gelöscht.
Erlaubte Module
require() funktioniert für eigene Dateien (./helfer.js, ./daten.json) und diese eingebauten Node-Module:
utileventsurlquerystringassertbufferstring_decodertimerscryptopath
Alles andere – z. B. fs, http, net, child_process oder npm-Pakete – ist gesperrt. console.log und console.error landen in deinen Plugin-Logs.
Sandbox-Limits
Jedes Plugin läuft in einem eigenen Prozess mit strengen Regeln. So bleibt jeder Server sicher – auch wenn ein Plugin einen Fehler hat.
eval und kein new FunctionSicherheits-Scan
Jeder Upload wird geprüft, bevor er im Market landet. Der Scan lehnt ab:
- Verschlüsselte Dateien oder ZIPs mit Passwort
- Andere Archive (RAR, 7z, GZip)
- Programme und Binärdaten
- Verschleierten oder minifizierten Code
- Lange kodierte Datenblöcke (z. B. Base64)
- Gesperrte Module
- ES-Module (
import/export) - Syntaxfehler
Tipp: Schreib lesbaren Code mit klaren Namen – dann hat der Scan nichts zu meckern.
Beispiele
1. Hallo-Command
Mit !hallo Max antwortet der Bot mit einem Gruß – als Embed.
2. Willkommensnachricht
Begrüßt neue Mitglieder im Kanal #willkommen mit sendTo.
3. Zähler mit Speicher
Zählt Nachrichten pro Server und zeigt den Stand mit !zaehler.
