diff --git a/docs/assets/setup/support-bot-2.png b/docs/assets/setup/support-bot-2.png new file mode 100644 index 00000000..f1862f46 Binary files /dev/null and b/docs/assets/setup/support-bot-2.png differ diff --git a/docs/support-bot.md b/docs/support-bot.md index 0766520a..67c16b4a 100644 --- a/docs/support-bot.md +++ b/docs/support-bot.md @@ -1 +1,160 @@ -# Set up your Support-Bot \ No newline at end of file +# Set up your Support Bot + +Easily set up the SCNX Support Bot to offer a professional support experience on your Discord server. Setup takes just a few minutes. + + + +## 0. Pre-Flight Checklist {#step-0} + +Before you get started, make sure that + +* you have [added your server to SCNX](/docs/setup). +* your server has an active paid SCNX plan (Unlimited or Professional). The Support Bot is not available on the free Starter plan. +* you are the owner, a [trusted admin with the Co-Owner permission](/docs/scnx/guilds/trusted-admins), or an administrator of the server you want to enable this feature on. +* you've got a few minutes. Our estimate is that setup takes around two to three minutes on a computer — on mobile it may take a bit longer. Don't stop in the middle; your progress won't be saved. + +## 1. Create your Discord Application & Bot {#step-1} + +:::caution +Do **not reuse** an existing application. You'll need a new application for your Support Bot. SCNX does not support running the Support Bot and Custom-Bot or another third-party bot with the same token / application — please create a new one for each bot. +::: + +First, visit the [Discord Developer Portal](https://discord.com/developers/applications). There, create a new application by clicking on "New Application" on the upper-right side. Enter the name of the application (you can change this later), read & accept the [Discord Developer Terms of Service](https://discord.com/developers/docs/policies-and-agreements/terms-of-service) and the [Discord Developer Policy](https://discord.com/developers/docs/policies-and-agreements/developer-policy) and confirm with "Create". + +![Creating a new application in the Discord Developer Portal](@site/docs/assets/setup/custom-bot-1.png) + +Next, open the "Bot" settings in the navigation bar on the left-hand side. Then click on "Reset token" and confirm your request in the modal. You might get asked to enter a 2FA code for your Discord account. Once done, **copy the token of your bot** — you'll need it in the next step. + +![Copying the bot token from the Discord Developer Portal](@site/docs/assets/setup/custom-bot-3.png) + +:::danger +**Only** paste your token in the SCNX Dashboard. **Never** send a token to another user, trusted admins, or a member of our staff. Treat tokens like a password — users with access to your token are able to use your bot to perform harmful actions. +::: + +## 2. Set up the bot on SCNX {#step-2} + +Open the [Support Bot setup](https://scnx.app/glink?page=support-system/onboarding) on your SCNX Dashboard. You'll be asked to enter the token you obtained in [step 1](#step-1). Paste it and click "Check my token & create bot". SCNX will verify your token and set up hosting — this might take a few seconds. + +If you've already completed the setup, you can access the [Support Bot dashboard](https://scnx.app/glink?page=support-system/manage) instead. + +## 3. Invite the bot to your server {#step-3} + +Before you can configure anything, the bot needs to be on your server. Click the **Invite Bot to Server** button. This will open Discord's OAuth2 authorization screen — select your server, click "Continue", and then "Authorize". + +Once the bot joins your server, the setup will detect it automatically and move to the next step. If the bot isn't detected, click **Retry** or **Invite Bot** again. + +![Discord's OAuth2 authorization screen asking you to select a server and authorize the bot](@site/docs/assets/setup/custom-bot-6.png) + +:::tip +If you run into issues inviting the bot, make sure you have the "Manage Server" permission on your Discord server. +::: + +## 4. Choose your support mode {#step-4} + +You'll be asked: **"How would you like to support your community?"**. You can choose between two systems — or enable both: + +| | Modmail | Ticket System | +|---|---|---| +| **How it works** | Users send a DM to your bot. Messages are relayed between the user's DMs and a private staff channel. | Users click a button in a channel to open a ticket. A new private channel is created for the conversation. | +| **Best for** | Personal, private support conversations | Structured support with multiple categories | +| **Flow** | User DMs Bot → Staff Channel Created → Messages Relayed → Staff Closes → Log Saved | User Clicks Button → Channel Created → Direct Conversation → Ticket Closed → Log Saved | + +Select one or both modes, then click **Continue**. + +![The mode selection screen with cards for Modmail and Ticket System, each showing a description and flow diagram](@site/docs/assets/setup/support-bot-2.png) + +:::info +You can enable both systems — they work great together. Not sure which one to pick? Check the [Feature Comparison](/docs/support-bot/feature-comparison). +::: + +## 5. Configure Modmail {#step-5} + +:::info +This step only appears if you selected **Modmail** in the previous step. If you only selected the Ticket System, skip to [step 6](#step-6). +::: + +In this step, you'll configure the core Modmail settings. You can always change these later in the [Modmail configuration](https://scnx.app/glink?page=support-system/modmail/configuration). + +* **Ticket Category** — select the category on your Discord server where new modmail ticket channels will be created. When a user DMs the bot, a new channel is created inside this category for your staff to respond. +* **Log Channel** — select the channel where closed ticket summaries will be sent. Every time a ticket is closed, a summary with the conversation will be posted here. + +### Info Message (optional) {#modmail-info-message} + +You can optionally post an info message in a channel of your choice to let users know they can DM the bot for support. Toggle this on if you want the bot to automatically post a message like: + +> **Need help?** +> Send a direct message to this bot to open a support ticket. Our team will respond as soon as possible. + +If enabled, you can configure: + +* **Channel** — the channel where the info message will be posted. +* **Message Content** — customize the embed content to match your server's tone. + +Click **Save & Continue** when you're done. + +## 6. Configure the Ticket System {#step-6} + +:::info +This step only appears if you selected **Ticket System** in step 4. If you only selected Modmail, skip to [step 7](#step-7). +::: + +In this step, you'll set up the channel-based ticket system. You can always change these later in the [Ticket System configuration](https://scnx.app/glink?page=support-system/ticket-system/configuration). + +* **Staff Roles** — select the roles that should have access to manage tickets. Members with these roles will be able to see and respond to all ticket channels. +* **Ticket Category** — select the category where new ticket channels will be created. When a user opens a ticket, a private channel is created inside this category. +* **Log Channel** — select the channel where closed ticket summaries will be sent. + +### Ticket Open Message (required) {#ticket-open-message} + +The ticket system requires a message with a button so that users can open tickets. You need to configure: + +* **Channel** — the channel where the "Open Ticket" button will be posted. This is typically a support or help channel visible to all members. +* **Button Label** — the text on the button (default: "Open Ticket"). +* **Message Content** — customize the embed message displayed above the button. The default message is: + +> **Need Support?** +> Click the button below to open a support ticket. Our team will get back to you as soon as possible. + +Click **Save & Continue** when you're done. + +:::caution +You must configure at least one open message channel for the ticket system to work. The setup will highlight this field if it's missing. +::: + +## 7. Advanced features (optional) {#step-7} + +The next screen asks: **"Want to take it further?"**. Here you can optionally set up advanced features to enhance your support experience. You can configure any of these now or come back to them later from the dashboard. + +| Feature | Description | Learn more | +|---|---|---| +| **Ticket Topics** | Categorize tickets by topic for better organization and routing. | [Modmail Topics](/docs/support-bot/modmail/ticket-topics) · [Ticket System Topics](/docs/support-bot/ticket-system/ticket-topics) | +| **Claiming** | Let team members claim tickets to prevent duplicate work. | [Modmail Claiming](/docs/support-bot/modmail/claiming) · [Ticket System Claiming](/docs/support-bot/ticket-system/claiming) | +| **Support Feedback** | Collect star ratings and feedback after tickets are closed. | [Modmail Feedback](/docs/support-bot/modmail/support-feedback) · [Ticket System Feedback](/docs/support-bot/ticket-system/support-feedback) | +| **Forms** | Collect structured information from users when they open a ticket. | [Forms](/docs/support-bot/general/forms) | +| **Opening Hours** | Set when your support team is available, including holidays. | [Opening Hours](/docs/support-bot/general/opening-hours) | +| **Bot Branding** | Customize your bot's footer text and appearance. | [Bot Configuration](/docs/support-bot/general/bot-configuration) | + +Click **Set up** on any feature to configure it, or click **Continue** to skip and finish the setup. + +:::tip +Features you've already configured will show an **"Already configured"** badge. You can always change these settings later from the [dashboard](https://scnx.app/glink?page=support-system/manage). +::: + +## 8. You're all set! {#done} + +Once you've completed the setup, you'll see a confirmation screen showing everything you've configured. Click **Go to Dashboard** to open your [Support Bot management page](https://scnx.app/glink?page=support-system/manage). + +Here are a few things you can do next: + +* Share the [Modmail Starter Guide](/docs/support-bot/modmail/basics) or [Ticket System 101](/docs/support-bot/ticket-system/basics) with your team. +* Set up [ticket topics](https://scnx.app/glink?page=support-system/modmail/ticket-topics) to organize incoming tickets. +* Enable [forms](https://scnx.app/glink?page=support-system/forms) to collect structured information from users. +* Configure [opening hours](https://scnx.app/glink?page=support-system/bot-configuration?show=opening-hours) so users know when your team is available. +* Check out the [analytics dashboard](https://scnx.app/glink?page=support-system/analytics) to track your team's performance. +* Explore all options in the [Support Bot documentation](/docs/support-bot/intro). + +:::tip Running into issues? +We have a [troubleshooting guide](/docs/support-bot/troubleshooting) ready for you. If that didn't help, we're always happy to assist — just visit [scnx.app/help](https://scnx.app/help). +::: diff --git a/i18n/de/docusaurus-plugin-content-docs/current/support-bot.md b/i18n/de/docusaurus-plugin-content-docs/current/support-bot.md new file mode 100644 index 00000000..1d93133a --- /dev/null +++ b/i18n/de/docusaurus-plugin-content-docs/current/support-bot.md @@ -0,0 +1,160 @@ +# Support-Bot einrichten + +Richte den SCNX Support-Bot ein, um ein professionelles Support-Erlebnis auf deinem Discord-Server anzubieten. Die Einrichtung dauert nur wenige Minuten. + + + +## 0. Vorbereitungs-Checkliste {#step-0} + +Bevor du loslegst, stelle sicher, dass + +* du [deinen Server zu SCNX hinzugefügt](/docs/setup) hast. +* dein Server ein aktives kostenpflichtiges SCNX-Abonnement (Unlimited oder Professional) hat. Der Support-Bot ist nicht im kostenlosen Starter-Plan verfügbar. +* du der Besitzer, ein [Trusted-Admin mit der Mitbesitzer-Berechtigung](/docs/scnx/guilds/trusted-admins) oder ein Administrator des Servers bist, auf dem du diese Funktion aktivieren möchtest. +* du einige Minuten Zeit hast. Nach unserer Schätzung dauert die Einrichtung am Computer etwa zwei bis drei Minuten — am Handy könnte es etwas länger dauern. Stoppe nicht mittendrin; dein Fortschritt wird nicht gespeichert. + +## 1. Erstelle deine Discord-Applikation & deinen Bot {#step-1} + +:::caution +Verwende **keine** vorhandene Applikation. Du brauchst eine neue für deinen Support-Bot. SCNX unterstützt das gleichzeitige Verwenden von Support-Bot, Eigenem Bot oder einem weiteren Drittanbieter-Bot mit demselben Token / Applikation nicht — bitte erstelle eine neue für jeden Bot. +::: + +Als Erstes besuche das [Discord-Developer-Portal](https://discord.com/developers/applications). Dort kannst du eine neue Applikation erstellen, indem du auf "New Application" auf der oberen rechten Seite klickst. Gib den Namen der Applikation ein (den kannst du später ändern), lies und stimme den [Discord-Entwickler-Nutzungsbedingungen](https://discord.com/developers/docs/policies-and-agreements/terms-of-service) und der [Discord-Entwickler-Vereinbarung](https://discord.com/developers/docs/policies-and-agreements/developer-policy) zu und bestätige mit "Create". + +![Erstellen einer neuen Applikation im Discord-Developer-Portal](@site/docs/assets/setup/custom-bot-1.png) + +Öffne als Nächstes die "Bot"-Einstellungen in der Navigationsleiste am linken Bildschirmrand. Klicke dann auf "Reset token" und bestätige deine Anfrage im Popup. Möglicherweise wirst du nach einem 2FA-Code für deinen Discord-Account gefragt. Sobald du damit fertig bist, **kopiere den Token deines Bots** — du brauchst diesen im nächsten Schritt. + +![Kopieren des Bot-Tokens im Discord-Developer-Portal](@site/docs/assets/setup/custom-bot-3.png) + +:::danger +Füge deinen Token **nur** im SCNX-Dashboard ein. Sende **niemals** einen Token an einen anderen Nutzer, Trusted Admins oder eines unserer Teammitglieder. Geh mit Tokens wie mit einem Passwort um — Nutzer mit Zugriff auf deinen Token können deinen Bot verwenden, um schädliche Aktionen auszuführen. +::: + +## 2. Bot auf SCNX einrichten {#step-2} + +Öffne die [Support-Bot-Einrichtung](https://scnx.app/de/glink?page=support-system/onboarding) in deinem SCNX-Dashboard. Du wirst aufgefordert, den Token einzugeben, den du in [Schritt 1](#step-1) erhalten hast. Füge ihn ein und klicke auf "Token überprüfen & Bot erstellen". SCNX prüft nun deinen Token und richtet das Hosting ein — das kann einige Sekunden dauern. + +Falls du die Einrichtung bereits abgeschlossen hast, kannst du stattdessen direkt das [Support-Bot-Dashboard](https://scnx.app/de/glink?page=support-system/manage) öffnen. + +## 3. Bot auf deinen Server einladen {#step-3} + +Bevor du etwas konfigurieren kannst, muss der Bot auf deinem Server sein. Klicke auf den **Bot einladen**-Button. Damit öffnest du Discords OAuth2-Autorisierungsseite — wähle deinen Server aus, klicke auf "Weiter" und dann auf "Autorisieren". + +Sobald der Bot deinem Server beitritt, erkennt die Einrichtung dies automatisch und geht zum nächsten Schritt über. Falls der Bot nicht erkannt wird, klicke auf **Erneut versuchen** oder **Bot einladen**. + +![Discords OAuth2-Autorisierungsseite, auf der du deinen Server auswählst und den Bot autorisierst](@site/docs/assets/setup/custom-bot-6.png) + +:::tip +Falls du Probleme beim Einladen des Bots hast, stelle sicher, dass du die "Server verwalten"-Berechtigung auf deinem Discord-Server hast. +::: + +## 4. Support-Modus wählen {#step-4} + +Du wirst gefragt: **"Wie möchtest du deine Community unterstützen?"**. Du kannst zwischen zwei Systemen wählen — oder beide aktivieren: + +| | Modmail | Ticket-System | +|---|---|---| +| **So funktioniert's** | Nutzer senden eine DM an deinen Bot. Nachrichten werden zwischen den DMs des Nutzers und einem privaten Team-Kanal weitergeleitet. | Nutzer klicken auf einen Button in einem Kanal, um ein Ticket zu öffnen. Ein neuer privater Kanal wird für die Konversation erstellt. | +| **Am besten für** | Persönliche, private Support-Gespräche | Strukturierter Support mit mehreren Kategorien | +| **Ablauf** | Nutzer schreibt DM → Team-Kanal erstellt → Nachrichten weitergeleitet → Team schließt → Log gespeichert | Nutzer klickt Button → Kanal erstellt → Direkte Konversation → Ticket geschlossen → Log gespeichert | + +Wähle einen oder beide Modi aus und klicke auf **Weiter**. + +![Der Modus-Auswahlbildschirm mit Karten für Modmail und Ticket-System, jeweils mit Beschreibung und Ablaufdiagramm](@site/docs/assets/setup/support-bot-2.png) + +:::info +Du kannst beide Systeme aktivieren — sie funktionieren hervorragend zusammen. Nicht sicher, welches du wählen sollst? Schau dir den [Feature-Vergleich](/docs/support-bot/feature-comparison) an. +::: + +## 5. Modmail konfigurieren {#step-5} + +:::info +Dieser Schritt erscheint nur, wenn du im vorherigen Schritt **Modmail** ausgewählt hast. Wenn du nur das Ticket-System gewählt hast, springe zu [Schritt 6](#step-6). +::: + +In diesem Schritt konfigurierst du die grundlegenden Modmail-Einstellungen. Du kannst diese jederzeit später in der [Modmail-Konfiguration](https://scnx.app/de/glink?page=support-system/modmail/configuration) ändern. + +* **Ticket-Kategorie** — wähle die Kategorie auf deinem Discord-Server, in der neue Modmail-Ticket-Kanäle erstellt werden. Wenn ein Nutzer dem Bot eine DM schreibt, wird in dieser Kategorie ein neuer Kanal für dein Team erstellt. +* **Log-Kanal** — wähle den Kanal, in den Zusammenfassungen geschlossener Tickets gesendet werden. Jedes Mal, wenn ein Ticket geschlossen wird, wird hier eine Zusammenfassung mit dem Gesprächsverlauf gepostet. + +### Info-Nachricht (optional) {#modmail-info-message} + +Du kannst optional eine Info-Nachricht in einem Kanal deiner Wahl posten, um Nutzer darüber zu informieren, dass sie dem Bot eine DM für Support senden können. Aktiviere diese Option, wenn der Bot automatisch eine Nachricht wie diese posten soll: + +> **Brauchst du Hilfe?** +> Sende eine Direktnachricht an diesen Bot, um ein Support-Ticket zu öffnen. Unser Team wird sich so schnell wie möglich bei dir melden. + +Wenn aktiviert, kannst du konfigurieren: + +* **Kanal** — der Kanal, in dem die Info-Nachricht gepostet wird. +* **Nachrichteninhalt** — passe den Embed-Inhalt an den Ton deines Servers an. + +Klicke auf **Speichern & Weiter**, wenn du fertig bist. + +## 6. Ticket-System konfigurieren {#step-6} + +:::info +Dieser Schritt erscheint nur, wenn du in Schritt 4 das **Ticket-System** ausgewählt hast. Wenn du nur Modmail gewählt hast, springe zu [Schritt 7](#step-7). +::: + +In diesem Schritt richtest du das kanalbasierte Ticket-System ein. Du kannst diese Einstellungen jederzeit später in der [Ticket-System-Konfiguration](https://scnx.app/de/glink?page=support-system/ticket-system/configuration) ändern. + +* **Team-Rollen** — wähle die Rollen aus, die Zugriff auf die Verwaltung von Tickets haben sollen. Mitglieder mit diesen Rollen können alle Ticket-Kanäle sehen und beantworten. +* **Ticket-Kategorie** — wähle die Kategorie, in der neue Ticket-Kanäle erstellt werden. Wenn ein Nutzer ein Ticket öffnet, wird in dieser Kategorie ein privater Kanal erstellt. +* **Log-Kanal** — wähle den Kanal, in den Zusammenfassungen geschlossener Tickets gesendet werden. + +### Ticket-Öffnen-Nachricht (erforderlich) {#ticket-open-message} + +Das Ticket-System benötigt eine Nachricht mit einem Button, über den Nutzer Tickets öffnen können. Du musst Folgendes konfigurieren: + +* **Kanal** — der Kanal, in dem der "Ticket öffnen"-Button gepostet wird. Das ist üblicherweise ein Support- oder Hilfe-Kanal, der für alle Mitglieder sichtbar ist. +* **Button-Beschriftung** — der Text auf dem Button (Standard: "Ticket öffnen"). +* **Nachrichteninhalt** — passe die Embed-Nachricht an, die über dem Button angezeigt wird. Die Standardnachricht ist: + +> **Brauchst du Unterstützung?** +> Klicke auf den Button unten, um ein Support-Ticket zu öffnen. Unser Team wird sich so schnell wie möglich bei dir melden. + +Klicke auf **Speichern & Weiter**, wenn du fertig bist. + +:::caution +Du musst mindestens einen Kanal für die Ticket-Öffnen-Nachricht konfigurieren, damit das Ticket-System funktioniert. Die Einrichtung hebt dieses Feld hervor, falls es fehlt. +::: + +## 7. Erweiterte Funktionen (optional) {#step-7} + +Der nächste Bildschirm fragt: **"Möchtest du noch mehr herausholen?"**. Hier kannst du optional erweiterte Funktionen einrichten, um dein Support-Erlebnis zu verbessern. Du kannst diese jetzt konfigurieren oder später jederzeit über das Dashboard nachholen. + +| Funktion | Beschreibung | Mehr erfahren | +|---|---|---| +| **Ticket-Themen** | Kategorisiere Tickets nach Thema für bessere Organisation und Weiterleitung. | [Modmail-Themen](/docs/support-bot/modmail/ticket-topics) · [Ticket-System-Themen](/docs/support-bot/ticket-system/ticket-topics) | +| **Claiming** | Erlaube Teammitgliedern, Tickets zu beanspruchen, um doppelte Arbeit zu vermeiden. | [Modmail-Claiming](/docs/support-bot/modmail/claiming) · [Ticket-System-Claiming](/docs/support-bot/ticket-system/claiming) | +| **Support-Feedback** | Sammle Sternebewertungen und Feedback nach dem Schließen von Tickets. | [Modmail-Feedback](/docs/support-bot/modmail/support-feedback) · [Ticket-System-Feedback](/docs/support-bot/ticket-system/support-feedback) | +| **Formulare** | Sammle strukturierte Informationen von Nutzern beim Öffnen eines Tickets. | [Formulare](/docs/support-bot/general/forms) | +| **Öffnungszeiten** | Lege fest, wann dein Support-Team verfügbar ist, einschließlich Feiertagen. | [Öffnungszeiten](/docs/support-bot/general/opening-hours) | +| **Bot-Branding** | Passe den Footer-Text und das Erscheinungsbild deines Bots an. | [Bot-Konfiguration](/docs/support-bot/general/bot-configuration) | + +Klicke bei einer Funktion auf **Einrichten**, um sie zu konfigurieren, oder klicke auf **Weiter**, um die Einrichtung abzuschließen. + +:::tip +Funktionen, die bereits konfiguriert sind, zeigen ein **"Bereits konfiguriert"**-Badge an. Du kannst diese Einstellungen jederzeit über das [Dashboard](https://scnx.app/de/glink?page=support-system/manage) ändern. +::: + +## 8. Alles fertig! {#done} + +Sobald du die Einrichtung abgeschlossen hast, siehst du einen Bestätigungsbildschirm, der alles zeigt, was konfiguriert wurde. Klicke auf **Zum Dashboard**, um deine [Support-Bot-Verwaltungsseite](https://scnx.app/de/glink?page=support-system/manage) zu öffnen. + +Hier einige Dinge, die du als Nächstes tun kannst: + +* Teile den [Modmail-Leitfaden](/docs/support-bot/modmail/basics) oder das [Ticket-System 101](/docs/support-bot/ticket-system/basics) mit deinem Team. +* Richte [Ticket-Themen](https://scnx.app/de/glink?page=support-system/modmail/ticket-topics) ein, um eingehende Tickets zu organisieren. +* Aktiviere [Formulare](https://scnx.app/de/glink?page=support-system/forms), um strukturierte Informationen von Nutzern zu sammeln. +* Konfiguriere [Öffnungszeiten](https://scnx.app/de/glink?page=support-system/bot-configuration?show=opening-hours), damit Nutzer wissen, wann dein Team verfügbar ist. +* Schau dir das [Analytics-Dashboard](https://scnx.app/de/glink?page=support-system/analytics) an, um die Leistung deines Teams zu verfolgen. +* Entdecke alle Optionen in der [Support-Bot-Dokumentation](/docs/support-bot/intro). + +:::tip Es läuft nicht alles wie geplant? +Wir haben einen [Leitfaden zur Fehlerbehebung](/docs/support-bot/troubleshooting) für dich. Wenn das nicht geholfen hat, sind wir immer da, um zu helfen — besuche einfach [scnx.app/de/help](https://scnx.app/de/help). +:::