Introduction
SignColors is a Spigot plugin that lets players with the appropriate permissions add colors and formatting to signs. Write the configurable prefix (default &) followed by a color or formatting code, such as &a or &l.
Features
- Players can add colors/formats to regular and hanging signs.
- Permissions per color/format.
- Use your own color symbol instead of
&. - Possibility to craft colored signs (recipe and type are configurable).
- Optional crafted-sign requirement; players can also obtain colored signs from
[SC]buy signs or a command. - Buy signs require Vault and a compatible economy provider.
- Colored sign identity is stored in Minecraft item and block data; marked signs retain their identity when dropped through normal block drops.
- Configurable blocked first lines can help prevent imitation of special signs.
- Automatically checks for updates (configurable).
- English and German translations are included; additional languages can be added manually.
Installation
This guide covers the initial installation and setup. The current build targets Spigot 26.3 and requires Java 25.
Download
Download the plugin JAR from SpigotMC or GitHub Releases. Put it in the server’s plugins directory.
Start the server
Start the server. Once it has finished loading, you should find a SignColors folder in the plugins directory.
Configure
Edit plugins/SignColors/config.yml as needed, then use /sc reload or restart the server. See Configuration for the available settings.
To use buy signs, install Vault and a compatible economy provider. Vault is optional for other features.
Configuration
After the first server start, edit plugins/SignColors/config.yml. Apply changes with /sc reload (requires signcolors.command.reload) or restart the server. See Languages for translation files.
When the configuration version is outdated, SignColors backs up config.yml to a config.yml.v<version>-*.bak file and replaces it with the default configuration on startup. Restore custom settings from the backup as needed. Other files are not included in this backup; see Languages for translation updates.
General settings
| Setting | Default | Description |
|---|---|---|
language | en_US | Translation file name without .properties; en_US and de_DE are included. |
prefixCharacter | & | Prefix used before a color or formatting code, for example &a. Use one character. |
On color-enabled signs, escape the prefix with a backslash to display it literally: \&a displays &a. Use \\ for a literal backslash. If the configured prefix is a backslash, use / as the escape character instead (for example, /\a displays \a and // displays /).
Crafting
crafting.enabled defaults to true. When enabled, players need a colored sign to apply codes unless they have signcolors.bypass.crafting. Colored signs can be crafted, bought from an [SC] sign, or given with /sc givesign. When disabled, codes can be applied to ordinary signs; color and formatting permissions still apply.
| Setting | Default | Description |
|---|---|---|
crafting.recipeType | shaped | shaped or shapeless. |
crafting.signType | ANY_SIGN | Result sign material when the recipe uses a specific sign ingredient. |
crafting.amount | 1 | Number of colored signs produced by the recipe. |
crafting.ingredients | See example below | Maps ingredient letters to Bukkit material names. ANY_SIGN makes recipes for supported regular and hanging sign types and returns the corresponding type. |
crafting.shape | See example below | Up to three rows for a shaped recipe; spaces represent empty slots. Not used for shapeless recipes. |
The default recipe surrounds a sign with four dyes:
crafting:
enabled: true
recipeType: shaped
signType: 'ANY_SIGN'
amount: 1
ingredients:
A: 'RED_DYE'
B: 'GREEN_DYE'
C: 'BLUE_DYE'
D: 'YELLOW_DYE'
S: 'ANY_SIGN'
shape:
- 'A B'
- ' S '
- 'C D'
For a shapeless recipe, list the ingredients under distinct keys; their letters and shape do not determine positions. Bukkit permits at most nine ingredients. If no ingredient is ANY_SIGN, set crafting.signType to a supported sign material such as OAK_SIGN.
Colored sign identity is saved in item and block data, not an external database. Signs and items created before the marker-based version are not automatically migrated.
Buy signs
Buy signs require Vault and a Vault-compatible economy provider to make purchases. Their creation and use also require separate permissions. The usage guide explains how to create one.
| Setting | Default | Description |
|---|---|---|
buySign.amount | 10 | Default number of colored signs sold. Must be positive. |
buySign.price | 100.0 | Default price. Must be positive and finite. |
buySign.signType | OAK_SIGN | Default supported sign item material, such as OAK_SIGN or OAK_HANGING_SIGN. |
buySign.blockedFirstLines | ['&6[&3SC&6]', '&1[Buy]'] | Exact first lines blocked unless the player has signcolors.bypass.blockedfirstlines. Entries use & for color codes. |
buySign.creationSound.enabled | true | Play a sound after creating a buy sign. |
buySign.creationSound.type | BLOCK_ANVIL_USE | Bukkit sound constant or namespaced sound key. |
buySign.creationSound.volume / pitch | 1.0 / 1.0 | Creation sound volume and pitch. |
buySign.receivingSound.enabled | true | Play a sound after a purchase. |
buySign.receivingSound.type | ENTITY_PLAYER_LEVELUP | Bukkit sound constant or namespaced sound key. |
buySign.receivingSound.volume / pitch | 1.0 / 1.0 | Purchase sound volume and pitch. |
Blocked lines are compared after trimming and normalizing applied color codes to &. A player with signcolors.buysign.create can create the plugin’s [SC] indicator. Test other blocked entries with the permissions and prefix used on your server.
Other settings
| Setting | Default | Description |
|---|---|---|
other.editableSignColors | true | Show existing color and formatting codes when editing a sign. |
other.updateCheck | true | Check for plugin updates on startup. |
other.errorReporting | false | Enable the plugin’s error-reporting path; the current implementation logs errors rather than sending them to an external service. |
other.debug | false | Enable more verbose log messages. |
other.configVersion | 8 | Internal configuration version; do not change it manually. |
Usage
Adding colors and formatting
Write the configured prefix (default &) followed by a code before the text, for example &aHello &lworld. You can use multiple codes per line. See Permissions for the available codes and their permission nodes, or use /sc codes to display them in game.
When crafting.enabled is true (the default), use a colored sign obtained from the recipe, a buy sign, or /sc givesign. Players with signcolors.bypass.crafting can use ordinary signs. When crafting is disabled, ordinary signs work for everyone who has the relevant color or formatting permissions.
When editing a sign that meets the crafting requirement, existing legacy color and formatting codes are shown using the configured prefix, including codes you cannot apply. On save, codes without permission remain visible as literal text. Codes are reconstructed from the sign’s formatting, so they may not exactly match the original input. Signs with hex colors are not converted to editable codes. Visible codes take up space, so long lines may need shortening. Disable this feature with other.editableSignColors.
Crafting a colored sign
By default, craft a colored sign using one sign and one each of red, green, blue, and yellow dye. Place the sign in the center of a crafting table, with red and green dye in the top corners and blue and yellow dye in the bottom corners:
If the server is configured to use a shapeless recipe with the same ingredients, place them anywhere in the crafting grid instead:
The server’s configured recipe determines the ingredients, arrangement, and output amount. With the default ANY_SIGN ingredient, regular and hanging signs are supported and the result matches the input sign type. See Crafting configuration for details. You still need the relevant permissions to apply colors and formatting.
Creating a buy sign
A player with signcolors.buysign.create can create a sign with these lines:
| Line | Content |
|---|---|
| 1 | [SignColors] or [SC] (use [SC] on hanging signs) |
| 2 | Optional: <amount>:<price>, for example 10:100.0 |
| 3 | Optional: sign type, for example OAK or OAK_H for a hanging sign |
| 4 | Ignored; the plugin fills this line. |
Leave line 2 or 3 blank to use its configured default. Spaces around the colon on line 2 are optional: 10:100 and 10 : 100 are equivalent. The amount must be a positive integer, and the price must be positive and finite. For a hanging sign, append _H to the wood type (for example, OAK_H or DARK_OAK_H). Full material names such as OAK_HANGING_SIGN, or names without _SIGN such as OAK_HANGING, are also accepted if they fit. Existing buy signs with full material names continue to work. The plugin formats and waxes the completed sign.
Standing sign example
This example sells 10 regular oak signs for 100. Enter [SignColors], 10:100, and OAK on the first three lines:
After creation, the plugin displays the sign type, amount, and price:
Hanging sign example
Use the shorter [SC] header on a hanging sign. This example sells 10 oak hanging signs for 100 using OAK_H:
Players with signcolors.buysign.use can right-click it to buy colored signs. Purchases require Vault and a compatible economy provider. The configured amount, price, and material can differ from the examples above.
Commands
/signcolors is an alias for /sc. Arguments in brackets are required.
| Command | Permission | Description |
|---|---|---|
/sc | signcolors.command.info | Show plugin information. |
/sc help | signcolors.command.help | List commands available to you. |
/sc reload | signcolors.command.reload | Reload configuration, translations, and recipes. |
/sc givesign [player] [amount] [sign_material] | signcolors.command.give | Give an online player 1–16 colored signs of a supported material, such as OAK_SIGN. Material names are case-insensitive. |
/sc codes | signcolors.command.codes | Display color and formatting codes. |
For example: /sc givesign Alex 4 OAK_SIGN or /sc givesign Alex 4 OAK_HANGING_SIGN.
Permissions
Example permission packages
These are suggestions, not built-in groups. Grant the nodes with your permission manager and adjust them to suit your server. The VIP package below assumes VIPs inherit the player package; otherwise, grant both lists to VIPs.
Players
Give regular players a selection of colors, access to the code list, and the ability to buy colored signs:
signcolors.command.infosigncolors.command.helpsigncolors.command.codessigncolors.buysign.usesigncolors.color.a— greensigncolors.color.b— aquasigncolors.color.c— redsigncolors.color.e— yellowsigncolors.color.f— whitesigncolors.formatting.r— reset
VIPs
In addition to the player package, give VIPs all colors and a few formatting options:
signcolors.color.*— all colorssigncolors.formatting.l— boldsigncolors.formatting.n— underlinesigncolors.formatting.o— italic
Optionally grant signcolors.bypass.crafting if VIPs should be able to color ordinary signs without obtaining colored signs. Grant signcolors.formatting.* instead of the individual formatting nodes if VIPs should also have magic and strikethrough.
With the default crafting.enabled: true, players without the crafting bypass need colored signs from crafting, buy signs, or an administrator. Buy signs additionally require Vault and a compatible economy provider. See Usage for details. Neither package grants buy-sign creation, administrative commands, or the blocked-line bypass; reserve those for trusted staff.
Permission reference
| Permission | Description |
|---|---|
signcolors.* | Access to all features; granted to operators by default |
signcolors.command.* | Access to all commands |
signcolors.buysign.* | Create and use [SC] buy signs |
signcolors.color.* | Apply all colors on signs |
signcolors.formatting.* | Apply all formatting options on signs |
signcolors.bypass.* | Bypass the crafting requirement and blocked first lines |
signcolors.command.info | Access to /sc |
signcolors.command.help | Access to /sc help |
signcolors.command.reload | Access to /sc reload |
signcolors.command.give | Access to /sc givesign |
signcolors.command.codes | Access to /sc codes |
signcolors.buysign.create | Create [SC] buy signs |
signcolors.buysign.use | Use [SC] buy signs |
signcolors.bypass.crafting | Apply codes to ordinary signs when crafting is required |
signcolors.bypass.blockedfirstlines | Bypass blocked sign lines |
signcolors.updatemessage | Receive a notification on joining when an update is available |
signcolors.color.0 | Access to BLACK color: &0 |
signcolors.color.1 | Access to DARK BLUE color: &1 |
signcolors.color.2 | Access to DARK GREEN color: &2 |
signcolors.color.3 | Access to DARK AQUA color: &3 |
signcolors.color.4 | Access to DARK RED color: &4 |
signcolors.color.5 | Access to DARK PURPLE color: &5 |
signcolors.color.6 | Access to GOLD color: &6 |
signcolors.color.7 | Access to GRAY color: &7 |
signcolors.color.8 | Access to DARK GRAY color: &8 |
signcolors.color.9 | Access to BLUE color: &9 |
signcolors.color.a | Access to GREEN color: &a |
signcolors.color.b | Access to AQUA color: &b |
signcolors.color.c | Access to RED color: &c |
signcolors.color.d | Access to LIGHT PURPLE color: &d |
signcolors.color.e | Access to YELLOW color: &e |
signcolors.color.f | Access to WHITE color: &f |
signcolors.formatting.k | Access to MAGIC formatting: &k |
signcolors.formatting.l | Access to BOLD formatting: &l |
signcolors.formatting.m | Access to STRIKETHROUGH formatting: &m |
signcolors.formatting.n | Access to UNDERLINE formatting: &n |
signcolors.formatting.o | Access to ITALIC formatting: &o |
signcolors.formatting.r | Access to RESET formatting: &r |
Languages
The plugin comes with built-in English and German translations. More can be added manually.
Bundled translations have a translation.version key. When a newer bundled version is installed, SignColors backs up the existing file in the translations folder (with a .bak suffix) and replaces it with the new version on startup or /sc reload. Existing unversioned bundled files are also backed up and replaced. Copy any customizations back from the backup if needed. Custom language files are not replaced by this translation update process. Configuration version upgrades only back up and replace config.yml; see Configuration.
Adding a custom language
- Copy
en_US.propertiesin thetranslationsfolder and name the copy after your language (for example,fr.properties). - Adjust the translation values in the file.
- Set the
languagekey inconfig.ymlto your language file code (for example,fr). - Reload the plugin or restart the server to use the new translations.