BotSupportHome: Difference between revisions
Appearance
Created page with "Home" |
No edit summary |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:GorBot Support}} | |||
__NOTOC__ | |||
<span id="support-top"></span> | |||
<div style="width:calc(100% - 40px); max-width:1500px; margin:-42px auto 30px auto; padding:0; font-family:Georgia, 'Times New Roman', serif; color:#e8dfcf;"> | |||
<div style="overflow:hidden; border:1px solid #7d5b37; border-radius:8px; background:#17110d; box-shadow:0 4px 18px rgba(0,0,0,0.55);"> | |||
<!-- ========================================================= --> | |||
<!-- HEADER --> | |||
<!-- ========================================================= --> | |||
<div style="margin:0; padding:24px 24px 20px 24px; text-align:center; line-height:1.2; background:linear-gradient(180deg,#3b2118 0%,#1b120e 100%); border-bottom:1px solid #7d5b37;"> | |||
<div style="margin:0; padding:0; font-size:38px; line-height:1.18; font-weight:bold; letter-spacing:2px; color:#e0b45d; text-shadow:2px 2px 4px #000;">GORBOT SUPPORT</div> | |||
<div style="margin:10px 0 0 0; padding:0; font-size:18px; line-height:1.35; color:#c9bba6; font-style:italic;">Commands, player help, server-owner setup, permissions, security, dashboard guidance, troubleshooting, and feature instructions in one place.</div> | |||
</div> | |||
<!-- ========================================================= --> | |||
<!-- TOPIC BUTTONS --> | |||
<!-- ========================================================= --> | |||
<div style="padding:24px 28px 20px 28px; text-align:center; background:#1d1511; border-bottom:1px solid #5f452e;"> | |||
<div style="font-size:15px; color:#b8a894; margin-bottom:14px;">Choose a topic or scroll through the complete guide.</div> | |||
<span style="display:inline-block; margin:5px; padding:9px 13px; background:#3b2118; border:1px solid #8d6740; border-radius:5px; font-weight:bold;">[[#support-start|Start Here]]</span> | |||
<span style="display:inline-block; margin:5px; padding:9px 13px; background:#3b2118; border:1px solid #8d6740; border-radius:5px; font-weight:bold;">[[#support-player|Player Guide]]</span> | |||
<span style="display:inline-block; margin:5px; padding:9px 13px; background:#3b2118; border:1px solid #8d6740; border-radius:5px; font-weight:bold;">[[#support-prefix|Prefix Commands]]</span> | |||
<span style="display:inline-block; margin:5px; padding:9px 13px; background:#3b2118; border:1px solid #8d6740; border-radius:5px; font-weight:bold;">[[#support-slash|Slash Commands]]</span> | |||
<span style="display:inline-block; margin:5px; padding:9px 13px; background:#3b2118; border:1px solid #8d6740; border-radius:5px; font-weight:bold;">[[#support-characters|Characters]]</span> | |||
<span style="display:inline-block; margin:5px; padding:9px 13px; background:#3b2118; border:1px solid #8d6740; border-radius:5px; font-weight:bold;">[[#support-npcs|NPCs]]</span> | |||
<span style="display:inline-block; margin:5px; padding:9px 13px; background:#3b2118; border:1px solid #8d6740; border-radius:5px; font-weight:bold;">[[#support-roleplay|Roleplay]]</span> | |||
<span style="display:inline-block; margin:5px; padding:9px 13px; background:#3b2118; border:1px solid #8d6740; border-radius:5px; font-weight:bold;">[[#support-dashboard|Web Dashboard]]</span> | |||
<span style="display:inline-block; margin:5px; padding:9px 13px; background:#3b2118; border:1px solid #8d6740; border-radius:5px; font-weight:bold;">[[#support-owner|Server Owners]]</span> | |||
<span style="display:inline-block; margin:5px; padding:9px 13px; background:#3b2118; border:1px solid #8d6740; border-radius:5px; font-weight:bold;">[[#support-modcommands|Staff Commands]]</span> | |||
<span style="display:inline-block; margin:5px; padding:9px 13px; background:#3b2118; border:1px solid #8d6740; border-radius:5px; font-weight:bold;">[[#support-moderation|Moderation]]</span> | |||
<span style="display:inline-block; margin:5px; padding:9px 13px; background:#3b2118; border:1px solid #8d6740; border-radius:5px; font-weight:bold;">[[#support-automation|Automation]]</span> | |||
<span style="display:inline-block; margin:5px; padding:9px 13px; background:#3b2118; border:1px solid #8d6740; border-radius:5px; font-weight:bold;">[[#support-security|Permissions & Security]]</span> | |||
<span style="display:inline-block; margin:5px; padding:9px 13px; background:#3b2118; border:1px solid #8d6740; border-radius:5px; font-weight:bold;">[[#support-troubleshooting|Troubleshooting]]</span> | |||
<span style="display:inline-block; margin:5px; padding:9px 13px; background:#3b2118; border:1px solid #8d6740; border-radius:5px; font-weight:bold;">[[#support-faq|FAQ]]</span> | |||
<div style="margin-top:15px;"> | |||
<span style="display:inline-block; margin:5px; padding:9px 13px; background:#241813; border:1px solid #9e2f26; border-radius:5px; font-weight:bold;">[[About Us|About GorBot]]</span> | |||
<span style="display:inline-block; margin:5px; padding:9px 13px; background:#241813; border:1px solid #9e2f26; border-radius:5px; font-weight:bold;">[[Contact Us|Contact Us]]</span> | |||
</div> | |||
</div> | |||
<!-- ========================================================= --> | |||
<!-- START HERE --> | |||
<!-- ========================================================= --> | |||
<span id="support-start"></span> | |||
<div style="padding:32px 42px 10px 42px;"> | |||
<div style="text-align:center; margin-bottom:22px;"> | |||
<div style="font-size:28px; font-weight:bold; color:#e0b45d;">START HERE</div> | |||
<div style="margin-top:6px; color:#a99a87; font-style:italic;">The essentials for anyone using GorBot.</div> | |||
</div> | |||
<div style="padding:24px 28px; background:#211712; border:1px solid #5f452e; border-radius:7px; line-height:1.8;"> | |||
GorBot can be used through both '''Discord''' and the [[Dashboard|Web Dashboard]]. | |||
For ordinary players, the quickest starting points are: | |||
* use <code>=help</code> or <code>/bothelp</code> for help inside Discord; | |||
* create or select a character; | |||
* use <code>=say <message></code> to speak as the active character; | |||
* use the Character Library when you want to edit a full profile; | |||
* use the [[NPC Database]] for NPCs you own; | |||
* use Discord slash-command autocomplete to see currently enabled slash-command options. | |||
The default message-command prefix used throughout this guide is: | |||
<pre>=</pre> | |||
A server can configure a different prefix. If your server has done so, replace <code>=</code> in the examples below with that server's configured prefix. | |||
</div> | |||
<div style="text-align:right; margin-top:12px;"><span style="display:inline-block; padding:6px 10px; background:#3b2118; border:1px solid #7d5b37; border-radius:4px;">[[#support-top|↑ Back to Top]]</span></div> | |||
</div> | |||
<!-- ========================================================= --> | |||
<!-- PLAYER GUIDE --> | |||
<!-- ========================================================= --> | |||
<span id="support-player"></span> | |||
<div style="padding:32px 42px 10px 42px;"> | |||
<div style="text-align:center; margin-bottom:22px;"> | |||
<div style="font-size:28px; font-weight:bold; color:#e0b45d;">PLAYER GUIDE</div> | |||
<div style="margin-top:6px; color:#a99a87; font-style:italic;">The parts of GorBot most community members will use regularly.</div> | |||
</div> | |||
{| style="width:100%; table-layout:fixed; border-collapse:separate; border-spacing:12px;" | |||
|- | |||
| style="width:33.33%; vertical-align:top; padding:22px; background:#211712; border:1px solid #5f452e; border-radius:6px;" | | |||
<div style="font-size:20px; font-weight:bold;">Characters</div> | |||
<div style="margin-top:8px; line-height:1.6;">Create persistent roleplay identities, select an active character, maintain biography/profile information, and speak through the character in Discord. See [[Character System|Characters & Profiles]].</div> | |||
| style="width:33.33%; vertical-align:top; padding:22px; background:#211712; border:1px solid #5f452e; border-radius:6px;" | | |||
<div style="font-size:20px; font-weight:bold;">NPCs</div> | |||
<div style="margin-top:8px; line-height:1.6;">Browse, talk with, or manage supported NPC identities according to the server's enabled features and your ownership rights. See [[NPC Database]].</div> | |||
| style="width:33.33%; vertical-align:top; padding:22px; background:#211712; border:1px solid #5f452e; border-radius:6px;" | | |||
<div style="font-size:20px; font-weight:bold;">Web Dashboard</div> | |||
<div style="margin-top:8px; line-height:1.6;">Use larger forms and persistent pages for profile editing, NPC management, community tools, and other features that are cumbersome through commands alone.</div> | |||
|} | |||
<div style="padding:20px 24px; margin:10px 12px 0 12px; background:#241813; border-left:4px solid #9e2f26; border-radius:5px; line-height:1.7;"> | |||
'''Important:''' knowing the text of a staff command does not grant permission to use it. GorBot checks the Discord user, server authority, roles, ownership, and Discord permissions before protected actions are allowed. | |||
</div> | |||
<div style="text-align:right; margin-top:12px;"><span style="display:inline-block; padding:6px 10px; background:#3b2118; border:1px solid #7d5b37; border-radius:4px;">[[#support-top|↑ Back to Top]]</span></div> | |||
</div> | |||
<!-- ========================================================= --> | |||
<!-- PREFIX COMMANDS --> | |||
<!-- ========================================================= --> | |||
<span id="support-prefix"></span> | |||
<div style="padding:32px 42px 10px 42px;"> | |||
<div style="text-align:center; margin-bottom:22px;"> | |||
<div style="font-size:28px; font-weight:bold; color:#e0b45d;">PLAYER PREFIX COMMAND REFERENCE</div> | |||
<div style="margin-top:6px; color:#a99a87; font-style:italic;">Examples below use GorBot's default prefix: <code>=</code></div> | |||
</div> | |||
{| class="wikitable" style="width:100%; border-collapse:collapse; background:#211712; color:#e8dfcf;" | |||
! style="width:24%; padding:11px; background:#3b2118; color:#e0b45d;" | Command | |||
! style="width:19%; padding:11px; background:#3b2118; color:#e0b45d;" | Who Uses It | |||
! style="padding:11px; background:#3b2118; color:#e0b45d;" | What It Does | |||
|- | |||
| style="padding:11px;" | <code>=help</code> | |||
| style="padding:11px;" | Everyone | |||
| style="padding:11px;" | Opens GorBot's paged Discord help menu. This is the best live reference when a server has enabled or disabled command modules. | |||
|- | |||
| style="padding:11px;" | <code>=Menu</code> | |||
| style="padding:11px;" | Players | |||
| style="padding:11px;" | Opens the character-selection menu for your account. | |||
|- | |||
| style="padding:11px;" | <code>=Menu 2</code><br><code>=Menu 3</code> ... | |||
| style="padding:11px;" | Players | |||
| style="padding:11px;" | Opens another page of the character-selection menu when your character list spans multiple pages. | |||
|- | |||
| style="padding:11px;" | <code>=character management</code> | |||
| style="padding:11px;" | Players | |||
| style="padding:11px;" | Alias for the character-selection/management menu. | |||
|- | |||
| style="padding:11px;" | <code>=character management 2</code> ... | |||
| style="padding:11px;" | Players | |||
| style="padding:11px;" | Opens a later page of the character-management menu. | |||
|- | |||
| style="padding:11px;" | <code>=1</code>, <code>=2</code>, <code>=3</code> ... | |||
| style="padding:11px;" | Players | |||
| style="padding:11px;" | Selects the numbered character shown in your current character menu. Use the number displayed by the menu rather than guessing a slot. | |||
|- | |||
| style="padding:11px;" | <code>=characters</code> | |||
| style="padding:11px;" | Players | |||
| style="padding:11px;" | Displays or enters the lightweight character/profile listing supported by the message-command system. Full profile management is available through the Character Library. | |||
|- | |||
| style="padding:11px;" | <code>=name <name></code> | |||
| style="padding:11px;" | Players | |||
| style="padding:11px;" | Sets or updates the lightweight character name used by the message-profile system where that editing path is enabled. | |||
|- | |||
| style="padding:11px;" | <code>=avatar <HTTPS image URL></code> | |||
| style="padding:11px;" | Players | |||
| style="padding:11px;" | Sets the lightweight character avatar URL where message-profile editing is enabled. Full image/profile management may also be available on the dashboard. | |||
|- | |||
| style="padding:11px;" | <code>=about</code> | |||
| style="padding:11px;" | Players | |||
| style="padding:11px;" | Opens or displays the lightweight profile/about information available through the message-command profile path. | |||
|- | |||
| style="padding:11px;" | <code>=bio</code> | |||
| style="padding:11px;" | Players | |||
| style="padding:11px;" | Displays the biography for your currently active character. | |||
|- | |||
| style="padding:11px;" | <code>=bio <text></code> | |||
| style="padding:11px;" | Players | |||
| style="padding:11px;" | Replaces the active character biography with the supplied text. Biography length limits are enforced rather than silently truncating the text. | |||
|- | |||
| style="padding:11px;" | <code>=say <message></code> | |||
| style="padding:11px;" | Players | |||
| style="padding:11px;" | Speaks through the currently selected character. GorBot posts the supplied text using the character identity through the roleplay webhook system. | |||
|} | |||
<div style="margin:18px 0 0 0; padding:20px 24px; background:#241813; border-left:4px solid #9e2f26; border-radius:5px; line-height:1.7;"> | |||
'''How <code>=say</code> behaves:''' GorBot should only remove the original <code>=say</code> command after the character webhook message is successfully posted. If the relay fails, the original message should remain so the player's roleplay text is not lost. | |||
</div> | |||
<div style="text-align:right; margin-top:12px;"><span style="display:inline-block; padding:6px 10px; background:#3b2118; border:1px solid #7d5b37; border-radius:4px;">[[#support-top|↑ Back to Top]]</span></div> | |||
</div> | |||
<!-- ========================================================= --> | |||
<!-- SLASH COMMANDS --> | |||
<!-- ========================================================= --> | |||
<span id="support-slash"></span> | |||
<div style="padding:32px 42px 10px 42px;"> | |||
<div style="text-align:center; margin-bottom:22px;"> | |||
<div style="font-size:28px; font-weight:bold; color:#e0b45d;">PLAYER SLASH COMMAND REFERENCE</div> | |||
<div style="margin-top:6px; color:#a99a87; font-style:italic;">Slash commands are discoverable through Discord's built-in autocomplete.</div> | |||
</div> | |||
<div style="padding:20px 24px; margin-bottom:16px; background:#211712; border:1px solid #5f452e; border-radius:6px; line-height:1.7;"> | |||
Slash-command availability can depend on the current GorBot release and which modules a server has enabled. Discord's autocomplete shows the subcommands currently registered on that server. | |||
</div> | |||
{| class="wikitable" style="width:100%; border-collapse:collapse; background:#211712; color:#e8dfcf;" | |||
! style="width:27%; padding:11px; background:#3b2118; color:#e0b45d;" | Command | |||
! style="padding:11px; background:#3b2118; color:#e0b45d;" | What It Does | |||
|- | |||
| style="padding:11px;" | <code>/bothelp</code> | |||
| style="padding:11px;" | Opens GorBot's Discord help information. | |||
|- | |||
| style="padding:11px;" | <code>/character register</code> | |||
| style="padding:11px;" | Registers a new roleplay character when that subcommand is enabled. Character name is required; supported avatar/profile options can also be supplied. | |||
|- | |||
| style="padding:11px;" | <code>/character edit</code> | |||
| style="padding:11px;" | Edits a character you own using the currently available character fields. | |||
|- | |||
| style="padding:11px;" | <code>/character switch</code> | |||
| style="padding:11px;" | Changes your active character. | |||
|- | |||
| style="padding:11px;" | <code>/character list</code> | |||
| style="padding:11px;" | Lists characters associated with your Discord account. | |||
|- | |||
| style="padding:11px;" | <code>/character delete</code> | |||
| style="padding:11px;" | Deletes a character you own after the command's normal validation/confirmation rules. | |||
|- | |||
| style="padding:11px;" | <code>/character say</code> | |||
| style="padding:11px;" | Sends dialogue through your active character without requiring a visible <code>=say</code> command message. | |||
|- | |||
| style="padding:11px;" | <code>/character link</code> | |||
| style="padding:11px;" | Uses the supported character-linking workflow available in the current character system. | |||
|- | |||
| style="padding:11px;" | <code>/npc list</code> | |||
| style="padding:11px;" | Lists NPCs available to the current supported NPC interaction system. | |||
|- | |||
| style="padding:11px;" | <code>/npc talk</code> | |||
| style="padding:11px;" | Starts or enters a supported NPC conversation. | |||
|- | |||
| style="padding:11px;" | <code>/npc end</code> | |||
| style="padding:11px;" | Ends the user's active supported NPC conversation. | |||
|- | |||
| style="padding:11px;" | <code>/talk</code> | |||
| style="padding:11px;" | Starts or continues a supported conversational interaction using GorBot's current roleplay/conversation context. | |||
|- | |||
| style="padding:11px;" | <code>/roles</code> | |||
| style="padding:11px;" | Shows or uses the server's supported self-assignable role workflow. | |||
|- | |||
| style="padding:11px;" | <code>/custom run</code> | |||
| style="padding:11px;" | Runs a custom action that the server has specifically configured and exposed through GorBot. | |||
|- | |||
| style="padding:11px;" | <code>/ticket close</code> | |||
| style="padding:11px;" | Closes the current supported ticket when the user has authority to close it. | |||
|- | |||
| style="padding:11px;" | <code>/poll create</code> | |||
| style="padding:11px;" | Creates a poll using the supplied poll options. | |||
|- | |||
| style="padding:11px;" | <code>/poll results</code> | |||
| style="padding:11px;" | Displays results for a supported poll. | |||
|- | |||
| style="padding:11px;" | <code>/poll end</code> | |||
| style="padding:11px;" | Ends a supported poll when the user has authority to do so. | |||
|- | |||
| style="padding:11px;" | <code>/poll list</code> | |||
| style="padding:11px;" | Lists supported polls available to the user/server context. | |||
|} | |||
<div style="text-align:right; margin-top:12px;"><span style="display:inline-block; padding:6px 10px; background:#3b2118; border:1px solid #7d5b37; border-radius:4px;">[[#support-top|↑ Back to Top]]</span></div> | |||
</div> | |||
<!-- ========================================================= --> | |||
<!-- CHARACTERS --> | |||
<!-- ========================================================= --> | |||
<span id="support-characters"></span> | |||
<div style="padding:32px 42px 10px 42px;"> | |||
<div style="text-align:center; margin-bottom:22px;"> | |||
<div style="font-size:28px; font-weight:bold; color:#e0b45d;">CHARACTERS & PROFILES</div> | |||
<div style="margin-top:6px; color:#a99a87; font-style:italic;">Persistent roleplay identities that belong to your Discord account.</div> | |||
</div> | |||
<div style="padding:24px 28px; background:#211712; border:1px solid #5f452e; border-radius:7px; line-height:1.8;"> | |||
The full character system is documented at [[Character System|Characters & Profiles]]. | |||
A normal player workflow is: | |||
# create a character through the dashboard or a supported <code>/character</code> command; | |||
# choose the profile style that fits the character; | |||
# fill in only the information you want to use; | |||
# add a portrait and custom fields where desired; | |||
# select the character as active; | |||
# use <code>=say <message></code> or <code>/character say</code> for character speech. | |||
GorBot supports multiple profile styles so a community is not forced into one setting: | |||
* Gorean; | |||
* Standard RP; | |||
* Fantasy RP; | |||
* Tabletop D&D; | |||
* Modern / Sci-Fi RP; | |||
* Custom / Freeform. | |||
Each character can also use up to 12 custom fields. | |||
</div> | |||
<div style="text-align:right; margin-top:12px;"><span style="display:inline-block; padding:6px 10px; background:#3b2118; border:1px solid #7d5b37; border-radius:4px;">[[#support-top|↑ Back to Top]]</span></div> | |||
</div> | |||
<!-- ========================================================= --> | |||
<!-- NPCS --> | |||
<!-- ========================================================= --> | |||
<span id="support-npcs"></span> | |||
<div style="padding:32px 42px 10px 42px;"> | |||
<div style="text-align:center; margin-bottom:22px;"> | |||
<div style="font-size:28px; font-weight:bold; color:#e0b45d;">NPCs</div> | |||
<div style="margin-top:6px; color:#a99a87; font-style:italic;">Persistent non-player identities for recurring roleplay and shared world-building.</div> | |||
</div> | |||
<div style="padding:24px 28px; background:#211712; border:1px solid #5f452e; border-radius:7px; line-height:1.8;"> | |||
The full NPC management system is documented at [[NPC Database]] and [[NPCs & Shared Roleplay]]. | |||
Depending on server configuration and ownership, users can: | |||
* create NPC profiles; | |||
* maintain NPC portraits and profile information; | |||
* use the same profile-style foundation available to characters; | |||
* add custom fields; | |||
* clone owned NPCs; | |||
* share supported public NPC profiles; | |||
* publish eligible NPCs into the broader global NPC listing; | |||
* use supported <code>/npc</code> commands for conversation-oriented NPC features. | |||
Sharing an NPC profile does not automatically give another user edit ownership. | |||
</div> | |||
<div style="text-align:right; margin-top:12px;"><span style="display:inline-block; padding:6px 10px; background:#3b2118; border:1px solid #7d5b37; border-radius:4px;">[[#support-top|↑ Back to Top]]</span></div> | |||
</div> | |||
<!-- ========================================================= --> | |||
<!-- ROLEPLAY --> | |||
<!-- ========================================================= --> | |||
<span id="support-roleplay"></span> | |||
<div style="padding:32px 42px 10px 42px;"> | |||
<div style="text-align:center; margin-bottom:22px;"> | |||
<div style="font-size:28px; font-weight:bold; color:#e0b45d;">ROLEPLAY THROUGH GORBOT</div> | |||
<div style="margin-top:6px; color:#a99a87; font-style:italic;">Use your selected character identity without changing your actual Discord account.</div> | |||
</div> | |||
<div style="padding:24px 28px; background:#211712; border:1px solid #5f452e; border-radius:7px; line-height:1.8;"> | |||
When you use character speech, GorBot can relay your message through a Discord webhook using the selected character's name and portrait. | |||
Example: | |||
<pre>=say Tal, traveler. What brings you to the city?</pre> | |||
GorBot posts the supplied dialogue as the active character. | |||
Your Discord account still remains the internal owner of that character. Character speech is fictional presentation; it does not make the webhook identity a separate Discord account. | |||
'''Threads and forum posts:''' character speech can work inside supported threads when GorBot has the required channel and webhook permissions. | |||
</div> | |||
<div style="text-align:right; margin-top:12px;"><span style="display:inline-block; padding:6px 10px; background:#3b2118; border:1px solid #7d5b37; border-radius:4px;">[[#support-top|↑ Back to Top]]</span></div> | |||
</div> | |||
<!-- ========================================================= --> | |||
<!-- DASHBOARD --> | |||
<!-- ========================================================= --> | |||
<span id="support-dashboard"></span> | |||
<div style="padding:32px 42px 10px 42px;"> | |||
<div style="text-align:center; margin-bottom:22px;"> | |||
<div style="font-size:28px; font-weight:bold; color:#e0b45d;">WEB DASHBOARD</div> | |||
<div style="margin-top:6px; color:#a99a87; font-style:italic;">Use the web interface when a command would be too small for the job.</div> | |||
</div> | |||
<div style="padding:24px 28px; background:#211712; border:1px solid #5f452e; border-radius:7px; line-height:1.8;"> | |||
The [[Dashboard|Web Dashboard]] uses Discord sign-in and applies the same ownership and server-authority rules as GorBot's other user-facing systems. | |||
Players can use it for supported personal features such as characters and NPCs. | |||
Authorized server managers can use additional server-level pages for supported configuration, moderation, roles, automation, tracked content, and community features. | |||
Signing in identifies the Discord account. It does '''not''' automatically make the user a server administrator. | |||
</div> | |||
<div style="text-align:right; margin-top:12px;"><span style="display:inline-block; padding:6px 10px; background:#3b2118; border:1px solid #7d5b37; border-radius:4px;">[[#support-top|↑ Back to Top]]</span></div> | |||
</div> | |||
<!-- ========================================================= --> | |||
<!-- SERVER OWNER GUIDE --> | |||
<!-- ========================================================= --> | |||
<span id="support-owner"></span> | |||
<div style="padding:32px 42px 10px 42px;"> | |||
<div style="text-align:center; margin-bottom:22px;"> | |||
<div style="font-size:28px; font-weight:bold; color:#e0b45d;">SERVER OWNER GUIDE</div> | |||
<div style="margin-top:6px; color:#a99a87; font-style:italic;">The important things to understand before enabling every feature.</div> | |||
</div> | |||
<div style="padding:24px 28px; background:#211712; border:1px solid #5f452e; border-radius:7px; line-height:1.8;"> | |||
A server owner should begin with permissions and role hierarchy before troubleshooting individual commands. | |||
Recommended Discord permissions depend on enabled features, but common GorBot requirements include: | |||
* View Channels; | |||
* Send Messages; | |||
* Read Message History; | |||
* Send Messages in Threads; | |||
* Embed Links; | |||
* Manage Webhooks for character speech; | |||
* Manage Messages when message cleanup or command replacement requires it; | |||
* Manage Roles only when GorBot is expected to manage roles; | |||
* moderation permissions only when the corresponding moderation features are enabled. | |||
'''Role hierarchy matters.''' GorBot's highest Discord role must be above any role it is expected to assign, remove, rename, recolor, or otherwise manage. | |||
Avoid granting permissions GorBot does not need simply to make an error disappear. Use the permissions required by the features your community actually uses. | |||
</div> | |||
<div style="margin-top:18px; padding:24px 28px; background:#211712; border:1px solid #5f452e; border-radius:7px; line-height:1.8;"> | |||
'''Suggested owner setup order''' | |||
# confirm GorBot is online; | |||
# confirm its role position; | |||
# confirm basic channel permissions; | |||
# test <code>/bothelp</code>; | |||
# test a player character; | |||
# test <code>=say</code>; | |||
# configure self-service/community roles where desired; | |||
# configure moderation roles; | |||
# configure automation only after its required roles/channels exist; | |||
# verify protected commands using an authorized staff account; | |||
# review the [[Dashboard|Web Dashboard]] for server-level configuration. | |||
Server owners can also define trusted staff/Bot Commander authority for protected GorBot management without making every ordinary moderator a full server owner. | |||
</div> | |||
<div style="text-align:right; margin-top:12px;"><span style="display:inline-block; padding:6px 10px; background:#3b2118; border:1px solid #7d5b37; border-radius:4px;">[[#support-top|↑ Back to Top]]</span></div> | |||
</div> | |||
<!-- ========================================================= --> | |||
<!-- STAFF COMMANDS --> | |||
<!-- ========================================================= --> | |||
<span id="support-modcommands"></span> | |||
<div style="padding:32px 42px 10px 42px;"> | |||
<div style="text-align:center; margin-bottom:22px;"> | |||
<div style="font-size:28px; font-weight:bold; color:#e0b45d;">PROTECTED STAFF COMMAND REFERENCE</div> | |||
<div style="margin-top:6px; color:#a99a87; font-style:italic;">These commands are protected by GorBot authority checks. Knowing the command does not grant access.</div> | |||
</div> | |||
<div style="padding:20px 24px; margin-bottom:16px; background:#241813; border-left:4px solid #9e2f26; border-radius:5px; line-height:1.7;"> | |||
Examples use the default prefix <code>=</code>. Protected commands are intended for the server owner, Bot Commander, or authorized moderation roles as appropriate to the command. | |||
</div> | |||
{| class="wikitable" style="width:100%; border-collapse:collapse; background:#211712; color:#e8dfcf;" | |||
! style="width:27%; padding:11px; background:#3b2118; color:#e0b45d;" | Command | |||
! style="width:20%; padding:11px; background:#3b2118; color:#e0b45d;" | Typical Authority | |||
! style="padding:11px; background:#3b2118; color:#e0b45d;" | What It Does | |||
|- | |||
| style="padding:11px;" | <code>=adminhelp</code> | |||
| style="padding:11px;" | Owner / Bot Commander | |||
| style="padding:11px;" | Displays the protected administrative command help available to the authorized user. | |||
|- | |||
| style="padding:11px;" | <code>=botadmin</code> | |||
| style="padding:11px;" | Owner / Bot Commander | |||
| style="padding:11px;" | Opens or enters GorBot's protected Discord-side bot/server management command workflow. | |||
|- | |||
| style="padding:11px;" | <code>=warn <member> [reason]</code> | |||
| style="padding:11px;" | Authorized staff | |||
| style="padding:11px;" | Adds a warning to the target member, optionally recording the reason. | |||
|- | |||
| style="padding:11px;" | <code>=warnings <member></code> | |||
| style="padding:11px;" | Authorized staff | |||
| style="padding:11px;" | Displays the warning history/state available for the target member. | |||
|- | |||
| style="padding:11px;" | <code>=kick <member> [reason]</code> | |||
| style="padding:11px;" | Authorized staff | |||
| style="padding:11px;" | Removes the target member from the Discord server. The member may rejoin unless another restriction prevents it. | |||
|- | |||
| style="padding:11px;" | <code>=ban <member> [reason]</code> | |||
| style="padding:11px;" | Authorized staff | |||
| style="padding:11px;" | Bans the target member from the Discord server when GorBot and the moderator both have the required authority. | |||
|- | |||
| style="padding:11px;" | <code>=timeout <member> <duration> [reason]</code> | |||
| style="padding:11px;" | Authorized staff | |||
| style="padding:11px;" | Applies a Discord timeout for the requested supported duration. | |||
|- | |||
| style="padding:11px;" | <code>=untimeout <member></code> | |||
| style="padding:11px;" | Authorized staff | |||
| style="padding:11px;" | Removes a supported active timeout from the target member. | |||
|- | |||
| style="padding:11px;" | <code>=npcadmin list</code> | |||
| style="padding:11px;" | Owner / Bot Commander | |||
| style="padding:11px;" | Lists NPC-control entries available to the protected NPC administration command family. | |||
|- | |||
| style="padding:11px;" | <code>=npcadmin place ...</code> | |||
| style="padding:11px;" | Owner / Bot Commander | |||
| style="padding:11px;" | Places/configures a supported managed NPC presence when the relevant NPC feature is enabled. | |||
|- | |||
| style="padding:11px;" | <code>=npcadmin inspect ...</code> | |||
| style="padding:11px;" | Owner / Bot Commander | |||
| style="padding:11px;" | Displays protected information about the selected managed NPC/control target. | |||
|- | |||
| style="padding:11px;" | <code>=npcadmin pause ...</code> | |||
| style="padding:11px;" | Owner / Bot Commander | |||
| style="padding:11px;" | Pauses the selected supported managed NPC behavior. | |||
|- | |||
| style="padding:11px;" | <code>=npcadmin resume ...</code> | |||
| style="padding:11px;" | Owner / Bot Commander | |||
| style="padding:11px;" | Resumes a previously paused supported managed NPC behavior. | |||
|- | |||
| style="padding:11px;" | <code>=npcadmin remove ...</code> | |||
| style="padding:11px;" | Owner / Bot Commander | |||
| style="padding:11px;" | Removes the selected supported managed NPC placement/control entry. | |||
|- | |||
| style="padding:11px;" | <code>=npcadmin clearscene ...</code> | |||
| style="padding:11px;" | Owner / Bot Commander | |||
| style="padding:11px;" | Clears the supported NPC scene/control state targeted by the command. | |||
|} | |||
<div style="margin-top:16px; color:#b8a894; line-height:1.7;"> | |||
The NPC administration family is only useful when the relevant managed/Living NPC feature is enabled for the community. A command being recognized does not mean every server has that feature turned on. | |||
</div> | |||
<div style="text-align:right; margin-top:12px;"><span style="display:inline-block; padding:6px 10px; background:#3b2118; border:1px solid #7d5b37; border-radius:4px;">[[#support-top|↑ Back to Top]]</span></div> | |||
</div> | |||
<!-- ========================================================= --> | |||
<!-- MODERATION --> | |||
<!-- ========================================================= --> | |||
<span id="support-moderation"></span> | |||
<div style="padding:32px 42px 10px 42px;"> | |||
<div style="text-align:center; margin-bottom:22px;"> | |||
<div style="font-size:28px; font-weight:bold; color:#e0b45d;">MODERATION & ADMINISTRATION</div> | |||
<div style="margin-top:6px; color:#a99a87; font-style:italic;">Community-level tools for trusted staff and server owners.</div> | |||
</div> | |||
<div style="padding:24px 28px; background:#211712; border:1px solid #5f452e; border-radius:7px; line-height:1.8;"> | |||
The full public moderation guide is available at [[Moderation|Moderation & Administration]]. | |||
GorBot separates ordinary members, moderators, and server managers. | |||
Moderation features can include: | |||
* warnings and disciplinary history; | |||
* message cleanup; | |||
* mute/timeout; | |||
* kick; | |||
* ban; | |||
* voice moderation; | |||
* slowmode; | |||
* role persistence; | |||
* moderator roles; | |||
* server-level moderation configuration; | |||
* supported automated safety controls. | |||
A moderator command can still fail if Discord role hierarchy or permissions prevent GorBot from acting on the target. | |||
</div> | |||
<div style="text-align:right; margin-top:12px;"><span style="display:inline-block; padding:6px 10px; background:#3b2118; border:1px solid #7d5b37; border-radius:4px;">[[#support-top|↑ Back to Top]]</span></div> | |||
</div> | |||
<!-- ========================================================= --> | |||
<!-- AUTOMATION --> | |||
<!-- ========================================================= --> | |||
<span id="support-automation"></span> | |||
<div style="padding:32px 42px 10px 42px;"> | |||
<div style="text-align:center; margin-bottom:22px;"> | |||
<div style="font-size:28px; font-weight:bold; color:#e0b45d;">AUTOMATION</div> | |||
<div style="margin-top:6px; color:#a99a87; font-style:italic;">When this happens → perform the configured response.</div> | |||
</div> | |||
<div style="padding:24px 28px; background:#211712; border:1px solid #5f452e; border-radius:7px; line-height:1.8;"> | |||
See [[Automations|Automation]] for the full feature overview. | |||
Automations are normally configured through the Web Dashboard because triggers, roles, channels, actions, and publishing state are easier to understand visually. | |||
Possible workflow inputs can include supported events involving: | |||
* messages; | |||
* reactions; | |||
* automation buttons; | |||
* role changes; | |||
* voice activity; | |||
* other enabled community events. | |||
Automations still obey GorBot authorization and Discord permissions. Automating a role action does not allow GorBot to manage a role above its own highest role. | |||
</div> | |||
<div style="text-align:right; margin-top:12px;"><span style="display:inline-block; padding:6px 10px; background:#3b2118; border:1px solid #7d5b37; border-radius:4px;">[[#support-top|↑ Back to Top]]</span></div> | |||
</div> | |||
<!-- ========================================================= --> | |||
<!-- SECURITY --> | |||
<!-- ========================================================= --> | |||
<span id="support-security"></span> | |||
<div style="padding:32px 42px 10px 42px;"> | |||
<div style="text-align:center; margin-bottom:22px;"> | |||
<div style="font-size:28px; font-weight:bold; color:#e0b45d;">PERMISSIONS & SECURITY</div> | |||
<div style="margin-top:6px; color:#a99a87; font-style:italic;">Understanding who can do what is part of using GorBot safely.</div> | |||
</div> | |||
{| style="width:100%; table-layout:fixed; border-collapse:separate; border-spacing:12px;" | |||
|- | |||
| style="width:33.33%; vertical-align:top; padding:22px; background:#211712; border:1px solid #5f452e; border-radius:6px;" | | |||
<div style="font-size:20px; font-weight:bold;">Authentication</div> | |||
<div style="margin-top:8px; line-height:1.6;">Identifies the Discord account making the request. Dashboard sign-in uses Discord identity; GorBot never needs the user's Discord password.</div> | |||
| style="width:33.33%; vertical-align:top; padding:22px; background:#211712; border:1px solid #5f452e; border-radius:6px;" | | |||
<div style="font-size:20px; font-weight:bold;">Authorization</div> | |||
<div style="margin-top:8px; line-height:1.6;">Determines whether that user is allowed to perform the requested action based on ownership, server authority, trusted roles, and feature rules.</div> | |||
| style="width:33.33%; vertical-align:top; padding:22px; background:#211712; border:1px solid #5f452e; border-radius:6px;" | | |||
<div style="font-size:20px; font-weight:bold;">Discord Permissions</div> | |||
<div style="margin-top:8px; line-height:1.6;">Discord itself decides whether the bot can manage messages, roles, members, webhooks, or other server resources.</div> | |||
|} | |||
<div style="margin-top:18px; padding:24px 28px; background:#241813; border-left:4px solid #9e2f26; border-radius:6px; line-height:1.8;"> | |||
'''Never provide secrets to someone claiming they need them for a normal support request.''' | |||
Normal GorBot users and server moderators should never need to reveal: | |||
* a Discord account password; | |||
* the Discord bot token; | |||
* API keys; | |||
* database passwords; | |||
* OAuth application secrets; | |||
* private server credentials. | |||
If someone asks for sensitive credentials in order to use an ordinary GorBot feature, do not provide them. Contact the server owner or use [[Contact Us|Contact Us]] for support. | |||
</div> | |||
<div style="text-align:right; margin-top:12px;"><span style="display:inline-block; padding:6px 10px; background:#3b2118; border:1px solid #7d5b37; border-radius:4px;">[[#support-top|↑ Back to Top]]</span></div> | |||
</div> | |||
<!-- ========================================================= --> | |||
<!-- TROUBLESHOOTING --> | |||
<!-- ========================================================= --> | |||
<span id="support-troubleshooting"></span> | |||
<div style="padding:32px 42px 10px 42px;"> | |||
<div style="text-align:center; margin-bottom:22px;"> | |||
<div style="font-size:28px; font-weight:bold; color:#e0b45d;">TROUBLESHOOTING</div> | |||
<div style="margin-top:6px; color:#a99a87; font-style:italic;">Start with the simplest checks before assuming the feature is broken.</div> | |||
</div> | |||
{| class="wikitable" style="width:100%; border-collapse:collapse; background:#211712; color:#e8dfcf;" | |||
! style="width:28%; padding:11px; background:#3b2118; color:#e0b45d;" | Problem | |||
! style="padding:11px; background:#3b2118; color:#e0b45d;" | What to Check | |||
|- | |||
| style="padding:11px;" | <code>=</code> command does nothing | |||
| style="padding:11px;" | Confirm the server still uses <code>=</code> as its prefix, try <code>=help</code>, confirm GorBot can read/send in the channel, and confirm the feature is enabled. | |||
|- | |||
| style="padding:11px;" | Slash command is missing | |||
| style="padding:11px;" | Type <code>/</code> and inspect GorBot's current autocomplete list. Slash-command availability can vary by release/module. If expected commands are absent, contact the server owner. | |||
|- | |||
| style="padding:11px;" | <code>=say</code> says no active character | |||
| style="padding:11px;" | Open <code>=Menu</code>, select the intended character, then retry <code>=say</code>. | |||
|- | |||
| style="padding:11px;" | <code>=say</code> cannot post | |||
| style="padding:11px;" | The server owner should verify View Channel, Send Messages, Manage Webhooks, Manage Messages, and thread permissions where relevant. | |||
|- | |||
| style="padding:11px;" | Character image does not appear | |||
| style="padding:11px;" | Confirm the image is supported and accessible, or update the portrait through the Character Library. | |||
|- | |||
| style="padding:11px;" | Cannot edit a character or NPC | |||
| style="padding:11px;" | Confirm you own the record and are signed into the correct Discord account. Public visibility does not grant edit ownership. | |||
|- | |||
| style="padding:11px;" | Role command fails | |||
| style="padding:11px;" | Check Manage Roles and make sure GorBot's highest role is above the target role. | |||
|- | |||
| style="padding:11px;" | Kick/ban/timeout fails | |||
| style="padding:11px;" | Check both the moderator's authority and GorBot's Discord moderation permissions/role hierarchy. | |||
|- | |||
| style="padding:11px;" | Dashboard shows the wrong permissions | |||
| style="padding:11px;" | Confirm you signed in with the intended Discord account and that the server still grants the expected owner/manager role. | |||
|- | |||
| style="padding:11px;" | NPC command does nothing | |||
| style="padding:11px;" | Confirm the server has the relevant NPC interaction feature enabled and that the requested NPC is available to that workflow. | |||
|- | |||
| style="padding:11px;" | Automation does not run | |||
| style="padding:11px;" | Confirm the automation is enabled, its trigger matches the event, the configured channels/roles still exist, and GorBot has permission to perform the action. | |||
|} | |||
<div style="margin-top:18px; padding:20px 24px; background:#241813; border:1px solid #6a4b2d; border-radius:6px; line-height:1.7;"> | |||
If the problem continues after the relevant checks, use [[Contact Us|Contact Us]] and include the command or feature name, what you expected to happen, what actually happened, and any visible error message. '''Do not include passwords, tokens, API keys, or other secrets.''' | |||
</div> | |||
<div style="text-align:right; margin-top:12px;"><span style="display:inline-block; padding:6px 10px; background:#3b2118; border:1px solid #7d5b37; border-radius:4px;">[[#support-top|↑ Back to Top]]</span></div> | |||
</div> | |||
<!-- ========================================================= --> | |||
<!-- FAQ --> | |||
<!-- ========================================================= --> | |||
<span id="support-faq"></span> | |||
<div style="padding:32px 42px 10px 42px;"> | |||
<div style="text-align:center; margin-bottom:22px;"> | |||
<div style="font-size:28px; font-weight:bold; color:#e0b45d;">FREQUENTLY ASKED QUESTIONS</div> | |||
<div style="margin-top:6px; color:#a99a87; font-style:italic;">Common questions from players and server owners.</div> | |||
</div> | |||
{| style="width:100%; table-layout:fixed; border-collapse:separate; border-spacing:12px;" | |||
|- | |||
| style="width:50%; vertical-align:top; padding:22px; background:#211712; border:1px solid #5f452e; border-radius:6px;" | | |||
<div style="font-size:20px; font-weight:bold;">Do I have to use the Web Dashboard?</div> | |||
<div style="margin-top:8px; line-height:1.6;">No. Many features work directly in Discord. The dashboard is primarily for features that benefit from larger forms, browsing, and persistent configuration pages.</div> | |||
| style="width:50%; vertical-align:top; padding:22px; background:#211712; border:1px solid #5f452e; border-radius:6px;" | | |||
<div style="font-size:20px; font-weight:bold;">Is <code>=</code> always the prefix?</div> | |||
<div style="margin-top:8px; line-height:1.6;">It is the default prefix used by this guide. Server configuration can use another supported prefix.</div> | |||
|- | |||
| style="width:50%; vertical-align:top; padding:22px; background:#211712; border:1px solid #5f452e; border-radius:6px;" | | |||
<div style="font-size:20px; font-weight:bold;">Can another player edit my character?</div> | |||
<div style="margin-top:8px; line-height:1.6;">Not simply because the character is visible. Character ownership and edit authorization are separate from public presentation.</div> | |||
| style="width:50%; vertical-align:top; padding:22px; background:#211712; border:1px solid #5f452e; border-radius:6px;" | | |||
<div style="font-size:20px; font-weight:bold;">Can someone edit a shared NPC?</div> | |||
<div style="margin-top:8px; line-height:1.6;">Sharing or publishing does not automatically transfer ownership or edit rights.</div> | |||
|- | |||
| style="width:50%; vertical-align:top; padding:22px; background:#211712; border:1px solid #5f452e; border-radius:6px;" | | |||
<div style="font-size:20px; font-weight:bold;">Why can I see a staff command if I cannot use it?</div> | |||
<div style="margin-top:8px; line-height:1.6;">Command knowledge is not authorization. GorBot still checks the user and Discord permissions before protected actions are allowed.</div> | |||
| style="width:50%; vertical-align:top; padding:22px; background:#211712; border:1px solid #5f452e; border-radius:6px;" | | |||
<div style="font-size:20px; font-weight:bold;">Where can I learn what GorBot is?</div> | |||
<div style="margin-top:8px; line-height:1.6;">See [[About Us|About GorBot]] for the project background, purpose, and relationship with Gor Ultima.</div> | |||
|} | |||
<div style="text-align:right; margin-top:12px;"><span style="display:inline-block; padding:6px 10px; background:#3b2118; border:1px solid #7d5b37; border-radius:4px;">[[#support-top|↑ Back to Top]]</span></div> | |||
</div> | |||
<!-- ========================================================= --> | |||
<!-- CONTACT / ABOUT --> | |||
<!-- ========================================================= --> | |||
<span id="support-contact"></span> | |||
<div style="margin:34px 42px 36px 42px; padding:28px; text-align:center; background:linear-gradient(180deg,#301d16 0%,#1c130f 100%); border:1px solid #7d5b37; border-radius:7px;"> | |||
<div style="font-size:25px; font-weight:bold; color:#e1bf7a;">Still need help?</div> | |||
<div style="margin-top:10px; font-size:17px; color:#c9bba6;">Use the dedicated contact page for support that cannot be resolved by the guide above.</div> | |||
<div style="margin-top:18px;"> | |||
<span style="display:inline-block; margin:5px; padding:10px 15px; background:#3b2118; border:1px solid #8d6740; border-radius:5px; font-weight:bold;">[[Contact Us|Contact Us]]</span> | |||
<span style="display:inline-block; margin:5px; padding:10px 15px; background:#3b2118; border:1px solid #8d6740; border-radius:5px; font-weight:bold;">[[About Us|About GorBot]]</span> | |||
<span style="display:inline-block; margin:5px; padding:10px 15px; background:#3b2118; border:1px solid #8d6740; border-radius:5px; font-weight:bold;">[[#support-top|↑ Back to Top]]</span> | |||
</div> | |||
<div style="margin-top:16px; font-size:14px; color:#998b79; font-style:italic;">When requesting help, never include passwords, bot tokens, API keys, database credentials, or other private secrets.</div> | |||
</div> | |||
</div> | |||
</div> | |||
Revision as of 02:58, 17 August 2026