Skip to content

Default custom placeholders.yml

Lilac edited this page Oct 17, 2023 · 5 revisions
# Placeholders allow text, hover events, click events, and placeholders from PlaceholderAPI.
# These can be used in several sections within the other configs to add more information to chat.

# RoseChat has a few placeholders that do not require PlaceholderAPI:
# %player_name% - The player's name.
# %player_displayname% - The player's displayname.
# %group% - The ID of the group a message is sent in.
# %group_name% - The name of the group a message is sent in.
# %group_owner% - The owner of the group a message is sent in.
# %channel% - The name of the channel a message is sent in.
# %player_nickname% - The player's nickname, which is created by using RoseChat's /nick command.
#                     If a nickname does not exist, the displayname will be used.
#                     If the displayname does not exist, the name will be used.
# These placeholders can be prefixed with "other_" to get the viewer rather than the sender.
# For example, %other_player_name% gets the name of the viewer.
# {message} - An internal placeholder that is reserved for the player chat input.

# The ID of the custom placeholder.
prefix:
  # This defines the text that will be shown.
  text:
    # Each custom placeholder has a condition that can be used.
    condition: "%vault_rank%"
    # These are the options that the condition's value needs to output.
    # If the player has a %vault_rank% output of "mod", their prefix will be set to "&8[&dMod&8] &d".
    # If the placeholder fails to get a result, or the placeholder is invalid, the "default" value will be used.
    # If a default value doesn't exist, nothing will happen.
    default: "&7"
    mod: "&8[&dMod&8] &d"
    admin: "&8[#C0FFEEAdmin&8] #C0FFEE"
  # This defines the hover event for this custom placeholder. This is optional.
  hover:
    condition: "%vault_rank%"
    mod:
      - "&dThis player moderates the server!"
    admin:
      - "&cThis player administrates the server!"

player:
  text:
    # If no condition is specified, the default value will be used.
    default: "%player_nickname%"
  hover:
    default:
      - "&7Username: &f%player_name%"
      - "&7Click to Message"
  # This defines the click event for this custom placeholder. This is optional.
  click:
    action: SUGGEST_COMMAND
    default: "/msg %player_name% "

# This custom placeholder is the last one used before the {message} placeholder.
# This means that the last color in this custom placeholder will be the default colour of the message.
separator:
  text:
    default: " &e» &f"

# These custom placeholders are used in the private message format.
message-sent:
  text:
    default: "&8[&eYou &6-> &f%other_player_nickname%&8] &f"
  hover:
    default:
      - "&6From: &f%player_name%"
      - "&eTo: &f%other_player_name%"
      - "&7Click to Reply"
  click:
    action: SUGGEST_COMMAND
    default: "/r "

message-received:
  text:
    default: "&8[&f%player_nickname% &6-> &eYou&8] &f"
  hover:
    default:
      - "&6From: &f%player_name%"
      - "&eTo: &f%other_player_name%"
      - "&7Click to Reply"
  click:
    action: SUGGEST_COMMAND
    default: "/r "

console-message:
  text:
    default: "&8[&f%player_nickname% &6-> &e%other_player_nickname%&8] &f"

# These custom placeholders are used in the group format.
group-prefix:
  text:
    default: "&8[&b%group_name%&8] &f"
  hover:
    default:
      - "&7Owner: &e:star: &7%group_owner%"
      - "&7Click to Message"
  click:
    action: SUGGEST_COMMAND
    default: "/gcm %group% "

group-member-prefix:
  text:
    condition: "%group_owner%=%player_name%"
    default: ""
    true: "&e:star: &7"
  hover:
    default:
      - "&7This person owns the group chat."

# These custom placeholders are used for different channel formats.
staffchat:
  text:
    default: "&8[&cStaff&8] &f"
  hover:
    default:
      - "&7A chat channel that only staff members can see."
      - "&7Command: &c/staff"

channel-prefix:
  text:
    condition: "%channel%"
    staff: "&8[&cStaff&8] &f"
    local: "&8[&7Local&8] &f"
    skyblock: "&8[&aSkyblock&8] &f"
  hover:
    condition: "%channel%"
    staff:
      - "&7A chat channel that only staff members can see."
      - "&7Command: &f/staff"
    local:
      - "&7A chat channel that only nearby players can see."
    skyblock:
      - "&aYou're playing Skyblock!"

# These custom placeholders are used for social spy.
spy-prefix:
  text:
    default: "&6[&eSocialSpy&6] &f"

spy-players:
  text:
    default: "&8[&f%player_nickname% &6-> &f%other_player_nickname%&8] &f"

# This custom placeholder is used for deleting messages.
# This custom placeholder only uses the %type% condition as permissions are checked internally.
# The %id% placeholder is used for the id of the message being deleted.
# The %type% placeholder is used for the type of message, server or client.
# The %channel% placeholder is used to choose which servers should also delete the message, when using BungeeCord.
delete-message:
  text:
    condition: "%type%"
    client: "&c&l✖ "
    server: "&4&l✖ "
  hover:
    default:
      - "&7&oClick to Delete"
  click:
    action: RUN_COMMAND
    default: "/delmsg %id% %channel%"

# This custom placeholder is used when a message is deleted.
# This custom placeholder can be removed and no message will be shown when a message is deleted.
# This custom placeholder does not need conditions.
# The %original% placeholder is used for the original message that was deleted.
deleted-message:
  text:
    condition: "%type%"
    client: ""
    server: "&7&oMessage Deleted"
  hover:
    condition: "%player_has_permission_rosechat.deletemessages.see%"
    true:
      - "%original%"

# These custom placeholders are used for tags.
# The %tagged% placeholder is used for the thing that was tagged.
# The 'other_player' is the player who was tagged.
player-tag:
  text:
    default: "&e@%other_player_nickname%"

money:
  text:
    default: "&a$%group_1%"
  hover:
    default:
      - "&7Click to pay &f%player_nickname% &a$%group_1%"
  click:
    action: SUGGEST_COMMAND
    default: "/pay %player_name% %group_1%"

# This custom placeholder uses 1 character in the text.
# This is because the tag has match-length enabled in the tags.yml file.
# This message will be repeated as many times as the amount of letters in the tag.
spoiler-tag:
  text:
    default: "&0⬛"
  hover:
    default:
      - "%group_1%"

url:
  text:
    default: "&9&n%group_1%"
  hover:
    default:
      - "&7Click to Open"
  click:
    action: OPEN_URL
    default: "%group_2%"

# This placeholder allows an item to be shown in chat.
# The %item_name% placeholder is used for the name of the item.
# The %item% placeholder is used for the item itself.
item:
  text:
    default: "&7» &e%item_name% &7«"
  hover:
    action: SHOW_ITEM
    default:
      - "%item%"

# Discord placeholders:
# %user_nickname% - The user's nickname.
# %user_name% - The user's name.
# %user_role% - The user's role.
# %user_color% - The user's color.
discord-player:
  text:
    default: "&8[%user_color%%user_role%&8] %user_color%%user_nickname%"
  hover:
    default:
      - "&7Discord: &f%user_name%"

# This is a unique custom placeholder.
# These options will do nothing in-game, they are only for Discord.
discord:
  text:
    default: "{channel-prefix}{prefix}{player}{separator}{message}"

from-discord:
  text:
    default: "&dDiscord &7| "

discord-channel-link:
  text:
    default: "#856896#%channel_name%"
  hover:
    default:
      - "&7Click to Open"
  click:
    action: OPEN_URL
    default: "https://discord.com/channels/%server_id%/%channel_id%"