Skip to content

Create invite-tracking.md #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 10 additions & 15 deletions docs/modmail.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,20 @@
# Setup your Modmail-Bot
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are edits to an original file! Please revert them!

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I hadn't actually committed/edited this, no idea how the commit got in here...
Should I now recommit the entire original text?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert the commit, ideally using git revert a935a6042b58973d425c26dd0e45e60668ecdaad

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can I also simply copy the original text (in Markdown), then paste it into the (unintentionally) edited file and commit it?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please avoid doing that, reverting is likely easier.

Copy link
Author

@mrt2010 mrt2010 May 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, if you tell me how to do that 😅
So you've already written me the command, but where to execute it (Windows cmd probably), is there anything else to consider?
Why have I now requested a re-request review...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think I can give you a git tutorial via review comments, here's a detailed guide about how to use git on your device:
https://git-scm.com/book/de/v2
If you use something like Visual Studio Code or Webstorm, it might have a git integration where you can revert via the user interface.

# Einrichtung deines Modmail-Bots

Set up the world's most advanced Modmail-Bot in just a few minutes.
Richte den fortschrittlichsten Modmail-Bot der Welt in nur wenigen Minuten ein.

<IncludedInPlan data={{PROFESSIONAL: true, UNLIMITED: true, STARTER: false}} additionalDetails={{
UNLIMITED: "Hosted 24/7, as long as your plan is active.",
PROFESSIONAL: "Hosted 24/7, as long as your plan is active."}} />

## 0. Pre-Flight-Checklist 🛫 {#step-0}
## 0. Checkliste 🛫 {#step-0}

Before you can create your own Modmail on SCNX, please make sure that
Bevor du deinen Modmail-Bot auf SCNX einrichtest, beachte bitte folgende Dinge:

