Configuration

Configuration

FCDex uses a local TypeScript configuration file named config.ts to manage bot settings, packages, permissions, and other options.

FCDex is under active development, so available settings may change between versions.

Generating the configuration

From the root directory of the project, run:

bun run setup

This creates config.ts using the configuration template embedded in the setup script.

If config.ts already exists, the setup script should preserve it rather than overwrite it.

Configuration sections

The configuration is organized into sections covering different areas of the bot.

Section	Description
discord	Discord application credentials and settings
bot	General bot information
about	Project information
team	Team and contributor information
collectible	Collectible terminology
packages	Feature package configuration
admin	Administrative permissions
owners	Bot owner settings
logging	Logging configuration
appearance	Embed and presentation settings
catch	Catch interactions, messages, and cooldowns
rarity	Rarity tiers and spawn weights
spawning	Automatic spawning settings
trading	Trading configuration
economy	Economy settings
battle	Battle settings
adminPanel	Administration panel settings
extensions	Optional extensions
sentry	Optional error monitoring
prometheus	Optional metrics collection
limits	Operational limits
localisation	Language and text settings

The exact options and their behavior depend on the current implementation.

Discord credentials

FCDex requires valid Discord credentials to connect to Discord.

Create an application through the Discord Developer Portal and configure the required credentials in your local configuration.

Make sure the bot has the permissions and intents needed by the features you enable.

Never publish your bot token or application secrets.

Package configuration

FCDex is designed around a modular package system.

Package settings determine which supported features are enabled. Only enable packages that exist and are compatible with your current version.

See Package System for more information.

Collecting and catching

The catch configuration controls settings associated with catching clubs.

Depending on the implemented features, this may include:

• Catch interaction buttons
• Success and failure messages
• Interaction timeouts
• Cooldowns
• Message placeholders

Message placeholders allow supported messages to include dynamic information, such as a user's name, a club's name, or its rarity tier.

The placeholders available to a message depend on the message formatter implemented by the bot.

Rarity and spawn weights

FCDex is designed to use rarity tiers from T1 to T100.

• T1 represents the rarest tier.
• T100 represents the most common tier.

Spawn weights determine the relative likelihood of different tiers appearing.

Do not guess or invent spawn weights. Configure them using the project's approved rarity data when it becomes available.

Logging and monitoring

Logging settings control how the application reports events and errors.

Optional integrations such as Sentry and Prometheus may require additional configuration and external services. Enable them only when they are supported by your version and you intend to use them.

Security recommendations

• Keep config.ts private.
• Never commit tokens, passwords, or database credentials.
• Do not share unredacted configuration files in support requests.
• Back up your configuration before making substantial changes.
• Review configuration changes when upgrading FCDex.

Related pages

• Installation
• Database Setup
• Running FCDex
• Package System
• Troubleshooting