diff --git a/views/index.jade b/views/index.jade
index f26e0cd..64a0223 100644
--- a/views/index.jade
+++ b/views/index.jade
@@ -11,30 +11,41 @@ block content
hr
h2 Documentation
- h3 Endpoint
+ h3 Avatars
p
| Replace
- mark.green uuid
- | with a Mojang UUID to get the related head. All images are PNGs.
+ mark.green id
+ | with a Mojang UUID or username to get the related head. All images are PNGs.
.code
| <img src="#{domain}/avatars/
- mark.green uuid
+ mark.green id
| ">
h3 Parameters
h4 size
p The size of the image in pixels, 1 - 512.
Default is 160.
h4 default
- p The image to be returned when the uuid has no skin (404).
Valid options are
+ p The image to be returned when the id has no skin (404).
Valid options are
a(href="/avatars/00000000000000000000000000000000?default=steve") steve
| or
a(href="/avatars/00000000000000000000000000000000?default=alex") alex
- | .
The standard value is calculated based on the UUID (even = alex, odd = steve)
+ | .
The standard value is calculated based on the id (even = alex, odd = steve)
h4 helm
p Get an avatar with the second (helmet) layer applied.
The content of this parameter is ignored
+ h3 Skins
+ p You can also get the full skin file from name or id.
+ | Replace
+ mark.green id
+ | with a Mojang UUID or username to get the related skin.
+ | You are redirected to the textures URL, or a 404 is returned.
+ .code
+ | <img src="#{domain}/skins/
+ mark.green id
+ | ">
+
h3 HTTP headers
- p Images will come with these HTTP headers, useful for debugging.
+ p Responses 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
@@ -42,9 +53,19 @@ block content
li none: No external requests. Cached: User has no skin.
li cached: No external requests. Skin cached and stored locally.
li checked: 1 external request. Skin cached, checked for updates, no skin downloaded.
- | This happens either when the user has no skin or it didn't change.
+ | This happens either when the user removed their skin or when it didn't change.
li downloaded: 2 external requests. Skin changed or unknown, downloaded.
- li error: This can happen, for example, when Mojang's servers are down. If possible, an outdated image will be served instead.
+ li error: This can happen, for example, when Mojang's servers are down.
+ | If possible, an outdated image is be served instead.
+
+ h3 About usernames
+ p We strongly advise you to use UUIDs instead of usernames in production.
+ | Usernames are deprecated by Mojang and you should only use usernames for testing.
+ | Invalid usernames are rejected and a 422 is returned.
+
+ h3 About UUIDs
+ p UUIDs may use the raw or dashed format.
+ | Invalid UUIDs are rejected and a 422 is returned.
h3 Examples
p Get jeb_'s avatar, 160 × 160 pixels
@@ -53,6 +74,12 @@ block content
.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">
+ p Get jeb_'s avatar by username, 160 x 160 pixels
+ .code <img src="#{domain}/avatars/jeb_">
+ p Get jeb_'s skin
+ .code <img src="#{domain}/skins/853c80ef3c3749fdaa49938b674adae6">
+ p Get jeb_'s skin by username
+ .code <img src="#{domain}/skins/jeb_">
.col-md-2.center
.sideface.redstone_sheep(title="redstone_sheep")
.sideface.Jake0oo0(title="Jake0oo0")