Avatars
-Avatars
+
Avatar Parameters
-| parameter | -type | -default | -description | -
| size | -integer | -<%= config.avatars.default_size %> | -The size of the image in pixels, <%= config.avatars.min_size %> - <%= config.avatars.max_size%>. | -
| default | -string | -The standard value is calculated based on the UUID (even = MHF_Alex, odd = MHF_Steve). - Usernames always default to MHF_Steve. |
- The image to be served when the player has no skin. - Valid options are any name or uuid, including MHF_Steve and MHF_Alex, or a custom URL. |
-
| helm | -null | -- | Apply the "second" layer (hat) to the avatar. | -
Avatar Examples
+Jeb's avatar
-Jeb's avatar with helm
-Jeb's avatar, 128 × 128
-Jeb's avatar by UUID
-Jeb's avatar, or fall back to MHF_Alex (this example assumes jeb_ does not exist)
-Jeb's avatar, or fall back to a custom image (this example assumes jeb_ does not exist)
-Hover over the example URLs above for a preview!
+ <%= domain %>/avatars/uuid3D Renders
-Crafatar also provides support for 3D renders of Minecraft skins.
- Please note that this feature is currently beta!
- The head render type returns a render of the skin's head.<%= domain %>/renders/head/uuidThe body render returns a render of the entire skin.<%= domain %>/renders/body/uuid
Render Parameters
-| parameter | -type | -default | -description | -
| scale | -integer | -<%= config.renders.default_scale %>. The actual size differs between the type of render. | -The scale factor of the image <%= config.renders.min_scale %> - <%= config.renders.max_scale %>. | -
| helm | -null | -- | Apply the "second" layer (hat) to the avatar. | -
| default | -string | -The standard value is calculated based on the UUID (even = MHF_Alex, odd = MHF_Steve). - Usernames always default to MHF_Steve. |
- The image to be served when the uuid has no skin. - Valid options are any uuid, including MHF_Steve and MHF_Alex, or a custom URL. |
-
Render Examples
+Accepted parameters: size, helm, default.
+Head Renders
+Jeb's body, with helmet, scale 4
-Jeb's head, by UUID, scale 8
-Hover over the example URLs above for a preview!
+ <%= domain %>/renders/head/uuidSkins
-You can also get the full skin file of a player.
- The user's skin is returned, or the default image is served.
- You can use the default parameter here as well.<%= domain %>/skins/uuid
Skin Parameters
-| parameter | -type | -default | -description | -
| default | -string | -The standard value is calculated based on the UUID (even = MHF_Alex, odd = MHF_Steve). - Usernames always default to MHF_Steve. |
- The image to be served when the uuid has no skin. - Valid options are any uuid, including MHF_Steve and MHF_Alex, or a custom URL. |
-
Skin Examples
+Accepted parameters: scale, helm, default.
+Body Renders
+Jeb's skin
-Jeb's skin, or fall back to MHF_Alex (this example assumes jeb_ does not exist)
-Hover over the example URLs above for a preview!
+ <%= domain %>/renders/body/uuidCapes
-A cape endpoint is also available to get the active cape of a user.
- The user's cape is returned, otherwise a 404 is returned.
-
Accepted parameters: scale, helm, default.
+Skins
+Accepted parameters: default.
+Capes
+Accepted parameters: default.
++ +
Meta
+
+ In the examples above, you can generally use usernames instead of uuid. However, apart from the special cases MHF_Steve and MHF_Alex this is discouraged as explained below.
+ You can append .png or any other file extension to the URL path if you like to, but all images are PNG.
+
URL Parameters
+
+ You can tweak images using query string parameters.
+ Example: <%= domain %>/avatars/853c80ef3c3749fdaa49938b674adae6?size=4&default=MHF_Steve&helm
Cape Examples
-Dinnerbone's Cape Mojang capes are not transparent...
-md_5's Cape
-Hover over the example URLs above for a preview!
--
+
- size: The size of the image in pixels.
<%= config.avatars.min_size %> - <%= config.avatars.max_size %>+ - scale: The scale factor renders.
<%= config.renders.min_scale %> - <%= config.renders.max_scale %>+ - helm: Apply the overlay to the avatar. Presence of this parameter implies
true. + -
+ default: The fallback to be used when the requested image cannot be served. You can use a custom URL or any uuid.
+ The option defaults to eitherMHF_SteveorMHF_Alex, depending on the requested UUID. All usernames default toMHF_Steve. +
About UUIDs
+UUIDs may be any valid Mojang UUID in the blank or dashed format.
+Malformed UUIDs are rejected.
Meta
-CORS
-Crafatar supports CORS so you can make AJAX request from within the browser!
-HTTP Headers
-Responses come with these HTTP headers, useful for debugging.
- Please note that these headers are cached by CloudFlare (CF-Cache-Status: HIT).
Response-Time
-The time, in milliseconds, it took Crafatar to process the request.
-X-Storage-Type
-Details about how the requested image was stored on the server
+ +About Usernames
+
+ We strongly advise you to use UUIDs instead of usernames! UUIDs never change while usernames do.
+ Looking up players by username has officially been deprecated by Mojang ever since UUIDs were introduced.
+ Crafatar uses a legacy API to retrieve skins for usernames that updates very slowly.
+ Skins come without any details, including whether a player uses the Alex or Steve skin model.
+ Additionally, Mojang has stated that this legacy interface may be disabled anytime, causing all requests to fail.
+
Malformed usernames are rejected.
+About Caching
+Crafatar caches skins for <%= config.caching.local / 60 %> minutes before checking for skin updates.
+ Images are cached in your browser for <%= config.caching.browser / 60 %> minutes until a new request to Crafatar is made.
+ When you changed your skin you can try clearing your browser cache to see the change faster.
CORS
+Crafatar supports CORS, so you can make AJAX request from other sites!
+HTTP Headers
+
+ Responses come with some custom HTTP headers, useful for debugging.
+ Please note that these headers are cached by CloudFlare (CF-Cache-Status: HIT).
+
-
+
-
+ X-Storage-Type: Details about how the requested image was stored on the server
- none: No external requests. Cached: User has no skin.
- cached: No external requests. Skin cached and stored locally. @@ -287,101 +215,28 @@
- user error: You have done something wrong, such as requesting a malformed uuid.
Check the response body for details.
X-Request-ID
-The internal ID assigned to this request.
- If you think something is wrong with your request, please contact us and provide this ID.
About Usernames
-
- We strongly advise you to use UUIDs instead of usernames! UUIDs never change while usernames do.
- Looking up players by username has officially been deprecated by Mojang ever since UUIDs were introduced.
- Crafatar uses a legacy API to retrieve skins for usernames that updates very slowly.
- Skins come without any details, including whether a player uses the Alex or Steve skin model.
- Additionally, Mojang has stated that this legacy interface may be disabled anytime, causing all requests to fail.
- Malformed usernames are rejected.
-
About UUIDs
-UUIDs may use the blank or dashed format.
- Malformed UUIDs are rejected.
About Caching
-Crafatar caches skins for <%= config.caching.local / 60 %> minutes before checking for skin changes.
- Images are cached in your browser for <%= config.caching.browser / 60 %> minutes until a new request to Crafatar is made.
- When you changed your skin you can try clearing your browser cache to see the change faster.
Contact
--
-
- Follow us on twitter @crafatar -
- Open an issue on GitHub -
- Join us in #crafatar on irc.esper.net +
-
+ X-Request-ID: The internal ID assigned to this request.
+ If you think something is wrong with your request, please contact us and provide this ID.
Contact
+ +
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
-
- 
- 
-