Create system-config-schema.md #146
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Doc add
Updated proper link redirection Removed Example Updat Snowflake id to User ID who
github-actions
bot
added
the
type:docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SudoBot System Configuration
SudoBot's behavior can be customized using a comprehensive system configuration schema. This document provides an overview of key configuration options and how to tailor the bot to your needs.
Table of Contents
Overview
The system configuration for SudoBot is defined using TypeScript and the
zodlibrary. The configuration schema provides a structured way to set various options, allowing you to customize the bot's behavior according to your preferences.Configuration Schema
The SystemConfigSchema defines the entire system configuration. Refer to this file for detailed information on each configuration option.
Emojis
Customize emojis used by the bot. The
emojisconfiguration allows you to set specific emoji strings for different purposes within the bot.System Admins
Specify users with system admin privileges using the
system_adminsconfiguration. Users in this list have elevated access to manage and configure the bot.Snippets
Configure snippet-related settings using the
snippetsconfiguration. This includes options like saving attachments with snippets.Presence
Set the bot's name, status, and activity type using the
presenceconfiguration. Define the bot's online status, custom status message, and activity type.Commands
Customize command-related options using the
commandsconfiguration. For example, enable or disable the mention prefix for commands.Logging
Enable logging and specify channels for logs with the
loggingconfiguration. This section includes options to control various aspects of logging within the bot.API Status
The
apiconfiguration provides information about the bot's API status. Check the operational status of the server and view related details such as server status and description.Extensions
The
extensionsconfiguration allows you to control the default mode for extensions. Specify whether to enable or disable all extensions by default.Log Server
Configure the log server using the
log_serverconfiguration. Options include enabling and auto-starting the log server.Debug Mode
Enable or disable debug mode with the
debug_modeconfiguration. Debug mode provides additional logging and information helpful for troubleshooting.