Detailed Guide: config

Detailed Guide: /config

The /config command is the central control panel for Scryarc on your server. It is a powerful command that allows you to customize every aspect of the bot's behavior to fit your community's needs.

Access to /config Commands: Access to Scryarc's /config commands is tiered:

1. Discord Guild Administrators: Any member with Discord's built-in Administrator permission can always use all /config commands.
2. Scryarc Config Administrators: You can designate a specific server role as a "Scryarc Config Admin" using /config modify config_admin_role: @YourConfigRole. Members with this role will also have full access to all /config commands, without needing full Discord administrator privileges.

---

Subcommand: view

• Description: Displays the current configuration settings for Scryarc on your server.
• Usage: /config view
• Details: This command provides a comprehensive, read-only embed that summarizes all current settings, including the game creation mode, configured channels and roles, the channel naming template, and your server's premium status and game limits. It's the best way to get a quick overview of how the bot is configured.

---

Subcommand: modify

• Description: This powerful subcommand allows you to modify multiple server configuration settings simultaneously. Instead of separate commands for each setting, you can now adjust any combination of options in a single line.
• Usage: /config modify <option1>: <value> <option2>: <value> ...
• Details: Provide only the options you wish to change. Any options not provided will remain at their current setting.

modify Options:

• mode

  • Description: Sets the game creation mode for the server.
  • Values:
    • open: Allows any server member to use /new_game to create games instantly.
    • role_restricted: Only members with a specific, designated role (set via allowed_role) can create games instantly.
    • moderator_approval: All game creation requests are sent to a moderator channel (set via moderator_channel) to be approved or denied.

• allowed_role

  • Description: Designates the specific Discord role that is allowed to create games when the server is in role_restricted mode.
  • Value: Mention the role (e.g., @Game Creator). If you set this and the mode is not role_restricted, this setting will be ignored.

• public_category

  • Description: The Discord category where new public game channels will be created.
  • Value: Mention the category (e.g., #Public Games).

• private_category

  • Description: The Discord category where new private game channels will be created.
  • Value: Mention the category (e.g., #Private Games). This is optional; if not set, private games will be placed in the public_category.

• moderator_channel

  • Description: Designates the text channel where new game approval requests are sent when the server is in moderator_approval mode.
  • Value: Mention the channel (e.g., #mod-log).

• naming_template

  • Description: Sets the template used for automatically naming all new game channels.
  • Value: A string containing text and placeholders (e.g., {GameName}-{GMUsername}-{YY}).
    • Available Placeholders: The bot will list all available placeholders when you type the option in Discord. Examples include {GameName}, {GMName}, {GameSystem}, {GameID}, {Privacy}, {YYYY}, {MM}, {DD}, etc.
    • Reset to Default: To reset the naming template to the default ({GameName}), use the special keyword {DEFAULT} (e.g., /config modify naming_template: {DEFAULT}).

• default_permission_profile_id

  • Description: Sets the default Bot Permission Profile to apply to bots in new game channels. You can use either the profile's unique ID or its exact name.
  • Value: The ID or exact Name of an existing Bot Permission Profile.
  • Clear Setting: To remove the default permission profile, use the special keyword {CLEAR} (e.g., /config modify default_permission_profile_id: {CLEAR}).

• game_admin_role

  • Description: Designates a server role whose members can bypass game creation restrictions (e.g., role_restricted mode). These members can always create games regardless of server settings.
  • Value: Mention the role (e.g., @Game Master).
  • Clear Setting: To remove this role, use the special keyword {CLEAR} (e.g., /config modify game_admin_role: {CLEAR}).

• config_admin_role

  • Description: Designates a server role whose members can use all /config commands. This allows you to delegate configuration management without granting full Discord Administrator permissions.
  • Value: Mention the role (e.g., @Scryarc Manager).
  • Clear Setting: To remove this role, use the special keyword {CLEAR} (e.g., /config modify config_admin_role: {CLEAR}).

---

Subcommand: permissions

• Description: Allows you to view and manage custom bot permission profiles for Game Masters.
• Usage: /config permissions
• Details: This command will display a list of the custom permission profiles you have created for your server. A permission profile is a saved set of Discord permissions (e.g., "Manage Messages", "Kick Members") that can be automatically applied to GMs. The creation and management of these profiles will be handled through this command's future interactive components.

---

Where to Next?

• Now that you're configured, see the user-facing side of things in the Detailed Guide: /new_game.
• Learn how to archive a game with the Detailed Guide: /archive_game.