Configuration property fixed at build time - All other configuration properties are overridable at runtime

Configuration property

Type

Default

Whether a health check should be published for the Gateway clients managed by this extension if the quarkus-smallrye-health extension is present

Environment variable: QUARKUS_DISCORD4J_HEALTH_ENABLED

boolean

true

Whether metrics should be collected for the Gateway clients managed by this extension if the quarkus-micrometer or quarkus-smallrye-metrics extension is present

Environment variable: QUARKUS_DISCORD4J_METRICS_ENABLED

boolean

false

Whether to serialize and register the JSON files found in path as global commands on startup.

Environment variable: QUARKUS_DISCORD4J_GLOBAL_COMMANDS_OVERWRITE_ON_START

boolean

false

The path to the JSON files of the global commands.

Environment variable: QUARKUS_DISCORD4J_GLOBAL_COMMANDS_PATH

string

META-INF/commands

Whether to delete registered global commands whose JSON representation is not found in path.

Environment variable: QUARKUS_DISCORD4J_GLOBAL_COMMANDS_DELETE_MISSING

boolean

false

The bot token used to authenticate to the Discord API.

Environment variable: QUARKUS_DISCORD4J_TOKEN

string

required

The status of the bot.

Environment variable: QUARKUS_DISCORD4J_PRESENCE_STATUS

unknown, online, do-not-disturb, idle, invisible, offline

The Gateway intents that should be enabled. Specific Gateway intents are required to receive certain Gateway events. Non-privileged intents will be enabled by default.

Environment variable: QUARKUS_DISCORD4J_ENABLED_INTENTS

list of Intent

The strategy to use for retrieving Discord entities. Default is cache-fallback-rest.

Environment variable: QUARKUS_DISCORD4J_ENTITY_RETRIEVAL_STRATEGY

EntityRetrievalStrategy

The number of shards that this bot should be split into.

Environment variable: QUARKUS_DISCORD4J_SHARDING_COUNT

int

Which shards from the configured number of shards that this bot will receive events from. The bot will receive events from all specified shards by default.

Environment variable: QUARKUS_DISCORD4J_SHARDING_INDICES

list of int

0

The number of shards that this bot will concurrently identify to the Gateway.

=== This property should only ever be configured if the bot is allowed to use very large sharding. Otherwise, the bot will incur a rate limit when identifying to the Gateway. ===

Environment variable: QUARKUS_DISCORD4J_SHARDING_MAX_CONCURRENCY

int

Whether to serialize and register the JSON files found in path as commands in this guild on startup.

Environment variable: QUARKUS_DISCORD4J_GUILD_COMMANDS__GUILD_COMMANDS__OVERWRITE_ON_START

boolean

false

The path to the JSON files of the guild commands. By default, the path is <global-commands.path> + / + <config-name>

Environment variable: QUARKUS_DISCORD4J_GUILD_COMMANDS__GUILD_COMMANDS__PATH

string

Whether to delete commands registered in this guild whose JSON representation is not found in path.

Environment variable: QUARKUS_DISCORD4J_GUILD_COMMANDS__GUILD_COMMANDS__DELETE_MISSING

boolean

false

The ID of the guild.

Environment variable: QUARKUS_DISCORD4J_GUILD_COMMANDS__GUILD_COMMANDS__GUILD_ID

long

0l

Activity configuration This configuration section is optional

Type

Default

The type of activity.

Environment variable: QUARKUS_DISCORD4J_PRESENCE_ACTIVITY_TYPE

unknown, playing, streaming, listening, watching, custom, competing

required

The name of the activity.

Environment variable: QUARKUS_DISCORD4J_PRESENCE_ACTIVITY_NAME

string

required

The YouTube or Twitch URL of the stream, if the activity type is streaming.

Environment variable: QUARKUS_DISCORD4J_PRESENCE_ACTIVITY_URL

string