Skip to content

Bot Configuration

This section contains information on the two /config commands for guilds and factions. You can go to the respective sections below:

Warning

Please be careful who you allow to access the configs, as they can do extensive damage to your configuration or discord server.

Info

  • You must add at least one API Key to your bot prior to configuring anything by using /pair
  • This API Key can be any access level, and is required to satisfy internal bot checks.

Quick Start

If you're setting up the bot for the first time, follow these steps in order to get up and running.

1. Pair your API Key

Before accessing any config, you must register at least one Torn API Key using /pair. This can be any access level and is required for internal bot checks.

2. Configure your Guild

Run /config guild and complete the following:

  1. Set an API Key - Add a Torn API Key to the guild config. See Torn API Key.
  2. Set a Bot Log Channel - This is where bot warnings are sent. See Bot Log Channel.
  3. Configure the Permissions System - Used to control who can access specific bot commands. See Permissions System.

3. Register and Configure your Faction

Run /config faction and complete the following:

  1. Register your Faction - Use the Register Faction shortcut and submit a Limited Access (or higher) Faction API Key.
  2. Add a TornStats Key - Required for spy reports and features that use TornStats spies. See Torn Stats API Key.

4. Enable Modules

Once the core configuration is done, you can enable and configure individual modules through their respective config menus.

  • Guild modules (channels, roles, server-wide settings) → /config guild
  • Faction modules (faction-specific alerts and features) → /config faction

Guild Config Introduction

The Guild Config is the config which contains discord server wide settings within your bot, such as shared channels, roles and the permissions system.

An example of a module which is only found in the guild config is the Stock Market module, as there is no need for the channels or roles to be set a on faction-by-faction basis.

When you run /config guild, you can see and edit:

You can find more specific information about each of these settings in the dedicated Guild Configuration page

Info

  • Most services can continue to operate, even without a API Key being configured in the Guild Config
  • A guild is commonly referred to as a 'Discord Server'

Faction Config Introduction

The faction config is the config which contains faction specific settings, this can also be roles, channels and settings.

An example of a module which is found in only the faction config is the Retaliations module, as the retaliations are specific to each individual faction.

When you run /config faction, you can see and edit:

  • API Key
  • TornStats Key
  • Module Settings

You can find more specific information about these settings in the dedicated Faction Configuration page

Info

  • All faction services will cease to operate if a Faction API Key is not set in the faction config