Skip to content

First Time Server Setup

Alicia G edited this page Aug 13, 2025 · 6 revisions

First Time Server Setup

Welcome, Administrator! Once Scryarc has been invited to your server, your first step is to configure it to match your community's needs.

Under its new architecture, Scryarc is a powerful Game Template Engine. This means that instead of setting many individual global options, your primary setup task is to review and customize the default "blueprint" that Scryarc will use to create new game spaces.


Step 1: The First Command & Automatic Template Creation

The first time you run any /config command on a new server, Scryarc will automatically perform its initial setup. This includes creating a versatile, pre-loaded template named "Starter Campaign" and a default "Carl-bot (Default)" permission profile. These are loaded from Scryarc's shared community data.

To begin, simply view the current configuration:

  • Command: /config view

This will confirm that the bot is active and has created your initial configuration.


Step 2: Configure Core Server Settings with /config modify

The /config modify command is your primary tool for setting up Scryarc. You can set multiple options in a single command.

  • Command: /config modify <option1>: <value> <option2>: <value> ...
  • Permissions: By default, only Discord Guild Administrators can use /config commands. You can delegate this by setting a Scryarc Config Admin Role in this step.

Here are the key settings you should consider:

  1. Set Server Admin Roles (Optional but Recommended)

    • Scryarc Config Admin Role: Designate a role that can use all /config commands.
      • Command: /config modify config_admin_role: @YourConfigRole
    • Scryarc Game Admin Role: Designate a role whose members can always create games, bypassing any server-set restrictions.
      • Command: /config modify game_admin_role: @YourGameAdminRole
  2. Set Your Game Creation Mode

    • Decide who is allowed to use your templates to create games.
    • Command: /config modify mode: <Mode>
    • Options:
      • open: Any server member can create games.
      • role_restricted: Only members with a specific role can create games. (Requires allowed_role to be set.)
      • moderator_approval: All requests must be approved by your staff. (Requires moderator_channel to be set.)
  3. Configure Game Creation Dependencies (if using role_restricted or moderator_approval modes)

    • For role_restricted mode: Designate the role allowed to create games.
      • Command: /config modify allowed_role: @YourCreatorRole
    • For moderator_approval mode: Designate the channel for approval requests.
      • Command: /config modify moderator_channel: #your-mod-channel
  4. Set Channel Categories (Optional but Recommended)

    • Tell Scryarc where to create new game channels.
    • Command: /config modify public_category: #PublicCategory private_category: #PrivateCategory
    • Details: You must specify a category for public games. The private category is optional.
  5. Set Channel Naming Template (Optional)

    • Customize the naming convention for all new game channels.
    • Command: /config modify naming_template: {GameName}-{GMUsername}-{YYMMDD}
    • Details: Use Available Placeholders to dynamically insert game and user info.
  6. Set Default Bot Permission Profile (Optional)

    • Choose a default set of permissions for other bots (like Carl-bot) in new game channels.
    • Command: /config modify default_permission_profile_id: carl_bot_default (or the ID/name of a custom profile).

Step 3: Review and Customize Your Game Template

The "Starter Campaign" template is loaded automatically and designed to be a great starting point. You should review its structure and customize it to fit your server perfectly.

  1. View Template Details: (Future Command)

    • Currently, detailed viewing and editing of templates will be via dedicated interactive commands or a web dashboard. For now, the template is loaded and ready for use.
  2. Customize Template: (Future Command)

    • The /config template edit command suite will be implemented soon to allow interactive modification of templates.

You're All Set!

Your server is now fully configured with a custom game template and a clear policy for player and game creation. Users who meet the criteria you've set can now use the /new_game command.


Where to Next?

Clone this wiki locally