Skip to content

Update docs due beta update / info-commands.md English update #75

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.

Sign up for GitHub

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 10 commits into
base: main
Choose a base branch
from
Open

Update docs due beta update / info-commands.md English update #75

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f9d9748
[EN] Update levels.md (V1)
mrt2010 Aug 1, 2025
bb2ae5d
[EN] Update partner-list.md (V1)
mrt2010 Aug 1, 2025
7108fb9
[DE] Update partner-list.md (V1)
mrt2010 Aug 1, 2025
9defc14
[EN] Update partner-list.md (V2)
mrt2010 Aug 1, 2025
c85fc28
[DE] Update levels.md (V1)
mrt2010 Aug 1, 2025
6fd9998
[EN] Update partner-list.md (V3)
mrt2010 Aug 2, 2025
ee97966
[EN] Update levels.md (V2)
mrt2010 Aug 2, 2025
d9dfe54
[EN] Update partner-list.md (V4)
mrt2010 Aug 2, 2025
3e73094
[DE] Update partner-list.md (V2)
mrt2010 Aug 2, 2025
202e75f
[EN] Update info-commands.md (V1)
mrt2010 Aug 4, 2025
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
16 changes: 7 additions & 9 deletions docs/custom-bot/modules/administration/partner-list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Here's an example of a partner-list (you can customize appearance):

