manialib/gbx

Manialib/Gbx is a PHP package to manipulate Maniaplanet Gbx files metadata

v5.0.0 2023-05-10 12:34 UTC

Requires

• php: ^8.0
• ext-gd: *

Requires (Dev)

• phpunit/phpunit: ^9.0

MIT

• Nadeo

• ManiaPlanet
• ShootMania
• TrackMania
• ManiaLib
• Ubisoft
• Nadeo

README

Manialib\Gbx is a PHP package for reading Gbx file metadata

Features

• Map.Gbx: Access metadata with a simple object interface
• Map.Gbx: Extract JPG thumbnail

Beta

• This is a work in progress.
• We might break stuff at any point.
• If you need a stable version, feel free to ask us.
• If you need a new feature, feel free to ask us.

Requirements

• PHP 8.0+
• PHP GD extension

Install

Install via Composer

{
	"require": {
        "manialib/gbx": "^5.0"
    }
}

Usage

use Manialib\Gbx\Map;

$map = Map::loadFile('/path/to/my/map.map.gbx');

//save the map thumbnail
$map->getThumbnail()->saveJpg('/path/to/my/thumbnail.jpg');

//get map author
$author = $map->getAuthor();

Development guidelines

We follow best practices from the amazing PHP ecosystem. Warm kudos to Symfony, The PHP League, the PHP subreddit and many more for inspiration and challenging ideas.

• We adhere to the best-practices put forward by PHP The Right Way
• We comply to the standards of the PHP-FIG
• We distribute code via Packagist and Composer
• We manage version numbers with Semantic Versioning
• We keep a changelog
• We use Manialib\ as our PHP vendor namespace
• We use manialib/ as our Packagist vendor namespace
• We'll (try to) make documentation & tests :)