-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
48 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,49 @@ | ||
# Minecraft Avatar URLs | ||
|
||
This library provides PHP utilities to generate URLs to Minecraft Avatars in different formats with the ability to easily change between avatar services. | ||
|
||
## Requirements | ||
|
||
* PHP 7.1 or higher | ||
* Composer | ||
|
||
## Installation | ||
|
||
``` | ||
composer require gigadrive/minecraft-avatar-urls | ||
``` | ||
|
||
## Usage | ||
|
||
```php | ||
use Gigadrive\MinecraftAvatar\MinecraftAvatar; | ||
|
||
// Set default service to use | ||
MinecraftAvatar::setDefaultService(MinecraftAvatar::SERVICE_MINOTAR); // minotar.net | ||
MinecraftAvatar::setDefaultService(MinecraftAvatar::SERVICE_CRAFATAR); // crafatar.com | ||
MinecraftAvatar::setDefaultService(MinecraftAvatar::SERVICE_CRAFTHEAD); // crafthead.net | ||
MinecraftAvatar::setDefaultService(MinecraftAvatar::SERVICE_MCHEADS); // mc-heads.net | ||
MinecraftAvatar::setDefaultService(MinecraftAvatar::SERVICE_CRAVATAR); // cravatar.eu | ||
|
||
// Retrieve the default service class | ||
$service = MinecraftAvatar::getDefaultService(); | ||
|
||
// Retrieve the default service class through global function | ||
$service = avatar(); | ||
|
||
// Manually retrieve a service class | ||
$service = MinecraftAvatar::getServices()[MinecraftAvatar::SERVICE_MINOTAR]; // minotar.net | ||
$service = MinecraftAvatar::getServices()[MinecraftAvatar::SERVICE_CRAFATAR]; // crafatar.com | ||
$service = MinecraftAvatar::getServices()[MinecraftAvatar::SERVICE_CRAFTHEAD]; // crafthead.net | ||
$service = MinecraftAvatar::getServices()[MinecraftAvatar::SERVICE_MCHEADS]; // mc-heads.net | ||
$service = MinecraftAvatar::getServices()[MinecraftAvatar::SERVICE_CRAVATAR]; // cravatar.eu | ||
|
||
// Use service class | ||
// Not all formats are available on all classes, check their websites for documentation | ||
// Functions include phpDoc blocks. | ||
$service->face("73b417dcd1e645d8af06895eeb5222a5", 16, true); // Returns a URL 16x16 face image of a player including the helm layer | ||
``` | ||
|
||
## Copyright and License | ||
|
||
This program was developed by [Mehdi Baaboura](https://github.com/Zeryther) and published by [Gigadrive UG](https://gigadrivegroup.com) under the MIT License. For more information click [here](https://github.com/Gigadrive/minecraft-avatar-urls/blob/master/LICENSE). |