Variable: config

const config: object;

Configuration management for XP system

Provides comprehensive configuration management with validation, defaults, and guild-specific overrides. All configuration changes are persisted to Flashcore immediately.

Features:

• Guild-specific and global configuration
• Automatic validation with detailed error messages
• MEE6-compatible defaults for seamless migration
• Role rewards, multipliers, and No-XP zones
• Cache invalidation when using setGlobal

Config Precedence (highest to lowest):

1. Guild-specific config (via config.set())
2. Global config defaults (via config.setGlobal())
3. System defaults (MEE6 parity)

Type declaration

get()

get: (guildId) => Promise<GuildConfig> = getConfig;

Get guild configuration with all defaults applied

Retrieves guild configuration with all defaults applied Primary entry point for reading guild configuration

Parameters

Parameter	Type	Description
guildId	string	Guild ID

Returns

Promise<GuildConfig>

Complete GuildConfig (never null, uses defaults if needed)

Example

const config = await getConfig('123456789012345678')
if (config.cooldownSeconds > 0) {
  // Check cooldown before awarding XP
}

getDefault()

getDefault: () => GuildConfig = getDefaultConfig;

Get default configuration (MEE6 parity)

Returns default guild configuration (MEE6 parity)

Returns

GuildConfig

GuildConfig with all default values

Example

const defaults = getDefaultConfig()
console.log('Default cooldown:', defaults.cooldownSeconds) // 60

getGlobal()

getGlobal: () => Promise<GlobalConfig> = getGlobalConfig;

Get global configuration defaults

Retrieves current global configuration defaults

Returns

Promise<GlobalConfig>

GlobalConfig (empty object if not set)

Example

const global = await getGlobalConfig()
console.log('Global cooldown:', global.cooldownSeconds ?? DEFAULT_COOLDOWN)

set()

set: (guildId, partial) => Promise<GuildConfig> = setConfig;

Update guild configuration with validation

Updates guild configuration with validation Merges partial values with existing config

Parameters

Parameter	Type	Description
guildId	string	Guild ID
partial	Partial<GuildConfig>	Partial config to merge

Returns

Promise<GuildConfig>

Complete merged GuildConfig

Throws

Error if validation fails

Example

const updated = await setConfig('123...', {
  cooldownSeconds: 90,
  roleRewards: [
    { level: 5, roleId: '345678901234567890' }
  ]
})

setGlobal()

setGlobal: (config) => Promise<void> = setGlobalConfig;

Set global configuration defaults

Updates global configuration defaults Clears all guild config caches to force re-merge on next access

Parameters

Parameter	Type	Description
config	Partial<GuildConfig>	Partial config to use as global defaults

Returns

Promise<void>

Throws

Error if validation fails

Example

await setGlobalConfig({
  cooldownSeconds: 90,
  xpRate: 1.2
})

validate()

validate: (config) => object = validateConfig;

Validate configuration object

Validates configuration object

Parameters

Parameter	Type	Description
config	Partial<GuildConfig>	Partial config to validate

Returns

object

Validation result with error messages

errors

errors: string[];

valid

valid: boolean;

Example

const result = validateConfig({ cooldownSeconds: -10 })
if (!result.valid) {
  console.error('Errors:', result.errors)
}

Examples

Basic Configuration

import { config } from '@robojs/xp'

// Get guild config (creates with defaults if not found)
const guildConfig = await config.get('123456789012345678')
console.log(`Cooldown: ${guildConfig.cooldownSeconds}s`)

// Update guild config
await config.set('123456789012345678', {
  cooldownSeconds: 120, // 2 minutes between XP awards
  xpRate: 1.5 // +50% XP boost for entire guild
})

Role Rewards Configuration

import { config } from '@robojs/xp'

// Configure role rewards with stack mode (users keep all qualifying roles)
await config.set('123456789012345678', {
  roleRewards: [
    { level: 5, roleId: '234567890123456789' },
    { level: 10, roleId: '345678901234567890' },
    { level: 25, roleId: '456789012345678901' }
  ],
  rewardsMode: 'stack', // Users accumulate all roles
  removeRewardsOnLoss: false // Keep roles even if user loses XP
})

// Configure with replace mode (only highest level role)
await config.set('123456789012345678', {
  rewardsMode: 'replace' // Users get only their highest qualifying role
})

XP Multipliers (MEE6 Pro Parity)

import { config } from '@robojs/xp'

// Set up multipliers for premium users
await config.set('123456789012345678', {
  multipliers: {
    user: {
      'premiumUserId1': 1.5, // +50% XP boost
      'vipUserId2': 2.0 // +100% XP boost (double XP)
    },
    role: {
      'boosterRoleId': 1.2, // +20% for server boosters
      'donorRoleId': 1.3 // +30% for donors
    }
  }
})

// Multipliers stack: user with both roles gets 1.2 * 1.3 = 1.56x total

No-XP Zones Configuration

import { config } from '@robojs/xp'

// Configure roles and channels to exclude from XP gains
await config.set('123456789012345678', {
  noXpRoles: [
    'mutedRoleId', // Muted users don't gain XP
    'botRoleId' // Bots don't gain XP
  ],
  noXpChannels: [
    'spamChannelId', // Spam channels don't award XP
    'botCommandsChannelId' // Command channels excluded
  ]
})

Validation Before Updates

import { config } from '@robojs/xp'

// Validate config before applying
const userConfig = {
  cooldownSeconds: -10, // Invalid: negative value
  xpRate: 'invalid' // Invalid: not a number
}

const validation = config.validate(userConfig)
if (!validation.valid) {
  console.error('Config validation failed:', validation.errors)
  // Errors: ['cooldownSeconds must be non-negative', 'xpRate must be a number']
} else {
  await config.set(guildId, userConfig)
}

Global Defaults for Bot Networks

import { config } from '@robojs/xp'

// Set global defaults for all guilds
await config.setGlobal({
  cooldownSeconds: 90, // Default 90s cooldown for all guilds
  xpRate: 1.0,
  rewardsMode: 'stack'
})

// Individual guilds can still override
await config.set('specificGuildId', {
  cooldownSeconds: 60 // This guild uses 60s instead of global 90s
})

MEE6 Migration Setup

import { config } from '@robojs/xp'

// Default config already matches MEE6 - no setup needed!
const defaultConfig = config.getDefault()
console.log(defaultConfig)
// {
//   cooldownSeconds: 60,
//   xpRate: 1.0,
//   rewardsMode: 'stack',
//   removeRewardsOnLoss: false,
//   ...
// }

// Or explicitly get MEE6-compatible config
const guildConfig = await config.get('123456789012345678')
// Returns MEE6-compatible defaults if not customized

Remarks

• Config changes are validated before persistence
• Global config updates invalidate caches for consistency
• Default MEE6 settings: 60s cooldown, 15-25 XP/msg, stack mode
• Multipliers stack multiplicatively (user * role * guild)