Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
683203b
feat: started work on support bot documentation
SCDerox Oct 12, 2025
b9e31b5
fix: not building preview
SCDerox Oct 13, 2025
c456885
Add initial Support Bot Features documentation
mrt2010 Nov 7, 2025
2d193f4
feat: prepare support bot documentation
SCDerox Nov 10, 2025
37e0fc8
[DE] Updated configuration.md (V1) / [DE] Added basic structure (incl…
mrt2010 Nov 12, 2025
f87c2e0
[DE] Updated configuration.md (V2)
mrt2010 Nov 12, 2025
489a42d
[DE] Updated configuration.md (V3) / [DE] Updated bot-configuration.m…
mrt2010 Nov 12, 2025
73dc9aa
[DE] Added sidebar sections / [DE] Updated (TS) configuration.md (V4)
mrt2010 Nov 17, 2025
d2c2212
[DE] Fixed (TS) configuration.md (V5)
mrt2010 Nov 17, 2025
235ecf2
[DE] Updated (TS) configuration.md (V6)
mrt2010 Nov 19, 2025
3c7562b
[DE] Fixed (TS) configuration.md (V7)
mrt2010 Nov 19, 2025
68d5d58
[DE] Fixed (TS) configuration.md (V8)
mrt2010 Nov 19, 2025
8e316c0
[DE] Updated (TS) configuration.md (V9) / [DE] Updated (TS) ticket-to…
mrt2010 Nov 25, 2025
31faba4
[DE] Fixed (TS) configuration.md (V10) / [DE] Fixed (TS) basics.md (V2)
mrt2010 Nov 25, 2025
771d26b
[DE] Updated (TS) configuration.md (V11) / [DE] Updated (TS) claiming…
mrt2010 Nov 28, 2025
96fc011
Try to run another build
mrt2010 Nov 28, 2025
4c63ca5
[DE] Updated (TS) support-feedback.md (V2) / [DE] Updated (GEN) forms…
mrt2010 Dec 1, 2025
8d148ca
[DE] Updated (GEN) bot-configuration.md (V2) / [DE] Fixed (GEN) forms…
mrt2010 Dec 3, 2025
61b38e2
[DE] Fixed (GEN) bot-configuration.md (V3) / [DE] Fixed (GEN) opening…
mrt2010 Dec 3, 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
2 changes: 2 additions & 0 deletions docs/modmail.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Setup your Modmail-Bot

<OutdatedWarning type="MODMAIL_V2"/>

Set up the world's most advanced Modmail-Bot in just a few minutes.

<IncludedInPlan data={{PROFESSIONAL: true, UNLIMITED: true, STARTER: false}} additionalDetails={{
Expand Down
2 changes: 2 additions & 0 deletions docs/modmail/basics.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Modmail starter guide (Modmail 101)

<OutdatedWarning type="MODMAIL_V2"/>

In this document, we've collected everything that is helpful to understand how to use modmail on any server.

:::info
Expand Down
2 changes: 2 additions & 0 deletions docs/modmail/configuration/main.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
sidebar_position: 1
---

<OutdatedWarning type="MODMAIL_V2"/>

# Main configuration

Configure the basic look and behavior of your modmail.
Expand Down
48 changes: 24 additions & 24 deletions docs/scnx/guilds/bots.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,21 @@ sidebar_position: 1
# Bots on SCNX

This documents contains guides applicable for both the [Custom Bot](/docs/custom-bot/intro) and
the [Modmail Bot](/docs/modmail/intro) - if you want to set up these bots, follow
the [Get started with Custom Bot](/docs/custom-bot) or the [Get started with Modmail-Bot](/docs/modmail) guides.
the [Support-Bot](/docs/support-bot/intro) - if you want to set up these bots, follow
the [Get started with Custom Bot](/docs/custom-bot) or the [Get started with Support-Bot](/docs/support-bot) guides.

## Troubleshooting {#troubleshooting}

The steps to troubleshoot are different between the two bots. Please continue in the two different troubleshooting
guides:

* [Custom Bot](/docs/custom-bot/troubleshooting)
* Modmail-Bot
* Support Bot

## The Basics {#basics}

Each bot on SCNX is its own process running on a real, physical server. You can manage the process in your
Bot-Status-Panel of your [Modmail-](https://scnx.app/glink?page=modmail/manage)
Bot-Status-Panel of your [Support-Bot-](https://scnx.app/glink?page=support-system/manage)
or [CustomBot-](https://scnx.app/glink?page=bot/manage) Dashboard.

Here's an example of a Custom-Bot-Status-Panel:
Expand All @@ -45,15 +45,15 @@ about:
problems and offer your solutions - or if they are bugs in the bot themselves - to fix them. You might get asked
to [share them](#sharing-logs).
* Language: This is the (human) language your bot will use for any default-configuration-values and messages that can't
be configured. Modmail might, in some cases, use the language of the user that is executing a command instead of this
be configured. Your Support-Bot might, in some cases, use the language of the user that is executing a command instead of this
value. You can always [change the language](#bot-language) of your bot.
* Server: This is the physical server - also called Bot-Host - your bot is being hosted on. You
can [change the Bot-Host](#bot-host) if you want.
* Branch (only available for Custom-Bots): The branch is a completely different code base for your bot. You should leave
this on "v3" (Stable version), but can change it to the "beta"-Branch (Public beta; might be unstable).
* Version (only visible for Custom-Bots): This is a unique number identifying a published code-version. Depending on
your version, your bot might not be able to use certain new features or take advanced of newly published releases. If
your version is not up-to-date, you'll find a warning indicating this. Your Modmail is always up-to-date. Learn more
your version is not up-to-date, you'll find a warning indicating this. Your Support-Bot is always up-to-date. Learn more
about [Updates & Versions](#bot-updates).
* RAM / CPU Values: These are right below the "Online"-Status. You can safely ignore them, they are only there as a
gimmick and show the RAM / CPU Usage of your Bot. These are irrelevant as SCNX is automatically optimizing your bot if
Expand All @@ -72,15 +72,15 @@ about:
<li>You won't be able to use certain features if your bot is not on the latest version until you upgrade to a newer version.</li>
</ul>
</TabItem>
<TabItem value="modmailBot" label="Modmail-Bot">
<TabItem value="supportBot" label="Support-Bot">
<ul>
<li>We publish regular updates for Modmail, sometimes even multiple versions a day. All updates are free of charge.</li>
<li>Your Modmail is always running the newest version available for it.</li>
<li>When there's a new version available, your Modmail will automatically restart to apply it.</li>
<li>We publish regular updates for Support-Bot, sometimes even multiple versions a day. All updates are free of charge.</li>
<li>Your Support-Bot is always running the newest version available for it.</li>
<li>When there's a new version available, your Support-Bot will automatically restart to apply it.</li>
<li>We'll announce big updates on our <a href="https://scootk.it/dc">Discord-Server</a> and post a link to the changelog there.</li>
<li>Some small updates and bug-fixes won't be announced - your Modmail simply applies them without any commotion.</li>
<li>You can find all changelogs in your <a href="https://scnx.app/glink?page=modmail/manage">Bot-Dashboard</a> and on our <a href="https://scnx.app/changelogs?type=MODMAIL">Changelog page</a>.</li>
<li>When updating, your Modmail might be offline for a short period of time while applying database changes. This takes less than a minute and startup will continue as usual afterward.</li>
<li>Some small updates and bug-fixes won't be announced - your Support-Bot simply applies them without any commotion.</li>
<li>You can find all changelogs in your <a href="https://scnx.app/glink?page=support-system/manage">Bot-Dashboard</a> and on our <a href="https://scnx.app/changelogs?type=MODMAIL">Changelog page</a>.</li>
<li>When updating, your Support-Bot might be offline for a short period of time while applying database changes. This takes less than a minute and startup will continue as usual afterward.</li>
</ul>
</TabItem>
</Tabs>
Expand Down Expand Up @@ -111,15 +111,15 @@ about:
<li>Confirm your change by clicking "Confirm".</li>
</ol>
</TabItem>
<TabItem value="modmailBot" label="Modmail-Bot">There's no public Beta version available for Modmail at this time. Selected users might receive access to a private beta, but generally speaking, all new features all available for everyone. Compared to Custom-Bot, we do a way more detailed testing series and ensure that each release is fully stable when released to Modmail.</TabItem>
<TabItem value="supportBot" label="Support-Bot">There's no public Beta version available for Support-Bot at this time. Selected users might receive access to a private beta, but generally speaking, all new features all available for everyone. Compared to Custom-Bot, we do a way more detailed testing series and ensure that each release is fully stable when released to Support-Bot.</TabItem>
</Tabs>

### Change Bot-Host {#bot-host}

The Bot-Host is the physical server your bot is running on. We offer several Bot-Hosts running in different regions of
the world. Here's how to switch a Bot-Host:

1. Open the [Modmail-](https://scnx.app/glink?page=modmail/manage)
1. Open the [Support-Bot-](https://scnx.app/glink?page=support-system/manage)
or [CustomBot-](https://scnx.app/glink?page=bot/manage) Dashboard.
2. Next, click "Change" next to "Server" in the "Status"-Section.
3. Select the Bot-Host you want to switch to.
Expand Down Expand Up @@ -155,7 +155,7 @@ even move your bots around if you do not have a paid plan to distribute resource
### Change Bot-Language {#bot-language}

The (human) language your bot will be used for any default-configuration-values and messages that can't
be configured. Modmail might, in some cases, use the language of the user that is executing a command instead of this
be configured. Your Support-Bot might, in some cases, use the language of the user that is executing a command instead of this
value.

:::info
Expand All @@ -165,7 +165,7 @@ either reset these files or translate fields yourself.

To change the language of your bot, please

1. Open the [Modmail-](https://scnx.app/glink?page=modmail/manage)
1. Open the [Support-Bot-](https://scnx.app/glink?page=support-system/manage)
or [CustomBot-](https://scnx.app/glink?page=bot/manage) Dashboard.
2. Next, click "Change" next to "Server" in the "Status"-Section.
3. Select the new language you want to switch to.
Expand Down Expand Up @@ -199,9 +199,9 @@ To remove the "Powered by scnx.xyz ⚡" from *every* embed of your bot, please f
<li>Save the changes & restart your bot to apply these changes.</li>
</ol>
</TabItem>
<TabItem value="modmailBot" label="Modmail-Bot">
<TabItem value="supportBot" label="Support-Bot">
<ol>
<li>Open the <a href="https://scnx.app/glink?page=modmail/configuration?show=branding">Bot Branding</a> section of your Modmail's configuration.</li>
<li>Open the <a href="https://scnx.app/glink?page=support-system/bot-configuration?show=branding">Bot Branding</a> section of your Support-Bot's bot configuration.</li>
<li>Change the "Default Embed-Footer" and "Default Embed-Footer-Image" value to your liking. You can simply upload an image if you like or remove it if not needed.</li>
<li>Save the changes & reload the configuration your bot to apply these changes.</li>
</ol>
Expand All @@ -221,7 +221,7 @@ To remove the "Powered by scnx.xyz ⚡" from *every* embed of your bot, please f

You can change the Profile-Picture and username of your bot without ever leaving SCNX:

1. Open the [Modmail-](https://scnx.app/glink?page=modmail/manage?showEditProfile=true)
1. Open the [Support-Bot-](https://scnx.app/glink?page=support-bot/manage?showEditProfile=true)
or [CustomBot-](https://scnx.app/glink?page=bot/manage?showEditProfile=true) Dashboard.
2. Next, click on the username of your bot in the Bot-Status-Panel (if you used the links above you can skip this steps,
the modal will open automatically).
Expand Down Expand Up @@ -258,7 +258,7 @@ server, please follow the [transfer SCNX data guide](/docs/scnx/guilds/faq#trans
server, please first [add your server to SCNX](/docs/setup) and then [set up the Custom-Bot](/docs/custom-bot).
:::

1. Open the [Modmail-](https://scnx.app/glink?page=modmail/manage)
1. Open the [Support-Bot-](https://scnx.app/glink?page=support-bot/manage)
or [CustomBot-](https://scnx.app/glink?page=bot/manage) Dashboard.
2. Next, click on "Advanced options" in the bot status card.
3. Click on "View Invite-URL" and click on "Copy Invite-URL to clipboard".
Expand All @@ -284,7 +284,7 @@ issue, and we get these reported automatically. Only share them if you are exper

Here's how you can share the logs of your bot:

1. Open the [Modmail-](https://scnx.app/glink?page=modmail/manage)
1. Open the [Support-Bot-](https://scnx.app/glink?page=support-system/manage)
or [CustomBot-](https://scnx.app/glink?page=bot/manage) Dashboard.
2. Next, click on "More options" in the Bot-Status-Panel.
3. Click on "Share your bot's logs" and then press the button "Share logs". Your Bot-Host will now upload the logs of
Expand Down Expand Up @@ -317,7 +317,7 @@ You can change the token of your Bot easily without needing to delete your Bot f
1. Open the [Discord Developer Panel](https://discord.com/developers/applications) and obtain a new token: First select
your application, go to
the "Bot"-Site and then click on "Regenerate token", and copy the result.
2. Open the [Modmail-](https://scnx.app/glink?page=modmail/manage)
2. Open the [Support-Bot-](https://scnx.app/glink?page=support-bot/manage)
or [CustomBot-](https://scnx.app/glink?page=bot/manage) Dashboard.
3. Click on "More options" in the "Status"-Panel of your bot.
4. Click on "Change Bot-Token".
Expand Down Expand Up @@ -351,7 +351,7 @@ are [happy to help](https://scnx.app/help) on our [Discord](https://scootk.it/dc

To permanently delete your bot, please follow these instructions:

1. Open the [Modmail-](https://scnx.app/glink?page=modmail/manage)
1. Open the [Support-Bot-](https://scnx.app/glink?page=support-system/manage)
or [CustomBot-](https://scnx.app/glink?page=bot/manage) Dashboard.
2. Next, click on "More options" in the Bot-Status-Panel.
3. Select "Delete a bot".
Expand Down
Loading