games647/minecraft-banner-generator

Customizable banner generator for servers and player

0.4.1 2016-05-25 19:44 UTC

Requires

• php: >=5.6

Requires (Dev)

• funnyitselmo/minecraftserverstatus: ^1.0
• games647/minecraft-skin-renderer: ^0.2.1
• phpunit/phpunit: 5.3.2
• phpunit/phpunit-mock-objects: 3.1
• xpaw/php-minecraft-query: ^1.0

Suggests

• funnyitselmo/minecraftserverstatus: An alternative to xpaw's project
• games647/minecraft-skin-renderer: Allows you to render minecraft skin heads and complete skins for player banners
• xpaw/php-minecraft-query: Allows you to query data from minecraft servers like: motd, online players, max players, favicon, ping

MIT

• server
• banner
• minecraft
• player
• online

README

Description

Minecraft banner generator library.

Features

• Server banner Displays:
  • Ping (shows different about how good the ping is)
  • Online players
  • Max players
  • Favicon if available
  • Colorized motd (message of the day)
  • Custom background
• Player banners Displays:
  • Player Head image
  • Displays player name
• No branding
• No Magic values
• Free

ToDo

• Text style effects (bold, italic, underlined)
• Automatic line wrapping
• Graph of player activity

Installation

With composer it's just:

composer require games647/minecraft-banner-generator

For non-composer projects, you can drop the files from the /src folder into a libraries folder and use it with a require statement at the top of the PHP-File. You can see a example in the example.php file.

Usage

//this is only used if you don't use composer
require __DIR__ . '/PATH_TO_LIB_FOLDER/MinecraftBanner.php';
require __DIR__ . '/PATH_TO_LIB_FOLDER/ServerBanner.php';

use \MinecraftBanner\ServerBanner;
use \MinecraftBanner\MinecraftBanner;

[...]

//tell the browser that we will send the raw image without HTML
header('Content-type: image/png');

$banner = ServerBanner::server("example.minecraft.com", "§aHallo §cWelt");
imagepng($banner);

Backgrounds

You can use 11 build in Backgrounds or Images as files or URLs

$favicon = imagecreatefrompng("server_favicon.png");
$image = ServerBanner::server("example.minecraft.com", "§aHallo §cWelt", -1, -1, $favicon, "MinecraftBanner::[DEFAULT_BACKGROUND, CLOUDS_BACKGROUND, LILLY_PADS_BACKGROUND, HILLS_BACKGROUND, WATERFALL_BACKGROUND, CANYON_BACKGROUND, GRASSLAND_BACKGROUND, GRASSLAND_CANYON_BACKGROUND, SWAMP_BACKGROUND, LAKE_BACKGROUND, SWAMP2_BACKGROUND, LILLY_PADS_SWAMP_BACKGROUND]");

CLOUDS_BACKGROUND

LILLY_PADS_BACKGROUND

HILLS_BACKGROUND

WATERFALL_BACKGROUND

CANYON_BACKGROUND

GRASSLAND_BACKGROUND

GRASSLAND_CANYON_BACKGROUND

SWAMP_BACKGROUND

LAKE_BACKGROUND

SWAMP2_BACKGROUND

LILLY_PADS_SWAMP_BACKGROUND

Scaling

Examples

$favicon = imagecreatefrompng("server_favicon.png");
$image = ServerBanner::server("example.minecraft.com", "§aHallo §cWelt", -1, -1, $favicon);

$favicon = imagecreatefrompng("notch_head.png");
$image = PlayerBanner::player("Notch", $favicon);

$favicon = imagecreatefrompng("server_favicon.png");
$image = ServerBanner::server("example.minecraft.com", "§aHallo §cWelt", -1, -1, $favicon, MinecraftBanner::LILLY_PADS_BACKGROUND);

$favicon = imagecreatefrompng("notch_head.png");
$image = PlayerBanner::player("Notch", $favicon, MinecraftBanner::LILLY_PADS_BACKGROUND);