Do you want to send Discord embed messages with ease? Do you want to announce things with nice and customizable messages using commands? This plugin is for you!
Edit config files in plugins/DiscordSender directory (see Configuration below)
Reload plugin using /dsend reload command
Here is default configuration file. To see more details, visit our wiki page.
Code (YAML):
###################################################### # # General Configuration Section # ######################################################
# It loads messages from "messages_<lang>.yml' file. You can copy the english file and rename it, # or you can just translate the english file and let this be. lang: en
# In case you want to pass multi-word arguments, you need to use this placeholder instead of regular space # This is because plugin cannot differ between more arguments or one multi-word argument. # Example: Instead of 'This is test text' you need to use 'This#is#test#text' spacePlaceholder: "#" # In case you want to split the line, you can use this placeholder. # Example: 'Line1:n:Line2'. You can combine it with spaces (see above). newLinePlaceholder: ":n:"
# Default webhook used when no-one is defined. Can be set to "NONE", if you don't want default webhook. defaultWebhook: "https://discord.com/api/webhooks/XXX/YYY"
# Here you can define default color, if no-one is defined. defaultColor:
red: 255
green: 0
blue: 0
# List of your webhooks. You can add as many as you want. Names are then used in messages section below. webhooks:
global_chat: "https://discord.com/api/webhooks/XXX/YYY" staff_chat: "https://discord.com/api/webhooks/XXX/YYY"
###################################################### # # Messages List Section # ######################################################
# List of your messages. In 'full_example' you can see every feature it contains. # Placeholders %arg_<number>% can be used. These are replaced by the plugin when using command. # # INGAME USAGE: # # Syntax: /dsend send <message_name> <arg_1> <arg_2> ... <arg_x> # Permission: discordsender.use.<message_name> # # NOTE! Use 'NONE' if you don't want to set the option, or just remove the line! # # Every line below is removable except message_name!!! But be careful, see examples before. messages: # This is an example of short message with only basic features. For explanation of individual # fields, check full example below or our wiki page: https://foresttech.gitbook.io/discordsender # If you want to try this example: /dsend send short_example <banned_user> <banned_user> short_example:
description: "Player %arg_1% was banned for %arg_2%!" title:
text: "Banned! [**%arg_1%**]" footer:
text: "Do NOT break the rules! It's not worth it!" # This is an example of full feature usage. You can see every possible options. You can remove any option you want. # But be careful with what are you doing. # If you want to try this: /dsend send full_example <player> <event_name> <starting_in> full_example: # If you remove this line or set it to 'NONE', default webhook will be used. webhookName: "global_chat" # Color of the embed (RGB) color:
red: 20
green: 200
blue: 20
# Description of the embed description: "Event was announced! It is held by **%arg_1%**!" # URL to image under the embed imageUrl: "NONE" # URL to small image displayed inside the embed thumbnailUrl: "https://minotar.net/avatar/%arg_1%/100.png" # Set properties of author. You can remove this section if you don't want to display author. author:
text: "*Held by: %arg_1%*" iconUrl: "NONE" url: "NONE" # Set the title. You can remove 'url' line, or set it to NONE if you want. title:
text: "Event starting soon!" url: "https://google.com" # Self explaining. footer:
text: "Be careful and join as soon as you can!" iconUrl: "NONE" # List of fields. You can add as many as you want. # If you don't want to use fields, remove this section completely. fields:
my_field: # Shall the field be inline? inline: false
title: "Event Type:" text: "%arg_2%" my_field_2:
inline: false
title: "It will start:" text: "in %arg_3%"
Plugin has two commands and three permissions:
/dsend reload Reloads the plugin and it's config files
/dsend send <message_name> <arguments> Sends the message configured in config.yml with passed arguments.
NEW! /dsend sendPlaceholders <player_name> <message_name> <arguments> Sends the message configured in config.yml with passed arguments and also replaces placeholders using PAPI.
Example usage:
/dsend full_example apik007 Spleef#(PvP) 15#minutes Sends the message "full_example" with 3 arguments. # means space (can be changed in config.yml)
Permissions:
discordsender.reload Allows player to use /dsend reload command
discordsender.use Required in order to send messages
discordsender.use.<message_name> Allows player to use /dsend <message_name> <args> command.
discordsender.use.* Allows player to send all messages.
Note! Permission discordsender.use is needed in order to use the send command!