Effects

This page lists all available effects and their respective arguments.

Effect	Description
background	Fills the background with a solid color.
background-random	Fills the background with a randomized palette derived from a color.
background-texture	Fills the background with a texture.
rectangle	Draws a colored rectangle at the specified position.
circle	Draws a colored circle at the specified position.
line	Draws a colored line at the specified position.
frame	Draws a colored border around the final image.
texture	Draws a texture at the specified position.
book-content	Placeholder for actual book content. Use this to change the final layering.

Effect arguments are always separated with a comma, like this: e:circle,0,0,100,100,white,yes

Background Effects

background

Arguments

Argument	Required?	Description
color	yes	Color

Example

effect:background,red

background-random

Arguments

Argument	Required?	Description
color	yes	Color

Example

effect:background-random,green

background-texture

⚠️ Needs additional setup: Server owners should make sure to set this up correctly!

Arguments

Argument	Required?	Description
filename	yes	Name of PNG file
tile	no	If enabled, will tile texture instead of stretching it
tileSizeMultiplier	no	Size multiplier for each tile, e.g. a 32x32 texture with a tile size multiplier of 4 will be 128x128 per tile

Example

effect:background-texture,stone_bricks
effect:background-texture,stone,true,8
effect:background-texture,obsidian,true

Shapes

rectangle

Arguments

Argument	Required?	Description
color	yes	Color
x	yes	X position in pixels
y	yes	Y position in pixels
width	yes	Width in pixels
height	yes	Height in pixels
hollow	no	Should the rectangle be hollow?

Example

effect:rectangle,green,50,50,110,110,yes

circle

Arguments

Argument	Required?	Description
color	yes	Color
x	yes	X position in pixels
y	yes	Y position in pixels
width	yes	Width in pixels
height	yes	Height in pixels
hollow	no	Should the circle be hollow?

Example

effect:circle,green,50,50,110,110,yes

line

Arguments

Argument	Required?	Description
color	yes	Color
x1	yes	X starting position in pixels
y1	yes	Y starting position in pixels
x2	yes	X ending position in pixels
y2	yes	Y ending position in pixels

Example

effect:line,grey,0,50,200,55

Misc

frame

Arguments

Argument	Required?	Description
color	yes	Color
thickness	no	Thickness in pixels

Example

effect:frame,yellow,4

texture

⚠️ Needs additional setup: Server owners should make sure to set this up correctly!

Arguments

Argument	Required?	Description
filename	yes	Name of PNG file
x	yes	X position
y	yes	Y position
width	yes	Desired width of the texture
height	yes	Desired height of the texture

Example

effect:texture,stone,50,50,32,32

book-content

Arguments

This effect has no arguments.

Example

effect:book-content