minecraft-codes

Minecraft color codes string to objects

If you wanted once to convert colored server name or some other minecraft colored string in JavaScript, you may be met failure. This library can help you create objects from colored strings to data objects, which you can use for render this colored strings!

Installation

npm i minecraft-codes

Or

yarn add minecraft-codes

Simple Example

This is how u can use this library

const {getColoredStringData, getColorTag, getColorName} = require('minecraft-codes');

getColoredStringData("&aLast&bCraft").forEach(word => {
  console.log(word.color) // light-green and water
  console.log(getColorTag(word.color)) //&a and &b
  console.log(word.color === getColorName(getColorTag(word.color))) // true true
  console.log(word.value) // "Last" and "Craft"
})

And more

getColoredStringData("&c&k| &l&r&aLast&eCraft")
/*
[ { value: '| ',
    isObfuscate: true,
    isUnderline: false,
    isLineThrough: false,
    isItalic: false,
    isBold: false,
    color: 'scarlet' },
  { value: '',
    isObfuscate: false,
    isUnderline: false,
    isLineThrough: false,
    isItalic: false,
    isBold: false,
    color: 'alpha' },
  { value: 'Last',
    color: 'light-green',
    isObfuscate: false,
    isUnderline: false,
    isLineThrough: false,
    isItalic: false,
    isBold: false },
  { value: 'Craft',
    color: 'yellow',
    isObfuscate: false,
    isUnderline: false,
    isLineThrough: false,
    isItalic: false,
    isBold: false } ]
*/

getGolorName

Return color name by color value

const {getColorName} = require('minecraft-codes');

console.log(getColorName("&0")); // black
console.log(getColorName("&f")); // white
console.log(getColorName("&r")); // reset
console.log(getColorName("&k")); // alpha

Word properties

• isObfuscate - need or not enable obfuscation animation
• isBold - need render this string as a bold (larget weight font)
• isItalic - need or not render this string as an italic
• isUnderline - need or not render this string as an underline
• isLineThrough - need or not render this string as an line trough
• color - color name, may be: black, blue, green, emerald, red, purple, orange, gray, space-gray, water, light-green, diamond, scarlet, pink, yellow, white
• value - value string for this step rendering

Usage

You can use it anywhere where you need render minecraft colored string in JavaScript code. For example, i used it my React application that show colored server name in list of servers!

Love Minecraft, guys!