Skip to content

Latest commit

 

History

History
256 lines (224 loc) · 7.24 KB

CUSTOM_EVENTS.md

File metadata and controls

256 lines (224 loc) · 7.24 KB
Raw

Getting started

Assuming you already have everything else set up, open d4f_custom_events.json in the same folder as the config file in your favorite text editor

Commands

/discord4fabric reload_custom_events: Reloads custom events

Some concepts

  • Event: Executes a list of actions if all of its Constraints are satisfied
  • Action: A command expressing what you want to do
  • Constraint: A condition if the event should execute or not

General structure of custom events

Custom events are defined in JSON format, make sure you are comfortable with that

Comments are not supported

{
  "event_name": {
    "requires": [
      "constraint_1",
      "!negated_constraint_2" // this will be satisfied when negated_constraint_2 is not satisfied
    ],
    "actions": [
      {
        "id": "action_type",
        "value": "action_parameter"
      },
      {
        "id": "action_type2",
        "value": {
          "param1": "used when there are more than",
          "param2": "one parameter for the action type"
        } // and more...
      }
    ]
  },
  "event_name2": {
    // similar to above
  }
}

Events

  • player_join: Triggers when a player joins the server
  • player_leave: Triggers when a player leaves the server
  • player_death: Triggers when a player dies (%d4f:message% placeholder is available for this event, which returns the death message content)
  • server_start: Triggers when the server starts (does not support any constraint)
  • server_stop: Triggers when the server stops (does not support any constraint)
  • discord_message: Triggers when a Discord message is sent in the configured channel (%d4f:message% placeholder is available for this event, returns the message content)
  • minecraft_message: Triggers when a Minecraft message is sent (%d4f:message% placeholder is available for this event, returns the message content)
  • advancement: Triggers when a player achieves an advancement (%d4f:title% placeholder is available for this event, returns the advancement title)

Constraints

linked_account

Supported on player_join, player_leave, minecraft_message, advancement

Check if the player has a linked Discord account

Available placeholders:

  • %linked_account:id%: The player's linked Discord account ID. Example: 349852642123448321
  • %linked_account:fullname%: Full name of user. Example: Reimnop#3147
  • %linked_account:nickname%: Nickname of user. Example: Reimnop
  • %linked_account:discriminator%: The 4-digit tag of the user. Example: 3147

linked_account_nick('value')

Supported on player_join, player_leave, minecraft_message, advancement

Check if the linked account's nickname is value (case insensitive)

linked_account_nick_contains('value')

Supported on player_join, player_leave, minecraft_message, advancement

Check if the linked account's nickname contains value (case insensitive)

linked_account_has_role('role id')

Supported on player_join, player_leave, minecraft_message, advancement

Check if the linked account has role with id role id

operator

Supported on player_join, player_leave, minecraft_message, advancement

Check if the player is an operator (permission level 4)

mc_uuid('uuid')

Supported on player_join, player_leave, minecraft_message, advancement

Check if the player's UUID is uuid

mc_name('value')

Supported on player_join, player_leave, minecraft_message, advancement

Check if the player's name is value (case insensitive)

mc_name_contains('value')

Supported on player_join, player_leave, minecraft_message, advancement

Check if the player's name contains value (case insensitive)

mc_message('value')

Supported on minecraft_message

Check if the player's message is value (case insensitive)

mc_message_contains('value')

Supported on minecraft_message

Check if the player's message contains value (case insensitive)

discord_id('id')

Supported on discord_message

Check if the user's Discord ID is id

discord_name('value')

Supported on discord_message

Check if the user's Discord nickname is value (case insensitive)

discord_name_contains('value')

Supported on discord_message

Check if the user's Discord nickname contains value (case insensitive)

discord_message('value')

Supported on discord_message

Check if the user's Discord message is value (case insensitive)

discord_message_contains('value')

Supported on discord_message

Check if the user's Discord message contains value (case insensitive)

advancement_name('value')

Supported on advancement

Check if the advancement's name is value (case insensitive)

advancement_name_contains('value')

Supported on advancement

Check if the advancement's name contains value (case insensitive)

Actions

run_command: Runs a Minecraft command as Console

value is String. Example:

{
  "id": "run_command",
  "value": "gamemode creative %player:name_unformatted%"
}

Will set a player's gamemode to Creative

send_discord_message: Sends a Discord message in the specified channel

value is String. Example:

{
  "id": "send_discord_message",
  "value": "Hello there, %linked_account:nickname%"
}

Will send a message on Discord with the content Hello there, <linked account's nickname>

send_minecraft_message: Sends a Minecraft message

value is String. Example:

{
  "id": "send_minecraft_message",
  "value": "Congratulations, %player:name%!"
}

Will send a message in-game with the content Congratulations, <player name>!

grant_role: Grants a Discord user a role

value is Object. Example:

{
  "id": "grant_role",
  "value": {
    "user": "%linked_account:id%",
    "role": "993535629453430835"
  }
 }

Will grant the player's linked account the role with ID 993535629453430835

revoke_role: Revokes a Discord user a role

value is Object. Example:

{
  "id": "revoke_role",
  "value": {
    "user": "%linked_account:id%",
    "role": "993535629453430835"
  }
 }

Will revoke the player's linked account the role with ID 993535629453430835

Example custom events

Grant a role to a user with linked account when they join the server and remove it when they leave

{
  "player_join": {
    "requires": [
      "linked_account"
    ],
    "actions": [
      {
        "id": "grant_role",
        "value": {
          "user": "%linked_account:id%",
          "role": "993535629453430835"
        }
      }
    ]
  },
  "player_leave": {
    "requires": [
      "linked_account"
    ],
    "actions": [
      {
        "id": "revoke_role",
        "value": {
          "user": "%linked_account:id%",
          "role": "993535629453430835"
        }
      }
    ]
  }
}

Responding to a specific message

{
  "discord_message": {
    "requires": [
      "discord_message('!hello')"
    ],
    "actions": [
      {
        "id": "send_discord_message",
        "value": "Hey there!"
      }
    ]
  }
}

The %d4f:pig% placeholder is available for all events and constraints and it returns a random Technoblade quote. This is my tribute to the legend. Fly high Technoblade, you will be missed.