User Guide

Creating a map from a book

First, write a book! Craft a Book and Quill and write your desired text.

Book styling is supported! However, vanilla clients will not let you create styled books, because they block use of the special styling character §.

To circumvent this issue, you can either install a client-side book-editor mod such as Stendhal, or, alternatively, substitute any § character with "@@".
Book2Map will replace all instances of @@ with § during image generation.
This means that writing @@6This is golden text. will be converted to §6This is golden text, making that text golden indeed.

Text size can also be increased on a per-line basis. Simply start a line with ^^ and a number, to increase text size by that number for that line.
For example, ^^10This is bigger text! will be bigger by 10px.

At any point after your books actual content, create a line containing book2map or b2m. Create a new line by hitting "Enter".
From now on, every line will be treated as input for Book2Map.
Simply enter your desired option and end the line by hitting "Enter".
Finally, hold the book in your hand and run the following command: /b2m generate.
Place the resulting map/bundle into an item frame or a wall of item frames.

A full list of all implemented options can be found here.

To better illustrate this, here is the full content of a book:

YOUR
 AD
HERE
book2map
font:Minecraft
size:90
width:4
height:4
dither:0
top:100
left:136
color:white
e:background-random,black
e:frame,yellow
!e:circle,white,100,100,300,300,yes

The above example can be copy-pasted as is into a book and quill!
Notice the exclamation point on the last line? It disables that line from being used!
You should be able to infer the general layout from this example.

Layering effects

The order of effects is important! Book text gets parsed top-to-bottom.
This means that the order in which effects get applied to the resulting image is not fixed.

Most importantly, by default, text gets applied on top of all effects.

Should this not be desired, add the book-content effect to influence its placement.
For example, by default the frame effect will be below any text, which is usually undesired.
Simply add an e:book-effect in the line before your frame, and voilà!