Interface GameConfig

interface GameConfig {
    allTimeLowEnabled: boolean;
    allTimeLowMaxPriceCents: null | number;
    allTimeLowStores: GameStore[];
    categoryRoutes: GameCategoryRoute[];
    changelogChannelId: null | string;
    changelogGames: ChangelogGame[];
    changelogPingRoleId: null | string;
    changelogWebhookAvatarUrl?: null | string;
    changelogWebhookEnabled?: null | boolean;
    changelogWebhookUsername?: null | string;
    deliveryMode: GameDelivery;
    discountStores: GameStore[];
    discountsEnabled: boolean;
    enabled: boolean;
    freeDlcEnabled: boolean;
    freeDlcStores: GameStore[];
    freeGameStores: GameStore[];
    freeGamesEnabled: boolean;
    freeWeekendEnabled: boolean;
    freeWeekendStores: GameStore[];
    genres: string[];
    guildId?: string;
    maxPriceCents: null | number;
    minDiscountPercent: null | number;
    notificationChannelId: null | string;
    pingRoleId: null | string;
    robloxChannelId: null | string;
    robloxGames: RobloxGame[];
    robloxPingRoleId: null | string;
    robloxShowNotifyButton?: null | boolean;
    robloxWebhookAvatarUrl?: null | string;
    robloxWebhookEnabled?: null | boolean;
    robloxWebhookUsername?: null | string;
    scheduledHours: number[];
    scheduledWeekdays: number[];
    studios: string[];
    tags: string[];
    trackedGames: TrackedGame[];
    upcomingFreeEnabled: boolean;
    upcomingFreeStores: GameStore[];
    windowEndHour: null | number;
    windowStartHour: null | number;
}

Properties

allTimeLowEnabled allTimeLowMaxPriceCents allTimeLowStores categoryRoutes changelogChannelId changelogGames changelogPingRoleId changelogWebhookAvatarUrl? changelogWebhookEnabled? changelogWebhookUsername? deliveryMode discountStores discountsEnabled enabled freeDlcEnabled freeDlcStores freeGameStores freeGamesEnabled freeWeekendEnabled freeWeekendStores genres guildId? maxPriceCents minDiscountPercent notificationChannelId pingRoleId robloxChannelId robloxGames robloxPingRoleId robloxShowNotifyButton? robloxWebhookAvatarUrl? robloxWebhookEnabled? robloxWebhookUsername? scheduledHours scheduledWeekdays studios tags trackedGames upcomingFreeEnabled upcomingFreeStores windowEndHour windowStartHour

Properties

allTimeLowEnabled

allTimeLowEnabled: boolean

allTimeLowMaxPriceCents

allTimeLowMaxPriceCents: null | number

allTimeLowStores

allTimeLowStores: GameStore[]

categoryRoutes

categoryRoutes: GameCategoryRoute[]

changelogChannelId

changelogChannelId: null | string

changelogGames

changelogGames: ChangelogGame[]

changelogPingRoleId

changelogPingRoleId: null | string

OptionalchangelogWebhookAvatarUrl

changelogWebhookAvatarUrl?: null | string

OptionalchangelogWebhookEnabled

changelogWebhookEnabled?: null | boolean

Custom webhook identity for changelog pings (PREMIUM — Custom Webhooks).

OptionalchangelogWebhookUsername

changelogWebhookUsername?: null | string

deliveryMode

deliveryMode: GameDelivery

Delivery schedule (non-instant is premium). All hours are evaluated in the guild's timezone.

discountStores

discountStores: GameStore[]

discountsEnabled

discountsEnabled: boolean

enabled

enabled: boolean

freeDlcEnabled

freeDlcEnabled: boolean

Master switch for free DLC/loot alerts. freeDlcStores narrows it (empty = all stores).

freeDlcStores

freeDlcStores: GameStore[]

freeGameStores

freeGameStores: GameStore[]

freeGamesEnabled

freeGamesEnabled: boolean

freeWeekendEnabled

freeWeekendEnabled: boolean

freeWeekendStores

freeWeekendStores: GameStore[]

genres

genres: string[]

OptionalguildId

guildId?: string

maxPriceCents

maxPriceCents: null | number

minDiscountPercent

minDiscountPercent: null | number

notificationChannelId

notificationChannelId: null | string

pingRoleId

pingRoleId: null | string

robloxChannelId

robloxChannelId: null | string

robloxGames

robloxGames: RobloxGame[]

robloxPingRoleId

robloxPingRoleId: null | string

OptionalrobloxShowNotifyButton

robloxShowNotifyButton?: null | boolean

Show the "Toggle Notification" self-assign button for the Roblox ping role. Default true; null/absent reads as on, as with the social notifications' showNotifyButton.

OptionalrobloxWebhookAvatarUrl

robloxWebhookAvatarUrl?: null | string

OptionalrobloxWebhookEnabled

robloxWebhookEnabled?: null | boolean

Custom webhook identity for Roblox pings (PREMIUM — Custom Webhooks).

OptionalrobloxWebhookUsername

robloxWebhookUsername?: null | string

scheduledHours

scheduledHours: number[]

scheduled mode: hold every event and flush the batch at each of these hours (0–23).

scheduledWeekdays

scheduledWeekdays: number[]

scheduled mode: restrict flushes to these weekdays (0=Sun … 6=Sat). Empty = every day.

studios

studios: string[]

tags

tags: string[]

trackedGames

trackedGames: TrackedGame[]

upcomingFreeEnabled

upcomingFreeEnabled: boolean

upcomingFreeStores

upcomingFreeStores: GameStore[]

windowEndHour

windowEndHour: null | number

windowStartHour

windowStartHour: null | number

window mode: send instantly inside [windowStartHour, windowEndHour); hold + batch outside until it opens.

Settings

Member Visibility

On This Page

Properties