BannerBoard
Contents
Types Explained
BannerBoard has 7 inbuilt renderers. Every renderer has it's own parameters of which some are required to make the renderer work. There are a few parameter types, which are explained in the table below.
| Type | Value | Explanation |
|---|---|---|
| Color | either R,G,B (Integer,Integer,Integer) or R,G,B,A (Integer,Integer,Integer,Integer) | RBG color. All values are integers between 0 and 255 split by a comma, use a tool like http://www.colorpicker.com/ to find the R (red) B (blue) and G (green) you are looking for. If you want to use the alpha channel, use 0 for fully transparent and 255 for opaque. |
| String | anything you want | - |
| Integer | a number between -2147483648 and 2147483647. | Valid examples are \-10, 255, 109283 or 390823. Values like 0.5 or 0,5 are NOT allowed. |
Multiple Slides
As of version 1.7.0, BannerBoard supports updating banners. You can easily configure multiple slides and let them change on an interval. To do so, your first renderer in the renderer list must be defined as SLIDEDELAY directly followed by a number. This number will be the delay between the slides in seconds. In the following example the banner goes to the next slide every 10 seconds.
- SLIDEDELAY 10
This should be directly followed by the first slide's renderers, for example the following.
- COLOR -color 0,255,0
- TEXT -text TEST %name% TEST SLIDE %slide% -size 12 -font Adobe Arabic -color 255,255,255 -strokeColor 0,0,0 -strokeThickness 0 -xOffset 10 -yOffset 70
Define the next slide by ending the old slide with the following.
- NEXTSLIDE
And so on.
A total example would be something like this. To keep the performance of this plugin high, don't set the slide update delay too low.
configurable:
renderers:
- SLIDEDELAY 10
- COLOR -color 0,255,0
- TEXT -text TEST %name% TEST SLIDE %slide% -size 12 -font Adobe Arabic -color 255,255,255 -strokeColor 0,0,0 -strokeThickness 0 -xOffset 10 -yOffset 70
- NEXTSLIDE
- COLOR -color 0,0,255
- TEXT -text TEST %name% TEST SLIDE %slide% -size 12 -font Adobe Arabic -color 255,255,255 -strokeColor 0,0,0 -strokeThickness 0 -xOffset 10 -yOffset 70
- NEXTSLIDE
- COLOR -color 255,0,0
- TEXT -text TEST %name% TEST SLIDE %slide% -size 12 -font Adobe Arabic -color 255,255,255 -strokeColor 0,0,0 -strokeThickness 0 -xOffset 10 -yOffset 70
Color Renderer
The first very simple but useful renderer is the color renderer. The color renderer can be used to create a background color (if it is the first renderer in the row) or as an overlay color for an image. I'd personally advise you to use an alpha of around 100 for image overlays.
| Parameter | Required | Value | Explanation |
|---|---|---|---|
| -color | Yes | Color | the color specified as a RGB or RBGA color split by a comma, see this. |
| -permission (only version 1.1.5 or above) | No | String | when this parameter is added, only players with the specified permission will see this renderer. |
| Examples (please note that renderers are case sensitive) |
|---|
| COLOR -color 120,120,120 |
| COLOR -color 60,120,50 |
| COLOR -color 0,0,0,100 |
Image Renderer
The second and very awesome renderer is the image renderer. The image renderer takes an image and renders it on your bannerboard. Unfortunately, the game only supports only 143 different colors so don't expect too much, but it gives a very cool effect. Please note that this renderer only works with PNG images stored in the images folder of the plugin.
| Parameter | Required | Value | Explanation |
|---|---|---|---|
| -src | Yes | String | the name of the image you have stored in the automatically generated plugins/BannerBoard/images/ folder, for example snowball.png |
| -xOffset | No (automatically CENTERED when left blank) | Integer | the x-offset the image will be drawn at, it will be the distance between the left side of your image and the left side of your banner. |
| -yOffset | No (automatically CENTERED when left blank) | Integer | the y-offset the image will be drawn at, it will be the distance between the top side of your image and the top side of your banner. |
| -width | No (default same as png image) | Integer | the width of the image, keep in mind that one block is 128x128 pixels. |
| -height | No (default same as png image) | Integer | the height of the image, keep in mind that one block is 128x128 pixels. |
| -permission | No | String | when this parameter is added, only players with the specified permission will see this renderer. |
| Examples (please note that renderers are case sensitive) |
|---|
| IMAGE -src snowball.png -xOffset 740 -yOffset 470 |
| IMAGE -src creativeplots.png -xOffset 50 |
| IMAGE -src cinematic.png |
Skin Renderer
The third and even more awesome renderer is the skin renderer. The skin renderer takes the skin of the player who is viewing the bannerboard and dynamically renders the bannerboard with the skin of the player in it.
| Parameter | Required | Value | Explanation |
|---|---|---|---|
| -type | Yes | String | either HEAD, 3DHEAD or SKIN. |
| -xOffset | No (automatically CENTERED when left blank) | Integer | the x-offset the image will be drawn at, it will be the distance between the left side of your image and the left side of your banner. |
| -yOffset | No (automatically CENTERED when left blank) | Integer | the y-offset the image will be drawn at, it will be the distance between the top side of your image and the top side of your banner. |
| -width | No (default 128) | Integer | the width of the image, please note that the HEAD and 3DHEAD have a 1:1 width:height ratio, the SKIN type has a 1:2 width:height ratio. |
| -height | No (default 128) | Integer | the height of the image, please note that the HEAD and 3DHEAD have a 1:1 width:height ratio, the SKIN type has a 1:2 width:height ratio. |
| -permission | No | String | when this parameter is added, only players with the specified permission will see this renderer. |
| Examples (please note that renderers are case sensitive) |
|---|
| SKIN -type SKIN -width 400 -height 800 -xOffset 740 -yOffset 50 |
| SKIN -type 3DHEAD -xOffset 64 -width 256 -height 256 |
| SKIN -type SKIN -width 200 -height 400 |
Text Renderer
The last but very useful renderer is the text renderer. The text renderer is able to dynamically render any text you want. The text renderer supports all installed fonts in any size and style, it is even possible to install your own custom fonts.
| Parameter | Required | Value | Explanation |
|---|---|---|---|
| -text | Yes | String | the text that will be drawn, this parameter supports the usage of %name%, which will automatically be replaced with the name of the player. |
| -font | Yes | String | the font in which the text will be drawn, fonts are case sensitive. Any font installed on the system is allowed, use the command [/bb fontlist] to get an overview of all installed fonts. |
| -size | Yes | Integer | the size in which the text will be drawn must be a positive integer. |
| -style | No (PLAIN by default) | String | the style of the text, this can either by PLAIN, BOLD, ITALIC or BOLDITALIC. |
| -color | No (255,255,255 (white) by default) | Color | the color in which the text will be drawn. |
| -strokeColor | No (0,0,0 (black) by default) | Color | the color in which the stroke around the characters will be drawn, leave blank if you you have strokeThickness set to 0. |
| -strokeThickness | No (0 by default) | Integer | the thickness of the line around the characters, set to 0 to disable. |
| -xOffset | No (automatically CENTERED when left blank) | Integer | the x-offset the image will be drawn at, it will be the distance between the left side of your image and the left side of your banner. |
| -yOffset | No (automatically CENTERED when left blank) | Integer | the y-offset the image will be drawn at, it will be the distance between the top side of your image and the top side of your banner. |
| -permission | No | String | when this parameter is added, only players with the specified permission will see this renderer. |
| Examples (please note that renderers are case sensitive) |
|---|
| TEXT -text Welcome %name% -size 60 -font Minecrafter -color 255,255,255 -strokeColor 0,0,0 -strokeThickness 2 -yOffset 620 |
| TEXT -text SURVIVAL -size 200 -font Segoe Script -style BOLD -color 255,255,255 -strokeColor 0,0,0 -strokeThickness 7 |
| TEXT -text new gamemode -size 80 -font Minecrafter -style ITALIC -color 255,255,255 -strokeColor 0,0,0 -strokeThickness 3 -xOffset 20 -yOffset 200 |
3D Skin Renderer
Support for this renderer has been dropped as of April, 30. 2016. Use http://www.skinrender.com/ (I own the site) and use the live image renderer below.
Live Image Renderer
The live image renderer is a renderer which pulls an image from a webpage every time a player logs in. Make sure you know when to use this one, it's often better to use URLImageRenderer for better performance.
| Parameter | Required | Value | Explanation |
|---|---|---|---|
| -url | Yes | String | the link to the image. This may not be a normal HTML page, but must be an image. Placeholders may be used here. |
| -xOffset | No (automatically CENTERED when left blank) | Integer | the x-offset the image will be drawn at, it will be the distance between the left side of your image and the left side of your banner. |
| -yOffset | No (automatically CENTERED when left blank) | Integer | the y-offset the image will be drawn at, it will be the distance between the top side of your image and the top side of your banner. |
| -width | No (default same as image) | Integer | the width of the image. |
| -height | No (default same as image) | Integer | the height of the image. |
| -permission | No | String | when this parameter is added, only players with the specified permission will see this renderer. |
| Examples (please note that renderers are case sensitive) |
|---|
| LIVEIMG -url http://www.skinrender.com:2798/fullskin-%name%-1000-0-0-0-11-15-12-142-0-121-16-22-24-16-22-18-16-22-344 -width 640 -height 640 |
| the URL above gives me this with my username. http://www.skinrender.com:2798/fullskin-sander2798-1000-0-0-0-11-15-12-142-0-121-16-22-24-16-22-18-16-22-344 |
URL Image Renderer
The URL image renderer is a renderer which pulls an image from a webpage once every few minutes. For personal images, use the Live Image renderer above. This should only be used for for example high scores, for which BannerBoard displays the same image to everyone. Do not use the Live Image renderer if this one can be used as well. This has better performance.
| Parameter | Required | Value | Explanation |
|---|---|---|---|
| -url | Yes | String | the link to the image. This may not be a normal HTML page, but must be an image. Placeholders may be used here. However you should not use personal player placeholders here, a random online player will be used. |
| -interval | Yes | Integer | interval between refreshes in minutes. Use the normal image renderer instead if you are sure the image never changes. |
| -xOffset | No (automatically CENTERED when left blank) | Integer | the x-offset the image will be drawn at, it will be the distance between the left side of your image and the left side of your banner. |
| -yOffset | No (automatically CENTERED when left blank) | Integer | the y-offset the image will be drawn at, it will be the distance between the top side of your image and the top side of your banner. |
| -width | No (default same as image) | Integer | the width of the image. |
| -height | No (default same as image) | Integer | the height of the image. |
| -permission | No | String | when this parameter is added, only players with the specified permission will see this renderer. |
| Examples (please note that renderers are case sensitive) |
|---|
| URLIMG -url http://www.skinrender.com:2798/fullskin-%leaderheads_player_joined_1%-640-0-0-0-0-0-34-0-0-0-0-0-0-0-0-0-0-0-0 -interval 1 |
Interact Handler
Unlike any other renderer, this renderer doesn't actually draw something on your canvas. This renderer can be used to send players a message when they click a certain area of your banner.
| Parameter | Required | Value | Explanation |
|---|---|---|---|
| -text | No | String | The message you want to send to the player. You can use placeholders here as well as chat colors specified with the '&' sign. |
| -consolecommand | No | String | The command that will be executed by the console. You can use placeholders here. |
| -playercommand | No | String | The command that will be executed by the player. You can use placeholders here. |
| -sendserver | No | String | The name of the target server as configured in the BungeeCord config. |
| -x0 | No (by default full banner) | Integer | x coordinate of starting point, see this image. Must be divisible by 128. |
| -y0 | No (by default full banner) | Integer | y coordinate of starting point, see this image. Must be divisible by 128. |
| -x1 | No (by default full banner) | Integer | x coordinate of end point, see this image. Must be divisible by 128. |
| -y1 | No (by default full banner) | Integer | y coordinate of end point, see this image. Must be divisible by 128. |
| Examples (please note that renderers are case sensitive) |
|---|
| INTERACT -x0 128 -y0 128 -x1 256 -y1 256 -text &aHey %name%, you just clicked the blue square! |
| INTERACT -consolecommand tp %name% 100 80 10 |
