SignLink
SpigotMCModrinthDisplay generated text and variables on signs dynamically
14.6k downloads 5.0 rating
latest v1.21.5-v1 SpigotMC
!! This plugin requires BKCommonLib to be installed. !!
Join our discord for plugin help https://discord.gg/wvU2rFgSnw
Builds for 1.7.2 R0.1/R0.2 can be found here
Description
This plugin acts as a bridge between plugins and signs to easily display text on signs. Instead of entering commands, clicking the sign, or any other routine plugins could use, players can enter 'variables', key values starting (and ending) with %, to show information at that spot.
It also includes features no other plugin is needed for, such as custom text and ticker values you can set in values.yml. Signs are stored on file, they survive reloads and server restarts.
A video says 1000 times more words than a picture.
Command Blocks
To change variables using command blocks, you can chain the edit and set commands
Code (Text):
/variable edit varname set newvalue
As of version 1.16.5-v1, it is possible to declare variable names inside the value for a variable. For example, you can do:
Code (Text):
/variable edit message set Hello, %playername%! It is %time%
Commands
The following commands are supported by SignLink. For in-game information you can use /help. The /variable command has alias /var.
/togglesignupdate
Turns sign updating on or off
/reloadsignlink
Reloads the variable values in values.yml
/variable list
Lists all variables you can edit
/variable deleteall
Deletes all variables
/variable deleteunused
Deletes all unused (not on sign) variables
/variable edit [name]
Changes the variable you are editing. Can be chained with other commands.
/variable forplayers [names]
Changes for which players the variable is edited Only the set players will see the changes you do on the variable
/variable set [value]
Sets the currently editing variable's value
/variable get
Gets the currently editing variable's value
/variable setticker [args]
Sets a ticker mode for a variable to animate the text. Arguments:
/variable setticker [left/right/blink/none] [interval]
/variable setticker [interval] [left/right/blink/none]
/variable setticker [left/right/blink/none]
/variable setticker [interval]
/variable delete (force)
/variable setticker [left/right/blink/none] [interval]
/variable setticker [interval] [left/right/blink/none]
/variable setticker [left/right/blink/none]
/variable setticker [interval]
Deletes the variable if it is not used. If force is specified, the variable is removed anyhow.
Configuration
The linkedsigns.txt contains information of where signs are located. The values.yml sets the (standard) usable keys.
Code (Text):
# In here you can set default values for this plugin.
# The ticker property can be LEFT, RIGHT or NONE and sets the direction message is 'ticked'.
# tickerInterval sets the amount of ticks (1/20 of a second) are between the ticker update.
# The value is the thing to display or tick.
# To use colors in your text, use the § sign followed up by a value from 0 - F.
# Example: §cRed to display a red colored 'Red' message.
# You can find all color codes on the internet (they may use & there, ignore that!)
sign:
ticker: NONE
value: This is a regular message you can set and is updated only once.
test:
tickerInterval: 3
ticker: LEFT
value: 'This is a test message being ticked from right to left. '
# The ticker property can be LEFT, RIGHT or NONE and sets the direction message is 'ticked'.
# tickerInterval sets the amount of ticks (1/20 of a second) are between the ticker update.
# The value is the thing to display or tick.
# To use colors in your text, use the § sign followed up by a value from 0 - F.
# Example: §cRed to display a red colored 'Red' message.
# You can find all color codes on the internet (they may use & there, ignore that!)
sign:
ticker: NONE
value: This is a regular message you can set and is updated only once.
test:
tickerInterval: 3
ticker: LEFT
value: 'This is a test message being ticked from right to left. '
Signlink supports the PlaceholderAPI plugin in both directions. This means that you can use Signlink to display placeholders on signs, or use signlink variables in other plugins that support placeholders.
- You can use signlink variables in other plugins by prefixing it with sl_. For example, %sl_time% will display the time variable.
- Adding placeholder names to the 'autoUpdateVariables' list in SignLink's config.yml will make them work on signs, with the same name. You can also use /var edit name papiautoupdate to add it.
- To display long placeholder names on signs, you can use a shorter variable name and set its value to %placeholder_name%
Use /togglesignupdate to turn sign updating on or off, just in case someone made a huge amount of updating signs that causes lag. Permission nodes (Bukkit permissions):
Code (Text):
signlink.addsign:
description: Allows you to build signs containing variables
default: op
signlink.toggleupdate:
description: Allows you to set if signs are being updated or not
default: op
signlink.reload:
description: Allows you to reload the values.yml
default: op
description: Allows you to build signs containing variables
default: op
signlink.toggleupdate:
description: Allows you to set if signs are being updated or not
default: op
signlink.reload:
description: Allows you to reload the values.yml
default: op
If you really like my work and want to give something in return, feel free to donate something small to me using the link down below. Thank you!
Comments 0
No comments yet. Be the first to share your thoughts.