* you have [added your Server to SCNX](/docs/setup).
* your server has the paid [Unlimited](/docs/scnx/guilds/plans) (<PlanPrice plan="UNLIMITED" type="MONTHLY"/>)
or [Professional](/docs/scnx/guilds/plans) (<PlanPrice plan="PROFESSIONAL" type="MONTHLY"/>) plan, or consider using a free trial, if
available for you.
* you are the owner of the server you want to enable this feature
on ([why?](/docs/scnx/guilds/trusted-admins#troubleshooting)) - if you are not the owner, please ask them to enable this
feature for you and grant you access as a [Trusted Admin](/docs/scnx/guilds/trusted-admins).
* you've got a few minutes time (our estimate is that this takes around two minutes to finish on a computer, on mobile
it may take
a bit longer) to finish this guide - don't stop in the middle; your progress won't be saved.
* Du hast deinen [Server zu SCNX hinzugefügt](/docs/setup).
* Dein Server besitzt einen [Unlimited](/docs/scnx/guilds/plans) (<PlanPrice plan="UNLIMITED" type="MONTHLY"/>)
oder [Professional](/docs/scnx/guilds/plans) (<PlanPrice plan="PROFESSIONAL" type="MONTHLY"/>) Plan (oder nutzt die 14-tägige Testphase, falls verfügbar).
* Du bist der Eigentümer dieses Servers ([weitere Informationen](/docs/scnx/guilds/trusted-admins#troubleshooting)) - falls dies nicht der Fall sein sollte, bitte den Eigentümer dieses Feature zu aktivieren und dich als [Trusted Admin](/docs/scnx/guilds/trusted-admins) hinzuzufügen.
Copy link
Preview

Copilot AI May 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Consider rephrasing for grammatical correctness, for example: '...bitte den Eigentümer bitten, dieses Feature zu aktivieren und dich als [Trusted Admin] hinzuzufügen.'

Suggested change
* Du bist der Eigentümer dieses Servers ([weitere Informationen](/docs/scnx/guilds/trusted-admins#troubleshooting)) - falls dies nicht der Fall sein sollte, bitte den Eigentümer dieses Feature zu aktivieren und dich als [Trusted Admin](/docs/scnx/guilds/trusted-admins) hinzuzufügen.
* Du bist der Eigentümer dieses Servers ([weitere Informationen](/docs/scnx/guilds/trusted-admins#troubleshooting)) - falls dies nicht der Fall sein sollte, bitte den Eigentümer, dieses Features zu aktivieren und dich als [Trusted Admin](/docs/scnx/guilds/trusted-admins) hinzuzufügen.

Copilot uses AI. Check for mistakes.

* Du wirst nur ungefähr zwei Minuten brauchen, um die Einrichtung abzuschließen (am Smartphone eventuell etwwas länger) - bitte höre zwischendurch nicht auf, da dein Fortschritt nicht gespeichert wird.

## 1. Create your Discord-Application & -Bot 🤖 {#step-1}

Expand Down Expand Up @@ -119,4 +114,4 @@ Here are a few things you can do now:
* try your Modmail: Send it a DM and observe how it opens a ticket for your team to answer.
* [configure](/docs/modmail/configuration) and enable more Modmail features.
* level up your support system by discovering [advanced Modmail features](/docs/modmail/advanced-features).
* and much more, open the [Modmail Documentation](/docs/modmail/intro) to view every option.
* and much more, open the [Modmail Documentation](/docs/modmail/intro) to view every option.
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Invite-Tracking

Überprüfe, wer wen eingeladen hat

<ModuleOverview moduleName="invite-tracking" />

:::warning Informationen zu Vorschriften
Die Verwendung dieses Moduls, um Nutzer für das Einladen anderer Nutzer zu belohnen, verstößt gegen die [Discord Entwickler-Richtlinien](https://discord.com/developers/docs/policies-and-agreements/developer-policy) und unsere [Nutzungsbedingungen](https://scootk.it/scnx-tos).
Verstöße werden dazu führen, dass dein Server und Account von SCNX gebannt werden. Missbrauch kannst du an [[email protected]](mailto:[email protected]) melden.
:::

## Funktionen {#features}

* Verfolge die Beitritte neuer Nutzer, wer sie eingeladen hat und entferne bei Bedarf die Einladung mit nur einem Klick auf den Button unter der Nachricht.
* Verfolge die Einladungs-Aktivitäten eines Nutzers, einschließlich:
* wer den Nutzer eingeladen hat.
* wen der Nutzer eingeladen hat.
* welche Einladungen der Nutzer erstellt hat.
* Entferne alle erstellten Einladungen eines Nutzers.
* Unterscheidet zwischen aktiven Einladungen und Einladungen, bei denen der eingeladene Benutzer den Server bereits verlassen hat.
* Arbeitet mit den Modulen [Info-Befehle](/de/docs/custom-bot/modules/moderation/info-commands) und [Moderation & Sicherheit](/de/docs/custom-bot/modules/moderation) zusammen.

## Einrichtung {#setup}

* Stelle sicher, dass der Bot auf deinem Server die Berechtigung "Einladungen verwalten" besitzt.
* Aktiviere das Modul, um Einladungen zu verfolgen - möglicherweise musst du deinen Bot anschließend einmal neustarten.
* Lege die [Berechtigungen](/de/docs/custom-bot/slash-commands) für den [`/trace-invites`](#commands)-Befehl fest, um dich vor unberechtigtem Zugriff zu schützen.
* Um neue Beitritte zu verfolgen, lege einen Log-Kanal in deiner [Konfiguration](#configuration) fest - stelle sicher, dass der Bot in diesem Kanal die Berechtigung "Nachrichten senden" besitzt.
Beachte, dass jeder Nutzer, welcher auf deinem Server die Berechtigung "Einladungen verwalten" besitzt, in der Lage ist, Einladungen mit einem Klick auf den Button unter der Log-Nachricht zu entfernen.

## Verwendung {#usage}

* Wenn [konfiguriert](#configuration) wird der Bot im Log-Kanal feststellen, wer den Nutzer eingeladen hat.
* Der Bot wird automatisch Einladungs-Daten über jeden beigetretenen Nutzern speichern.
* Um dir die Einladungs-Aktivitäten (von welchem Nutzer eingeladen, welche Nutzer eingeladen, wie viele Einladungen erstellt, ...) anzusehen, führe den Befehl [`/trace-invites`](#commands) aus.
* Um alle Einladungen eines Nutzers zu entfernen, führe den Befehl [`/trace-invites`](#commands) aus und klicke auf den Button "Alle Einladungen dieses Nutzers entfernen" unter der Nachricht.
* Wenn dieses Modul aktiviert ist, werden andere Module (wie [Info-Befehle](/de/docs/custom-bot/modules/moderation/info-commands) und [Moderation & Sicherheit](/de/docs/custom-bot/modules/moderation)) automatisch Daten über erfasste Einladungen nutzen, um die Funktionalität zu verbessern.

## Befehle {#commands}

<SlashCommandExplanation />

| Befehl | Beschreibung |
|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `/trace-invites user:<User>` | Dieser Befehl zeigt dir die Einladungs-Aktivitäten eines Nutzers. Du erhältst Informationen wie: wer den Nutzer eingeladen hat, wen der Nutzer eingeladen hat und wie viele Einladungen der Nutzer erstellt hat. Außerdem steht dir ein Button zur Verfügung, welcher dir erlaubt, alle Einladungen eines Nutzers zu entfernen. |

## Konfiguration {#configuration}

Nutze diese Konfiguration, um einen Log-Kanal festzulegen - [öffne die Seite in deinem Dashboard](https://scnx.app/de/glink?page=bot/configuration?query=invit&file=invite-tracking|config).

| Feld | Beschreibung |
|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Log-Kanal | Lege hier deinen Log-Kanal fest. Jedes Mal, wenn ein neuer Nutzer deinem Server beitritt, wird der Bot den Einladungslink speichern. Unter der Nachricht befindet sich zudem ein Button, mit welchem du die Einladung entfernen kannst (kann von jedem Nutzer ausgeführt werden, der die Berechtigung "Einladungen verwalten" besitzt). |

## Fehlerbehebung {#troubleshooting}

Wenn Fehler bei dem Modul auftreten, stelle sicher, dass:

* der Bot auf deinem Server die Berechtigung "Einladungen verwalten" besitzt.
* du deinen Bot nach Aktivierung des Moduls und/oder der Berechtigung "Einladungen verwalten" neugestartet hast.
* der Bot die Berechtigungen "Nachrichten senden" und "Links einbetten" im [konfigurierten](#configuration) Log-Kanal besitzt.
* du keine Informationen über einen Nutzer mit nicht verfolgter Einladung anforderst - der Bot ist nur in der Lage Daten von Nutzer zu speichern, nachdem das Modul aktiviert wurde.

## Gespeicherte Daten {#data-usage}

Wenn neue Nutzer deinem Server beitreten und das Modul aktiviert ist, werden folgende Daten gespeichert:

* Eine eindeutige Zahl zur Identifizierung in der Datenbank.
* Die ID des beigetretenen Nutzers.
* Ob der Nutzer den Server in der Zwischenzeit verlassen hat.
* Den Code des Einladungslinks.
* Die Art der Einladung (z.B. Vanity-Einladung).
* Die ID des Nutzers, welcher den Einladungslink erstellt hat, mit welchem der neue Nutzer beigetreten ist.
* Metadaten über den Eintrag (Datum der Erstellung und der letzten Aktualisierung).

Wenn ein Nutzer deinen Server verlässt, wird der Einladungs-Eintrag nicht gelöscht, sondern nur als "Inaktiv" markiert.

Um einen Missbrauch der Daten zu verhindern, können die gespeicherten Daten nicht fallspezifisch gelöscht werden.
Stattdessen kanst du die [Modul-Datenbank bereinigen](/de/docs/custom-bot/additional-features#reset-module-database), um alle gespeicherten Daten über Einladungen zu löschen.
Copy link
Preview

Copilot AI May 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a typo in 'kanst'; it should be corrected to 'kannst'.

Suggested change
Stattdessen kanst du die [Modul-Datenbank bereinigen](/de/docs/custom-bot/additional-features#reset-module-database), um alle gespeicherten Daten über Einladungen zu löschen.
Stattdessen kannst du die [Modul-Datenbank bereinigen](/de/docs/custom-bot/additional-features#reset-module-database), um alle gespeicherten Daten über Einladungen zu löschen.

Copilot uses AI. Check for mistakes.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh well, there's actually a spelling mistake hidden in there...