* Please [set up permissions](/docs/custom-bot/slash-commands) for Slash-Commands to avoid unauthorized usage of them.
* Then, configure the partner-list:
1. Create a channel in which the bot should send the partner-list. This channel needs to be empty, and the bot has
1. Create a channel in which the bot should send the partner-list. The bot has
to have the "View channel", "View message history" and "Send message" permissions on it.
2. Open the [Module configuration](https://scnx.app/glink?page=bot/configuration?file=partner-list%7Cconfig)
and [configure the module](#configuration).
Expand Down Expand Up @@ -52,12 +52,12 @@ your [dashboard](https://scnx.app/glink?page=bot/configuration?file=partner-list

| Field | Description |
|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Channel | This is the channel in which the Partner-List will be sent. If the bot had already sent a message in the past, the latest message will get edited to the Partner-List. We recommend an empty channel. |
| Channel | This is the channel in which the Partner-List will be sent. If the bot had already sent a message in the past, the latest message will get edited to the Partner-List. |
| Partner-List-Embed | This is the configuration of the partner-list. |
| Partner-List-Embed: title | Title of the Partner-List-Embed. |
| Partner-List-Embed: description | Description of the Partner-List-Embed. |
| Partner-List-Embed: partner-string | This is the format of a partner displayed in the Partner-List-Embed. You can find availible parameters in the [Dashboard](https://scnx.app/glink?page=bot/configuration?file=partner-list%7Cconfig). |
| Partner-List-Embed: color | This will be the color of the Partner-List-Embed. Must be a [HEX-Color or supported color value](/docs/custom-bot/additional-features#embed-colors). |
| Partner-List-Embed: color | This will be the color of the Partner-List-Embed. |
| Categories | These are the categories that partners can be assigned to. Each category needs to be unique. Only these categories can be selected via commands. |
| Category-Roles | These are the roles that will get assigned to new partners and removed from deleted partners.<br />First field: Category-Name (case-sensitive)<br/>Second field: ID of the role |
| Send Partner-Notifications | If enabled, partners will be sent a message when they get added or removed. |
Expand All @@ -67,21 +67,19 @@ your [dashboard](https://scnx.app/glink?page=bot/configuration?file=partner-list
## Troubleshooting {#troubleshooting}

<details>
<summary>The Partner-List is not appearing in the configured channel</summary>
<summary>The Partner-List is not appearing in the configured channel or not updating correctly.</summary>
<ul>
<li>Make sure the desired channel is empty.</li>
<li>Make sure bot has "View channel", "Send messages" and "View message history" permissions on the channel.</li>
<li>Make sure non of your category fields are empty.</li>
<li>Make sure you supplied a <a href="/docs/custom-bot/additional-features#embed-colors">correct color value</a> in your configuration.</li>
<li>Make sure that the message is no longer than 1024 characters.</li>
<li>Restart your bot.</li>
</ul>
</details>

<details>
<summary>Can I restart the ID counter?</summary>

No. The ID is an unique identification number and can not be reset. This is a technical limitation - you can remove the <code>%id%</code> parameter from your "partner-string" under "Partner-List-Embed" in your <a href="https://scnx.app/glink?page=bot/configuration?file=partner-list%7Cconfig">module configuration</a>, if this is annoying you.
</details>
No. The ID is an unique identification number and can not be reset. This is a technical limitation - you can remove the <code>%id%</code> parameter from your "partner-string" under "Partner-List-Embed" in your <a href="https://scnx.app/glink?page=bot/configuration?file=partner-list%7Cconfig">module configuration</a> or replace it with the <code>%nr%</code> parameter, which automatically updtaes the numbers.

## Stored data {#data-usage}

Expand All @@ -95,4 +93,4 @@ The following data is being stored about every partner created via [commands](#c
* Metadata about the entry (date when created and last updated)

To delete stored data, use [`/partner delete`](#commands)
or [purge the module database](/docs/custom-bot/additional-features#reset-module-database).
or [purge the module database](/docs/custom-bot/additional-features#reset-module-database).
14 changes: 7 additions & 7 deletions docs/custom-bot/modules/community/levels.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,12 @@ Easy to use levelling system with a lot of customization!
### Live leaderboard {#live-leaderboard}

Instead of having your users run [`/leederboard`](#commands) every time they want to see the users with the most levels,
you can enable a Live Leaderboard. This is a channel with exactly one message in it, which will be updated to the
you can enable a Live Leaderboard. This is a channel with a message in it, which will be updated to the
current leaderboard every five minutes. This means that users won't have to run any commands or visit a webpage to see
the top 15 users in their server. They can also click on "Show my level" to view their own level, instead of executing
the best users in their server. They can also click on "Show my level" to view their own level, instead of executing
the [`/profile`](#commands) command. The response will only be visible to the user themselves.

To enable the live leaderboard, set the "Live Leaderboard Channel" in your [configuration](#configuration) to any empty
To enable the live leaderboard, set the "Live Leaderboard Channel" in your [configuration](#configuration) to a
channel on your server on which the bot has the Send Message, View Message History and View Channel permissions. For the
best results, set up your channel in a way in which users won't be able to send messages into this channel. Once
configured, [reload your configuration](/docs/scnx/guilds/bots/#basics) and the bot will send a message into the channel
Expand Down Expand Up @@ -404,10 +404,10 @@ XP can be given as the bot can't see the message / voice channel.
</details>

<details>
<summary>My live leaderboard is not being sent correctly.</summary>
<summary>My live leaderboard is not being sent or update correctly.</summary>

The [live leaderboard](#live-leaderboard) can only be sent if the bot has the "View channel", "View message history"
and "Send messages" permission on the configured leaderboard channel. The channel also has to be empty of the live leaderboard embed to be sent and kept up to date.
The [live leaderboard](#live-leaderboard) can only be sent if the bot has the permissions ‘View channel’, "
View message history‘ and ’Send messages" in the configured leaderboard channel. Also, make sure that the message is no longer than 1024 characters. Otherwise, set the value ‘Maximum number of users in the live leaderboard channel’ to a lower value in the [configuration](#configuration).
</details>

## Stored data {#data-usage}
Expand All @@ -423,4 +423,4 @@ The following data is being stored about every user who sent at least one eligib
You can delete the data about a user by using the [`/manage-levels reset-xp`](#manage-levels) command with the `user`
parameter. To delete all data about every user, use the command without the `user` parameter.
Alternatively, to remove all data stored by this
module, you can also [purge the module database](/docs/custom-bot/additional-features#reset-module-database).
module, you can also [purge the module database](/docs/custom-bot/additional-features#reset-module-database).
15 changes: 7 additions & 8 deletions ...s-plugin-content-docs/current/custom-bot/modules/administration/partner-list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,10 @@ Hier ist ein Beispiel einer Partner-Liste (Du kannst das Erscheinungsbild anpass

* Bitte [richte die Berechtigungen für Slash-Befehle](/docs/custom-bot/slash-commands) ein, um deren unbefugte Nutzung zu verhindern.
* Konfiguriere anschließend die Partner-Liste:
1. Erstelle einen Kanal, in den der Bot die Partner-Liste senden soll. Dieser Kanal muss leer sein, und der Bot muss über die Berechtigungen „Kanal anzeigen“, „Nachrichtenverlauf anzeigen“ und „Nachrichten senden“ verfügen.
1. Erstelle einen Kanal, in den der Bot die Partner-Liste senden soll. Der Bot muss über die Berechtigungen „Kanal anzeigen“, „Nachrichtenverlauf anzeigen“ und „Nachrichten senden“ verfügen.
2. Öffne die [Modul-Konfiguration](https://scnx.app/de/glink?page=bot/configuration?file=partner-list%7Cconfig)
und [konfiguriere das Modul](#configuration).
3. Lade die Konfiguration deines Bots neu, um die Änderungen zu übernehmen – der Bot sendet automatisch eine Partner-Liste.
4. Lade die Konfiguration deines Bots neu, um die Änderungen zu übernehmen – der Bot sendet automatisch eine Partner-Liste.

## Verwendung {#usage}

Expand Down Expand Up @@ -57,29 +56,29 @@ deinem [Dashboard](https://scnx.app/de/glink?page=bot/configuration?file=partner
| Partner-Liste-Embed: Titel | Titel des Partner-Listen-Embeds. |
| Partner-Liste-Embed: Beschreibung | Beschreibung des Partner-Listen-Embeds. |
| Partner-Liste-Embed: Partner-String | Dies ist das Format eines Partners, der in dem Partner-Listen-Embed angezeigt wird. Verfügbare Parameter findest du im [Dashboard](https://scnx.app/de/glink?page=bot/configuration?file=partner-list%7Cconfig). |
| Partner-Liste-Embed: Farbe | Dies ist die Farbe der Partner-Listen-Embeds. Es muss eine [HEX-Farbe oder ein unterstützter Farbwert](/docs/custom-bot/additional-features#embed-colors) sein. |
| Partner-Liste-Embed: Farbe | Dies ist die Farbe der Partner-Listen-Embeds. |
| Kategorien | Dies sind die Kategorien, denen Partner zugeordnet werden können. Jede Kategorie muss anders sein. Nur diese Kategorien können über Befehle ausgewählt werden. |
| Kategorie-Rollen | Dies sind die Rollen, die neuen Partnern zugewiesen und von gelöschten Partnern entfernt werden.<br />Erstes Feld: Kategoriename (Groß-/Kleinschreibung beachten)<br/>Zweites Feld: ID der Rolle |
| Partner-Benachrichtigung senden | Wenn diese Option aktiviert ist, wird den Partnern eine Nachricht gesendet, wenn sie hinzugefügt oder entfernt werden. |
| Partner-Willkommens-PN | <i>Nur sichtbar, wenn „Partner-Benachrichtigung senden“ aktiviert ist.</i><br/>Diese Nachricht wird an den Partner gesendet, wenn dieser hinzugefügt wird. |
| Partner-Entfernung-PN | <i>Nur sichtbar, wenn „Partner-Benachrichtigung senden“ aktiviert ist.</i><br/>Diese Nachricht wird an den Partner gesendet, wenn dieser entfernt wird. |

## Fehlerbehebung {#troubleshooting}

<details>
<summary>Die Partner-Liste wird nicht im konfigurierten Kanal angezeigt</summary>
<summary>Die Partner-Liste wird nicht im konfigurierten Kanal angezeigt oder korrekt aktualisiert.</summary>
<ul>
<li>Stelle sicher, dass der gewünschte Kanal leer ist.</li>
<li>Stelle sicher, dass der Bot über die Berechtigungen „Kanal anzeigen“, „Nachrichten senden“ und „Nachrichtenverlauf anzeigen“ für den Kanal verfügt.</li>
<li>Stelle sicher, dass keiner deiner Kategoriefelder leer ist.</li>
<li>Stelle sicher, dass du in der Konfiguration einen <a href="/de/docs/custom-bot/additional-features#embed-colors">richtigen Farbwert</a> angegeben hast.</li>
<li>Stelle sicher, dass die Nachricht nicht länger als 1024 Zeichen lang ist.</li>
<li>Starte deinen Bot neu.</li>
</ul>
</details>

<details>
<summary>Kann ich den ID-Counter neu starten?</summary>

Nein. Die ID ist eine eindeutige Identifikationsnummer und kann nicht zurückgesetzt werden. Dies ist eine technische Einschränkung – du kannst den Parameter <code>%id%</code> aus deinem „partner-string“ unter „Partner-Liste-Embed“ in deiner <a href="https://scnx.app/de/glink?page=bot/configuration?file=partner-list%7Cconfig">Modulkonfiguration</a> entfernen, falls dich das stört.
Nein. Die ID ist eine eindeutige Identifikationsnummer und kann nicht zurückgesetzt werden. Dies ist eine technische Einschränkung – du kannst den Parameter <code>%id%</code> aus deinem „partner-string“ unter „Partner-Liste-Embed“ in deiner <a href="https://scnx.app/de/glink?page=bot/configuration?file=partner-list%7Cconfig">Modulkonfiguration</a> entfernen oder das Parameter <code>%nr%</code> verwenden, wodurch die Nummern autoamtisch aktualisert werden.
</details>

## Gespeicherte Daten {#data-usage}
Expand All @@ -94,4 +93,4 @@ deinem [Dashboard](https://scnx.app/de/glink?page=bot/configuration?file=partner
* Metadaten zum Eintrag (Datum der Erstellung und letzten Aktualisierung)

Um gespeicherte Daten zu löschen, verwende [`/partner delete`](#commands)
oder [lösche die Moduldatenbank](/docs/custom-bot/additional-features#reset-module-database).
oder [lösche die Moduldatenbank](/docs/custom-bot/additional-features#reset-module-database).
13 changes: 6 additions & 7 deletions ...e/docusaurus-plugin-content-docs/current/custom-bot/modules/community/levels.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,14 @@ Einfach zu bedienendes Level-System mit vielen Anpassungsmöglichkeiten!
### Live-Rangliste {#live-leaderboard}

Anstatt deine Nutzer jedes Mal [`/leaderboard`](#commands) ausführen zu lassen, wenn sie die Nutzer mit den meisten
Leveln sehen wollen, kannst du eine Live-Rangliste aktivieren. Dies ist ein Kanal mit genau einer Nachricht darin, die
Leveln sehen wollen, kannst du eine Live-Rangliste aktivieren. Dies ist eine Nachricht, welche
alle fünf Minuten auf die aktuelle Rangliste aktualisiert wird. Das bedeutet, dass Nutzer keine Befehle ausführen oder
eine Webseite besuchen müssen, um die Top-15-Nutzer auf deinem Server zu sehen. Sie können auch auf "Mein Level
eine Webseite besuchen müssen, um die besten Nutzer auf deinem Server zu sehen. Sie können auch auf "Mein Level
anzeigen" klicken, um ihr eigenes Level anzuzeigen, anstatt den Befehl [`/profile`](#commands) auszuführen. Die Antwort
ist nur für den Nutzer selbst sichtbar.

Um die Live-Rangliste zu aktivieren, setze den "Live-Ranglisten-Kanal" in deiner [Konfiguration](#configuration) auf
einen beliebigen leeren Kanal auf deinem Server, auf dem der Bot die Berechtigungen "Nachrichten senden", "
einen beliebigen Kanal auf deinem Server, auf dem der Bot die Berechtigungen "Nachrichten senden", "
Nachrichtenverlauf anzeigen" und "Kanal anzeigen" hat. Für die besten Ergebnisse richte deinen Kanal so ein, dass Nutzer
keine Nachrichten in diesen Kanal senden können. Sobald
konfiguriert, [lade deine Konfiguration neu](/docs/scnx/guilds/bots/#basics) und der Bot sendet eine Nachricht in den
Expand Down Expand Up @@ -449,12 +449,11 @@ XP vergeben werden, da der Bot die Nachricht / den Sprachkanal nicht sehen kann.
</details>

<details>
<summary>Meine Live-Rangliste wird nicht korrekt gesendet.</summary>
<summary>Meine Live-Rangliste wird nicht korrekt gesendet oder aktualisert.</summary>

Die [Live-Rangliste](#live-leaderboard) kann nur gesendet werden, wenn der Bot die Berechtigungen "Kanal anzeigen", "
Nachrichtenverlauf anzeigen"
und "Nachrichten senden" im konfigurierten Ranglistenkanal hat. Der Kanal muss außerdem leer sein, damit die
Live-Ranglisten-Einbettung gesendet und aktuell gehalten werden kann.
und "Nachrichten senden" im konfigurierten Ranglistenkanal hat. Stelle außerdem sicher, dass die Nachricht nicht mehr als 1024 Zeichen lang ist - setze ansonsten den Wert "Maximale Anzahl von Nutzern im Live Ranglistenkanal" in der [Konfiguration](#configuration) auf einen niedrigeren Wert.
</details>

## Gespeicherte Daten {#data-usage}
Expand All @@ -471,4 +470,4 @@ gesendet hat:
Du kannst die Daten eines Benutzers mit dem Befehl [`/manage-levels reset-xp`](#manage-levels) und dem `user`-Parameter
löschen. Um alle Daten aller Benutzer zu löschen, verwende den Befehl ohne den `user`-Parameter.
Alternativ kannst du, um alle von diesem Modul gespeicherten Daten zu entfernen,
auch [die Moduldatenbank bereinigen](/docs/custom-bot/additional-features#reset-module-database).
auch [die Moduldatenbank bereinigen](/docs/custom-bot/additional-features#reset-module-database).