Actions

This wiki provides documentation on the available actions that can be configured in the TravelingMerchant plugin for purposes such as sending messages, playing sounds, executing commands, and more.

📦 Example Configuration

Example

actions:
 - broadcast:
   - '&fPlayer &a%player% &fperformed action'
 - message:
   - '&a&nCongratulations you performed an action'

With Conditions

🎉 success-actions

• Executed only if all conditions are met.

❌ failure-actions

• Executed if the conditions are not met.

actions:  
  - conditions:
      - placeholders:
          - 'money>=%price%' # Check if the player has permission
  - success-actions: # Actions to perform if the player has enough money
      - remove-money: '%price%' # Remove money from the player
  - failure-actions: # Actions to perform if the player does not have enough money
      - message: '&cYou do not have enough money to buy this item!' # Message sent if the player does not have enough money

Now let's take a look at what all actions this plugin offerswht a offers

📢 broadcast

Sends a message to all players on the server. Support Color

Syntax

- broadcast:
   - '<message>'

Example:

- broadcast:
   - '&c&lThere is one player online on the server!'

💬 message

Sends a private message to the player who triggered the action. Support Color

Syntax

- message:
   - '<message>'

Example

- message:
   - '&aYou have completed the quest!'

📊 action-bar

Displays a short action bar message above the hotbar for the player. Support Color

Syntax

- action-bar: '<message>'

Example

- action-bar: '&eObjective updated!'

🖥️ title

Displays a title and optional subtitle in the center of the player's screen. Support Color

Syntax

- title: 
    title: '<title>'
    subtitle: '<subtitle>'
    fade-in: fedeIn
    stay: stay
    fade-out: fadeOut

Example

- title: 
    title: '&6Quest Completed!'
    subtitle: '&fYou earned 100 XP'
    fade-in: 10
    stay: 60
    fade-out: 10

Parameters:

• fadeIn, stay, and fadeOut are measured in ticks (20 ticks = 1 second).

🔊 sound

Plays a sound effect to a player. Only works on Spigot/Bukkit

Syntax

- sound: '<sound_name>;<volume>;<pitch>'

Example

- sound: 'BLOCK_ANVIL_FALL;1;1'

💻 console-cmd

Runs a command as the server console. Support Color

Syntax

- console-cmd:
    - '<command>'

Example

- console-cmd:
    - 'minecraft:kill @e[type=!player]'

👤 player-cmd

Runs a command as the player. Support Color

Syntax

- player-cmd:
    - '<command>'

Example

- player-cmd:
    - 'msg Admin Hello!'

🌐 discord

Sends a message or embed to Discord via plugin-integrated webhooks or bots.

Syntax

- discord:
    json: '<JSON embed>'

Example

- discord:
    json: '{
  "content": "Hey, welcome to <:discohook:736648398081622016> **Discohook**! The easiest way to personalise your Discord server.\n\nThere's more info below, but you don't have to read it. If you're ready press **Clear All** in the top of the editor to get started.\n\nDiscohook has a [support server](https://discohook.app/discord), if you need help feel free to join in and ask questions, suggest features, or just chat with the community.\n\nWe also have [complementary bot](https://discohook.app/bot) that may help out, featuring reaction roles and other utilities.\n_ _",
  "embeds": [
    {
      "title": "What's this about?",
      "description": "Discohook is a free tool that allows you to personalise your server to make your server stand out from the crowd. The main way it does this is using [webhooks](https://support.discord.com/hc/en-us/articles/228383668), which allows services like Discohook to send any messages with embeds to your server.\n\nTo get started with sending messages, you need a webhook URL, you can get one via the \"Integrations\" tab in your server's settings. If you're having issues creating a webhook, [the bot](https://discohook.app/bot) can help you create one for you.\n\nKeep in mind that Discohook can't do automation yet, it only sends messages when you tell it to. If you are looking for an automatic feed or custom commands this isn't the right tool for you.",
      "color": 5814783
    },
    {
      "title": "Discord bot",
      "description": "Discohook has a bot as well, it's not strictly required to send messages it may be helpful to have it ready.\n\nBelow is a small but incomplete overview of what the bot can do for you.",
      "color": 5814783,
      "fields": [
        {
          "name": "Getting special formatting for mentions, channels, and emoji",
          "value": "The **/format** command of the bot can give you special formatting for use in Discord messages that lets you create mentions, tag channels, or use emoji ready to paste into the editor!\n\nThere are [manual ways](https://discord.dev/reference#message-formatting) of doing this, but it's very error prone. The bot will make sure you'll always get the right formatting for your needs."
        },
        {
          "name": "Creating reaction roles",
          "value": "You can manage reaction roles with the bot using the **/reaction-role** command.\n\nThe set-up process is very intuitive: type out **/reaction-role create**, paste a message link, select an emoji, and pick a role. Hit enter and you're done, your members can now react to any of your messages to pick their roles."
        },
        {
          "name": "Recover Discohook messages from your server",
          "value": "It can also restore any message sent in your Discord server for you via the apps menu.\n\nTo get started, right-click or long-press on any message in your server, press on apps, and then press **Restore to Discohook**. It'll send you a link that leads to the editor page containing the message you selected!"
        },
        {
          "name": "Other features",
          "value": "Discohook can also grab images from profile pictures or emoji, manage your webhooks, and more. Invite the bot and use **/help** to learn about all the bot offers!"
        }
      ]
    }
  ],
  "attachments": []
}'

🧪 potion

Applies a potion effect to the player. Only available for spigot

Syntax

- potion: '<effect_type>;<duration>;<amplifier>'

Example

- potion: 'SPEED;200;1'

🚫 remove-potion

Removes a specific potion effect from the player. Only available for spigot

Syntax

- remove-potion: '<effect_type>'

Example

- remove-potion: 'SPEED'

💰 add-money

Adds money to the player’s balance (requires an economy plugin like Vault). Only available for spigot

Syntax

- add-money: <amount>

Example

- add-money: 100.0

💸 remove-money

Removes money from the player’s balance. Only available for spigot

Syntax

- remove-money: <amount>

Example

- remove-money: 50.0

🕊️ fly

Enables or disables fly mode for the player. Only available for spigot

First Tab

- fly: <true|false>

Example

- fly: true

🎮 gamemode

Changes the player’s game mode. Only available for spigot

Syntax

Mode: CREATIVE, SURVIVAL, SPECTATOR, ADVENTURE

- gamemode: '<mode>' 

Example

- gamemode: 'creative'

📋open-menu

You open the menu you have in the menu folder

Syntax

- open-menu: '<menu>' # without .yml 

Example

- open-menu: 'example'