Discord Link Manifest

Configure Discord linking and role synchronization

BefehlBereitgestellt von Discord

Manifest entry configuring how Discord linking behaves inside TypeWriter. The /{commandName} command (with its unlink subcommand) is registered through the engine's [CustomCommandEntry] pipeline, so it follows engine reloads without any reflection.

Felder

Feld	Typ	Standard	Beschreibung
commandName	String	discordlink	Command players run to generate a link code; '<command> unlink' removes the link
storage	Ref<DiscordLinkArtifactEntry>	—	Artifact entry used to persist link information
webhook	Ref<WebhookDefinitionEntry>	—	Webhook used to post link instructions/confirmations
bot	DiscordBotSettings	—	Discord Bot configuration for listening to codes and syncing roles DiscordBotSettings (4) Feld Typ Standard Beschreibung enabled Boolean false Enable the bot (required for code verification & role sync) botToken String — Bot token from the Discord Developer Portal guildId String — Discord server (guild) ID where the bot operates messages DiscordBotVerificationMessages — Messages sent by the bot in the verification channel DiscordBotVerificationMessages (2) Feld Typ Standard Beschreibung success String Code accepted for {player}. Reply posted when a code is accepted (placeholders: {player}, {code})PlatzhalterMehrzeilig failure String Invalid code for {player}. Reply posted when a code is rejected/invalid (placeholders: {player}, {code})PlatzhalterMehrzeilig
verificationChannelId	String	—	Discord text channel ID where the bot listens for verification codes
codeLength	Int	6	Number of characters for generated verification codes
codeValidityMinutes	Long	10	Validity duration (in minutes) for generated codes
autoOverwriteExistingLink	Boolean	false	Automatically overwrite existing links when a new code is confirmed
notifyPermission	String	discordlink.notify	Permission required to receive link notifications (empty disables them)
groupPermissionFormat	String	group.{group}	Permission checked per mapping to pick the player's group. {group} is replaced by the mapping's Minecraft group
roleMappings	List<RoleMapping>	empty	Mappings between Minecraft groups and Discord Role IDs RoleMapping (2) Feld Typ Standard Beschreibung minecraftGroup String default — discordRoleId String 000000000000000000 —
onLinkTriggers	List<Ref<TriggerableEntry>>	empty	Entries triggered for the player when their Discord link is confirmed
messages	DiscordLinkMessages	—	Player facing messages, including menu text (placeholders: {code}, {duration}, {discord}, {player}) DiscordLinkMessages (11) Feld Typ Standard Beschreibung alreadyLinked String You have already linked your Discord account. — linkInstructions String Use the code **{code}** within {duration} on Discord to complete the link. — codeGenerated String A new Discord verification code has been generated: {code} (expires in {duration}). — pendingExists String You already have a pending code: {code} (expires in {duration}). — linkConfirmed String Discord account {discord} is now linked to {player}. — linkRevoked String The link with {discord} has been revoked. — unlinkSuccess String Your Discord account has been unlinked successfully. — unlinkNoLink String You don't have a Discord account linked. — linkUnavailable String Discord linking is not configured on this server. — embedLinkedTitle String Discord account linked — embedUnlinkedTitle String Discord account unlinked —

How to use it

This entry registers the player command (commandName, default discordlink) and runs the bot used by the rest of the extension.

1. Set bot.enabled, bot.botToken and bot.guildId. Without an enabled bot there is no verification and no role sync, and the chat relay, console channel and slash commands cannot work either.
2. Set storage to a Discord Link Storage artifact, and webhook to the destination where link messages are posted (optional).
3. Set verificationChannelId: the Discord channel where the player types the code.
4. The player runs /discordlink, receives a code of codeLength letters and digits valid for codeValidityMinutes, and types it in the channel. The bot reacts with a check or a cross, and deletes an accepted code.
5. roleMappings pairs a minecraftGroup with a discordRoleId. A player gets the role of the first mapping whose permission (groupPermissionFormat, where {group} is replaced by the group) they hold. Roles are synced when the link is confirmed and each time the player joins.
6. onLinkTriggers runs entries for the player when the link is confirmed, for example a reward.

The messages can use {code}, {duration}, {discord} and {player} depending on the message.