README.md

A simple tool to generate big sign texts

Developed for BTE Germany (GitHub).

Font "signletters" by Hugleton

Usage:

You need to be in creative mode to use the command.
/givesign <material> <color> <font> <text>
You may need to adjust some characters by hand, depending on the combination

Adding your own font:

Fonts only for your server

1. Create a JSON file with the format described below
2. Place it in /plugins/SignTextGenerator or any subfolder of it
3. Restart your server and use the font name (without .json) in the command

Make your fonts available for everyone

1. Fork this repository
2. Add your font as FONT_NAME.json file to /src/main/resources/fonts/
3. Create a pull request to get your font added to the plugin

Font file format

To add your font, the JSON file needs to have the following:
a) A number of letters that fit on one regular sign
b) A number of letters that fit on one hanging sign
c) Weather your letters have enough space on either side or the generator should put additional spaces between letters
d) A representation for every character in form of the four lines a sign has

Example:

{
  "maxCharsPerSign" : 3,
  "maxCharsPerHangingSign" : 2,
  "ownLetterSeparation": false,
  "charMap" : {
    " ": ["      ","      ","      ","      "],
    "A": ["◢▊█▊◣","█  ݀█","███","█  ݀█"],
    "B": ["██▊◣","█▄▊◤","█▀▊◣","██▊◤"],
    "C": ["◢▊█▊◣","█▏  ▀","█▏  ▄","◥▊█▊◤"],
	"D": ["██▊◣","█  ▏█","█  ▏█","██▊◤"]
   }
}