Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

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

SettingDefaultDescription
languageen_USTranslation 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.

SettingDefaultDescription
crafting.recipeTypeshapedshaped or shapeless.
crafting.signTypeANY_SIGNResult sign material when the recipe uses a specific sign ingredient.
crafting.amount1Number of colored signs produced by the recipe.
crafting.ingredientsSee example belowMaps ingredient letters to Bukkit material names. ANY_SIGN makes recipes for supported regular and hanging sign types and returns the corresponding type.
crafting.shapeSee example belowUp 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.

SettingDefaultDescription
buySign.amount10Default number of colored signs sold. Must be positive.
buySign.price100.0Default price. Must be positive and finite.
buySign.signTypeOAK_SIGNDefault 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.enabledtruePlay a sound after creating a buy sign.
buySign.creationSound.typeBLOCK_ANVIL_USEBukkit sound constant or namespaced sound key.
buySign.creationSound.volume / pitch1.0 / 1.0Creation sound volume and pitch.
buySign.receivingSound.enabledtruePlay a sound after a purchase.
buySign.receivingSound.typeENTITY_PLAYER_LEVELUPBukkit sound constant or namespaced sound key.
buySign.receivingSound.volume / pitch1.0 / 1.0Purchase 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

SettingDefaultDescription
other.editableSignColorstrueShow existing color and formatting codes when editing a sign.
other.updateChecktrueCheck for plugin updates on startup.
other.errorReportingfalseEnable the plugin’s error-reporting path; the current implementation logs errors rather than sending them to an external service.
other.debugfalseEnable more verbose log messages.
other.configVersion8Internal configuration version; do not change it manually.