mirror of
https://github.com/azures04/crafatar.git
synced 2026-03-21 23:41:18 +01:00
03306dff08
none: Cached: User has no skin. cached: Skin cached checked: cached & checked for updates. No (new) skin downloaded: checked, Skin changed or unknown, downloaded. error: (error)
61 lines
2.5 KiB
Plaintext
61 lines
2.5 KiB
Plaintext
extends layout
|
||
|
||
block content
|
||
.container(style= "margin-top: 70px;")
|
||
.row
|
||
.col-md-10
|
||
h1 Crafatar
|
||
hr
|
||
p Welcome to Crafatar, an API for Minecraft's faces!
|
||
|
||
hr
|
||
h2 Documentation
|
||
|
||
h3 Endpoint
|
||
p
|
||
| Replace
|
||
mark.green uuid
|
||
| with a Mojang UUID to get the related head. All images are PNGs.
|
||
.code
|
||
| <img src="#{domain}/avatars/
|
||
mark.green uuid
|
||
| ">
|
||
|
||
h3 Parameters
|
||
h4 size
|
||
p The size of the image in pixels, 1 - 512. <br> Default is 160.
|
||
h4 default
|
||
p The image to be returned when the uuid has no skin (404). <br> Valid options are
|
||
a(href="/avatars/00000000000000000000000000000000?default=steve") steve
|
||
| or
|
||
a(href="/avatars/00000000000000000000000000000000?default=alex") alex
|
||
| .<br> The standard value is calculated based on the UUID (even = alex, odd = steve)
|
||
h4 helm
|
||
p Get an avatar with the second (helmet) layer applied. <br> The content of this parameter is ignored
|
||
|
||
h3 HTTP headers
|
||
p Images will come with these HTTP headers, useful for debugging.
|
||
h4 Response-Time
|
||
p The time, in milliseconds, it took Crafatar to process the request.
|
||
h4 X-Storage-Type
|
||
ul
|
||
li <b>none</b>: No external requests. Cached: User has no skin.
|
||
li <b>cached</b>: No external requests. Skin cached and stored locally.
|
||
li <b>checked</b>: 1 external request. Skin cached, checked for updates, no skin downloaded.<br>
|
||
| This happens either when the user has no skin or it didn't change.
|
||
li <b>downloaded</b>: 2 external requests. Skin changed or unknown, downloaded.
|
||
li <b>error</b>: This can happen, for example, when Mojang's servers are down. If possible, an outdated image will be served instead.
|
||
|
||
h3 Examples
|
||
p Get jeb_'s avatar, 160 × 160 pixels
|
||
.code <img src="#{domain}/avatars/853c80ef3c3749fdaa49938b674adae6">
|
||
p Get jeb_'s avatar, 64 × 64 pixels
|
||
.code <img src="#{domain}/avatars/853c80ef3c3749fdaa49938b674adae6?size=64">
|
||
p Get jeb_'s helmet avatar, 64 × 64 pixels
|
||
.code <img src="#{domain}/avatars/853c80ef3c3749fdaa49938b674adae6?size=64&helm">
|
||
.col-md-2.center
|
||
.sideface.redstone_sheep(title="redstone_sheep")
|
||
.sideface.Jake0oo0(title="Jake0oo0")
|
||
.sideface.Notch(title="Notch")
|
||
.sideface.sk89q(title="sk89q")
|
||
.sideface.md_5(title="md_5") |