mirror of
https://github.com/azures04/crafatar.git
synced 2026-03-21 23:41:18 +01:00
major html rewrite
- show single sample image with endpoint - list accepted parameters - link to details below
This commit is contained in:
jomo
parent
4a6902adac
commit
f0055e7b0a
@ -27,6 +27,7 @@ a.forkme {
|
||||
-webkit-transform: rotate(45deg) translate(62px);
|
||||
transform: rotate(45deg) translate(62px);
|
||||
}
|
||||
|
||||
a.forkme:hover {
|
||||
color: #ddd;
|
||||
text-decoration: none;
|
||||
@ -46,13 +47,39 @@ a.sponsor {
|
||||
font-size: 1rem;
|
||||
}
|
||||
|
||||
mark.green {
|
||||
#documentation .row {
|
||||
background: #eee;
|
||||
border: 1px solid transparent;
|
||||
border-radius: 0.25rem;
|
||||
}
|
||||
|
||||
#documentation .row .col-md-2 {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
#documentation .row > div {
|
||||
padding: 15px;
|
||||
}
|
||||
|
||||
mark {
|
||||
background: inherit;
|
||||
color: #008000;
|
||||
font-weight: bold;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
mark.green {
|
||||
color: #080;
|
||||
}
|
||||
|
||||
mark.blue {
|
||||
color: #08f;
|
||||
}
|
||||
|
||||
span[title] {
|
||||
cursor: help;
|
||||
text-decoration: underline dotted;
|
||||
}
|
||||
|
||||
thead {
|
||||
font-weight: bold;
|
||||
}
|
||||
@ -71,13 +98,10 @@ h1 {
|
||||
}
|
||||
|
||||
h2 {
|
||||
font-size: 1.3rem;
|
||||
}
|
||||
|
||||
h3 {
|
||||
margin-top: 2em;
|
||||
}
|
||||
|
||||
|
||||
h4 {
|
||||
margin-top: 1em;
|
||||
}
|
||||
@ -96,109 +120,6 @@ h4 {
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.code .example {
|
||||
cursor: text;
|
||||
}
|
||||
|
||||
.code .example:hover {
|
||||
color: #000;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
.preview-background {
|
||||
background: #eee;
|
||||
height: 220px;
|
||||
}
|
||||
|
||||
.code .example-wrapper .preview, .code .preview-placeholder {
|
||||
display: none;
|
||||
left: 0;
|
||||
right: 0;
|
||||
position: absolute;
|
||||
bottom: -260px;
|
||||
padding-left: 10px;
|
||||
height: 220px;
|
||||
background-position: 10px center;
|
||||
background-repeat: no-repeat;
|
||||
font-size: 14px;
|
||||
font-family: "Helvetica Neue", Arial, sans-serif;
|
||||
font-weight: 300;
|
||||
color: #666;
|
||||
}
|
||||
|
||||
.code .preview-placeholder {
|
||||
display: block;
|
||||
font-weight: bold;
|
||||
line-height: 200px;
|
||||
}
|
||||
|
||||
.code .preview-placeholder:hover {
|
||||
/* fixes glitchy blinking */
|
||||
display: block !important;
|
||||
}
|
||||
|
||||
.code:hover .preview-placeholder {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.code .example-wrapper .preview i {
|
||||
color: #aaa;
|
||||
}
|
||||
|
||||
.code .example-wrapper:hover .preview {
|
||||
display: block;
|
||||
}
|
||||
|
||||
#avatar-example-1:hover .preview {
|
||||
background-image: url("/avatars/853c80ef3c3749fdaa49938b674adae6");
|
||||
}
|
||||
#avatar-example-2:hover .preview {
|
||||
background-image: url("/avatars/853c80ef3c3749fdaa49938b674adae6?helm");
|
||||
}
|
||||
#avatar-example-3:hover .preview {
|
||||
background-image: url("/avatars/853c80ef3c3749fdaa49938b674adae6?size=128");
|
||||
}
|
||||
#avatar-example-4:hover .preview {
|
||||
background-image: url("/avatars/853c80ef3c3749fdaa49938b674adae6");
|
||||
}
|
||||
#avatar-example-5:hover .preview {
|
||||
background-image: url("/avatars/0?default=mhf_alex");
|
||||
}
|
||||
#avatar-example-6:hover .preview {
|
||||
background-image: url("/avatars/0?default=https%3A%2F%2Fi.imgur.com%2FocJVWAc.png");
|
||||
}
|
||||
|
||||
#render-example-1:hover .preview {
|
||||
background-image: url("/renders/body/853c80ef3c3749fdaa49938b674adae6?helm&scale=4");
|
||||
}
|
||||
#render-example-2:hover .preview {
|
||||
background-image: url("/renders/head/853c80ef3c3749fdaa49938b674adae6?scale=8");
|
||||
}
|
||||
|
||||
#skin-example-1:hover .preview {
|
||||
background-image: url("/skins/853c80ef3c3749fdaa49938b674adae6");
|
||||
}
|
||||
#skin-example-2:hover .preview {
|
||||
background-image: url("/skins/0?default=mhf_alex");
|
||||
}
|
||||
|
||||
#cape-example-1:hover .preview {
|
||||
background-image: url("/capes/61699b2ed3274a019f1e0ea8c3f06bc6");
|
||||
}
|
||||
#cape-example-2:hover .preview {
|
||||
background-image: url("/capes/af74a02d19cb445bb07f6866a861f783");
|
||||
}
|
||||
|
||||
img.preload {
|
||||
/*
|
||||
preload hover images
|
||||
browsers don't load 0x0 images
|
||||
*/
|
||||
position: fixed;
|
||||
top: -9999px;
|
||||
left: -9999px;
|
||||
}
|
||||
|
||||
.jumbotron {
|
||||
padding: 1em 0 3em;
|
||||
}
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<title>Crafatar</title>
|
||||
<link rel="icon" sizes="16x16" type="image/png" href="/favicon.png">
|
||||
<meta charset="utf-8">
|
||||
<!-- FIXME: Use CDN --> <link rel="stylesheet" href="/stylesheets/bootstrap.min.css">
|
||||
<%# FIXME: Use CDN %><link rel="stylesheet" href="/stylesheets/bootstrap.min.css">
|
||||
<link rel="stylesheet" href="/stylesheets/style.css">
|
||||
<meta name="description" content="Crafatar is a blazing fast Minecraft avatar API with support for avatars, skins, and even 3D renders!">
|
||||
<meta name="keywords" content="minecraft, avatar, renders, skins, uuid, username">
|
||||
@ -30,6 +30,7 @@
|
||||
<h2>A blazing fast API for Minecraft faces!</h2>
|
||||
|
||||
<div id="avatar-wrapper">
|
||||
<%# These are shuffled by JS %>
|
||||
<div title="jomo's avatar" class="avatar jomo"></div>
|
||||
<div title="jake_0's avatar" class="avatar jake_0"></div>
|
||||
<div title="sk89q's avatar" class="avatar sk89q"></div>
|
||||
@ -63,219 +64,146 @@
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h2>Documentation</h2>
|
||||
<div class="row">
|
||||
<section id="avatars">
|
||||
<h3><a href="#avatars">Avatars</a></h3>
|
||||
<div class="code"><%= domain %>/avatars/<mark class="green">uuid</mark>
|
||||
<section id="avatars">
|
||||
<h2><a href="#avatars">Avatars</a></h2>
|
||||
<div class="row">
|
||||
<div class="col-md-2">
|
||||
<img src="/avatars/853c80ef3c3749fdaa49938b674adae6?size=100" alt="jeb_'s avatar">
|
||||
</div>
|
||||
<section id="avatar-parameters">
|
||||
<h4><a href="#avatar-parameters">Avatar Parameters</a></h4>
|
||||
<table class="table table-striped">
|
||||
<thead>
|
||||
<tr>
|
||||
<td>parameter</td>
|
||||
<td>type</td>
|
||||
<td>default</td>
|
||||
<td>description</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>size</td>
|
||||
<td>integer</td>
|
||||
<td><%= config.avatars.default_size %></td>
|
||||
<td>The size of the image in pixels, <%= config.avatars.min_size %> - <%= config.avatars.max_size%>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>default</td>
|
||||
<td>string</td>
|
||||
<td>The standard value is calculated based on the UUID (even = MHF_Alex, odd = MHF_Steve).<br>
|
||||
Usernames always default to MHF_Steve.</td>
|
||||
<td>The image to be served when the player has no skin.<br>
|
||||
Valid options are any name or uuid, including<a href="/avatars/0?default=MHF_Steve"> MHF_Steve</a> and<a href="/avatars/0?default=MHF_Alex"> MHF_Alex</a>, or a custom URL.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>helm</td>
|
||||
<td>null</td>
|
||||
<td></td>
|
||||
<td>Apply the "second" layer (hat) to the avatar.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="avatar-examples">
|
||||
<h4><a href="#avatar-examples">Avatar Examples</a></h4>
|
||||
<div class="col-md-10">
|
||||
<div class="code">
|
||||
<div id="avatar-example-1" class="example-wrapper">
|
||||
<div class="example"><%= domain %>/avatars/853c80ef3c3749fdaa49938b674adae6</div>
|
||||
<p class="preview">Jeb's avatar</p>
|
||||
</div>
|
||||
<div id="avatar-example-2" class="example-wrapper">
|
||||
<div class="example"><%= domain %>/avatars/853c80ef3c3749fdaa49938b674adae6?helm</div>
|
||||
<p class="preview">Jeb's avatar with helm</p>
|
||||
</div>
|
||||
<div id="avatar-example-3" class="example-wrapper">
|
||||
<div class="example"><%= domain %>/avatars/853c80ef3c3749fdaa49938b674adae6?size=128</div>
|
||||
<p class="preview">Jeb's avatar, 128 × 128</p>
|
||||
</div>
|
||||
<div id="avatar-example-4" class="example-wrapper">
|
||||
<div class="example"><%= domain %>/avatars/853c80ef3c3749fdaa49938b674adae6</div>
|
||||
<p class="preview">Jeb's avatar by UUID</p>
|
||||
</div>
|
||||
<div id="avatar-example-5" class="example-wrapper">
|
||||
<div class="example"><%= domain %>/avatars/853c80ef3c3749fdaa49938b674adae6?default=MHF_Alex</div>
|
||||
<p class="preview">Jeb's avatar, or fall back to MHF_Alex <i>(this example assumes jeb_ does not exist)</i></p>
|
||||
</div>
|
||||
<div id="avatar-example-6" class="example-wrapper">
|
||||
<div class="example"><%= domain %>/avatars/853c80ef3c3749fdaa49938b674adae6?default=https%3A%2F%2Fi.imgur.com%2FocJVWAc.png</div>
|
||||
<p class="preview">Jeb's avatar, or fall back to a custom image <i>(this example assumes jeb_ does not exist)</i></p>
|
||||
</div>
|
||||
<p class="preview-placeholder">Hover over the example URLs above for a preview!</p>
|
||||
<%= domain %>/avatars/<mark class="green">uuid</mark>
|
||||
</div>
|
||||
<div class="preview-background"></div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="renders">
|
||||
<h3><a href="#renders">3D Renders</a></h3>
|
||||
<p>Crafatar also provides support for 3D renders of Minecraft skins.<br>
|
||||
Please note that <b>this feature is currently beta</b>!<br>
|
||||
The <b>head</b> render type returns a render of the skin's head.<span class="code"><%= domain %>/renders/head/<mark class="green">uuid</mark></span>The <b>body</b> render returns a render of the entire skin.<span class="code"><%= domain %>/renders/body/<mark class="green">uuid</mark></span></p>
|
||||
<section id="render-parameters">
|
||||
<h4><a href="#render-parameters">Render Parameters</a></h4>
|
||||
<table class="table table-striped">
|
||||
<thead>
|
||||
<tr>
|
||||
<td>parameter</td>
|
||||
<td>type</td>
|
||||
<td>default</td>
|
||||
<td>description</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>scale</td>
|
||||
<td>integer</td>
|
||||
<td><%= config.renders.default_scale %>. The actual size differs between the type of render.</td>
|
||||
<td>The scale factor of the image <%= config.renders.min_scale %> - <%= config.renders.max_scale %>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>helm</td>
|
||||
<td>null</td>
|
||||
<td></td>
|
||||
<td>Apply the "second" layer (hat) to the avatar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>default</td>
|
||||
<td>string</td>
|
||||
<td>The standard value is calculated based on the UUID (even = MHF_Alex, odd = MHF_Steve).<br>
|
||||
Usernames always default to MHF_Steve.</td>
|
||||
<td>The image to be served when the uuid has no skin.<br>
|
||||
Valid options are any uuid, including<a href="/renders/body/0?default=MHF_Steve"> MHF_Steve</a> and<a href="/renders/body/0?default=MHF_Alex"> MHF_Alex</a>, or a custom URL.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="render-examples">
|
||||
<h4><a href="#render-examples">Render Examples</a></h4>
|
||||
<p>Accepted <a href="#meta-parameters">parameters</a>: <i><b>size</b>, <b>helm</b>, <b>default</b></i>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section id="head-renders">
|
||||
<h2><a href="#head-renders">Head Renders</a></h2>
|
||||
<div class="row">
|
||||
<div class="col-md-2">
|
||||
<img src="/renders/head/853c80ef3c3749fdaa49938b674adae6" alt="jeb_'s head">
|
||||
</div>
|
||||
<div class="col-md-10">
|
||||
<div class="code">
|
||||
<div id="render-example-1" class="example-wrapper">
|
||||
<div class="example"><%= domain %>/renders/body/853c80ef3c3749fdaa49938b674adae6?helm&scale=4</div>
|
||||
<p class="preview">Jeb's body, with helmet, scale 4</p>
|
||||
</div>
|
||||
<div id="render-example-2" class="example-wrapper">
|
||||
<div class="example"><%= domain %>/renders/head/853c80ef3c3749fdaa49938b674adae6?scale=8</div>
|
||||
<p class="preview">Jeb's head, by UUID, scale 8</p>
|
||||
</div>
|
||||
<p class="preview-placeholder">Hover over the example URLs above for a preview!</p>
|
||||
<%= domain %>/renders/head/<mark class="green">uuid</mark>
|
||||
</div>
|
||||
<div class="preview-background"></div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="skins">
|
||||
<h3><a href="#skins">Skins</a></h3>
|
||||
<p>You can also get the full skin file of a player.<br>
|
||||
The user's skin is returned, or the default image is served.<br>
|
||||
You can use the default parameter here as well.<span class="code"><%= domain %>/skins/<mark class="green">uuid</mark></span></p>
|
||||
<section id="skin-parameters">
|
||||
<h4><a href="#skin-parameters">Skin Parameters</a></h4>
|
||||
<table class="table table-striped">
|
||||
<thead>
|
||||
<tr>
|
||||
<td>parameter</td>
|
||||
<td>type</td>
|
||||
<td>default</td>
|
||||
<td>description</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>default</td>
|
||||
<td>string</td>
|
||||
<td>The standard value is calculated based on the UUID (even = MHF_Alex, odd = MHF_Steve).<br>
|
||||
Usernames always default to MHF_Steve.</td>
|
||||
<td>The image to be served when the uuid has no skin.<br>
|
||||
Valid options are any uuid, including<a href="/skins/0?default=MHF_Steve"> MHF_Steve</a> and<a href="/skins/0?default=MHF_Alex"> MHF_Alex</a>, or a custom URL.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="skin-examples">
|
||||
<h4><a href="#skin-examples">Skin Examples</a></h4>
|
||||
<p>Accepted <a href="#meta-parameters">parameters</a>: <i><b>scale</b>, <b>helm</b>, <b>default</b></i>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section id="body-renders">
|
||||
<h2><a href="#body-renders">Body Renders</a></h2>
|
||||
<div class="row">
|
||||
<div class="col-md-2">
|
||||
<img src="/renders/body/853c80ef3c3749fdaa49938b674adae6" alt="jeb_'s body">
|
||||
</div>
|
||||
<div class="col-md-10">
|
||||
<div class="code">
|
||||
<div id="skin-example-1" class="example-wrapper">
|
||||
<div class="example"><%= domain %>/skins/853c80ef3c3749fdaa49938b674adae6</div>
|
||||
<p class="preview">Jeb's skin</p>
|
||||
</div>
|
||||
<div id="skin-example-2" class="example-wrapper">
|
||||
<div class="example"><%= domain %>/skins/853c80ef3c3749fdaa49938b674adae6?default=MHF_Alex</div>
|
||||
<p class="preview">Jeb's skin, or fall back to MHF_Alex <i>(this example assumes jeb_ does not exist)</i></p>
|
||||
</div>
|
||||
<p class="preview-placeholder">Hover over the example URLs above for a preview!</p>
|
||||
<%= domain %>/renders/body/<mark class="green">uuid</mark>
|
||||
</div>
|
||||
<div class="preview-background"></div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="capes">
|
||||
<h3><a href="#capes">Capes</a></h3>
|
||||
<p>A cape endpoint is also available to get the active cape of a user.<br>
|
||||
The user's cape is returned, otherwise a 404 is returned.<br>
|
||||
<div class="code"><%= domain %>/capes/<mark class="green">uuid</mark>
|
||||
<p>Accepted <a href="#meta-parameters">parameters</a>: <i><b>scale</b>, <b>helm</b>, <b>default</b></i>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section id="skins">
|
||||
<h2><a href="#skins">Skins</a></h2>
|
||||
<div class="row">
|
||||
<div class="col-md-2">
|
||||
<img src="/skins/853c80ef3c3749fdaa49938b674adae6" alt="jeb_'s skin">
|
||||
</div>
|
||||
<div class="col-md-10">
|
||||
<div class="code">
|
||||
<%= domain %>/skins/<mark class="green">uuid</mark>
|
||||
</div>
|
||||
<p>Accepted <a href="#meta-parameters">parameters</a>: <b>default</b></i>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section id="capes">
|
||||
<h2><a href="#capes">Capes</a></h2>
|
||||
<div class="row">
|
||||
<div class="col-md-2">
|
||||
<img src="/capes/853c80ef3c3749fdaa49938b674adae6?default=069a79f444e94726a5befca90e38aaf5" alt="jeb_'s cape">
|
||||
</div>
|
||||
<div class="col-md-10">
|
||||
<div class="code">
|
||||
<%= domain %>/capes/<mark class="green">uuid</mark>
|
||||
</div>
|
||||
<p>Accepted <a href="#meta-parameters">parameters</a>: <b>default</b></i>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<hr>
|
||||
|
||||
<section id="meta">
|
||||
<h3><a href="#meta">Meta</a></h3>
|
||||
<p>
|
||||
In the examples above, you can generally use usernames instead of <mark class="green">uuid</mark>. However, apart from the special cases <code><a href="/renders/body/0?default=MHF_Steve" target="_blank">MHF_Steve</a></code> and <code><a href="/renders/body/0?default=MHF_Alex" target="_blank">MHF_Alex</a></code> this is discouraged as explained below.<br>
|
||||
You can append <code>.png</code> or any other file extension to the URL path if you like to, but all images are PNG.
|
||||
</p>
|
||||
|
||||
<section id="meta-parameters">
|
||||
<h3><a href="#meta-parameters">URL Parameters</a></h3>
|
||||
<p>
|
||||
You can tweak images using <a href="https://en.wikipedia.org/wiki/Query_string" target="_blank">query string parameters</a>.<br>
|
||||
Example: <code><%= domain %>/avatars/853c80ef3c3749fdaa49938b674adae6<mark class="blue">?</mark><mark class="green">size=4</mark><mark class="blue">&</mark><mark class="green">default=MHF_Steve</mark><mark class="blue">&</mark><mark class="green">helm</mark></code>
|
||||
</p>
|
||||
<section id="cape-examples">
|
||||
<h4><a href="#cape-examples">Cape Examples</a></h4>
|
||||
<div class="code">
|
||||
<div id="cape-example-1" class="example-wrapper">
|
||||
<div class="example"><%= domain %>/capes/61699b2ed3274a019f1e0ea8c3f06bc6</div>
|
||||
<p class="preview">Dinnerbone's Cape <i>Mojang capes are not transparent...</i></p>
|
||||
</div>
|
||||
<div id="cape-example-2" class="example-wrapper">
|
||||
<div class="example"><%= domain %>/capes/af74a02d19cb445bb07f6866a861f783</div>
|
||||
<p class="preview">md_5's Cape</p>
|
||||
</div>
|
||||
<p class="preview-placeholder">Hover over the example URLs above for a preview!</p>
|
||||
</div>
|
||||
<div class="preview-background"></div>
|
||||
</section>
|
||||
<ul>
|
||||
<li><b>size</b>: The size of the image in pixels. <code><%= config.avatars.min_size %> - <%= config.avatars.max_size %></code>
|
||||
<li><b>scale</b>: The scale factor renders. <code><%= config.renders.min_scale %> - <%= config.renders.max_scale %></code>
|
||||
<li><b>helm</b>: Apply the <span title="Also known as 'hat' or 'jacket' or 'helm'">overlay</span> to the avatar. Presence of this parameter implies <code>true</code>.
|
||||
<li>
|
||||
<b>default</b>: The fallback to be used when the requested image cannot be served. You can use a <span title="Make sure to properly percent-encode this!">custom URL</span> or any <mark class="green">uuid</mark>.<br>
|
||||
The option defaults to either <code>MHF_Steve</code> or <code>MHF_Alex</code>, depending on the requested UUID. All usernames default to <code>MHF_Steve</code>.
|
||||
</ul>
|
||||
</p>
|
||||
|
||||
<section id="meta-about-uuids">
|
||||
<h3><a href="#meta-about-uuids">About UUIDs</a></h3>
|
||||
<p>UUIDs may be any valid Mojang UUID in the blank or dashed format.</p>
|
||||
<p>Malformed UUIDs are rejected.</p>
|
||||
</section>
|
||||
<section id="meta">
|
||||
<h2><a href="#meta">Meta</a></h2>
|
||||
<section id="meta-cors">
|
||||
<h3><a href="#meta-cors">CORS</a></h3>
|
||||
<p>Crafatar supports CORS so you can make AJAX request from within the browser!</p>
|
||||
</section>
|
||||
<section id="meta-http-headers">
|
||||
<h3><a href="#meta-http-headers">HTTP Headers</a></h3>
|
||||
<p>Responses come with these HTTP headers, useful for debugging.<br>
|
||||
Please note that these headers are cached by CloudFlare <small>(CF-Cache-Status: HIT)</small>.</p>
|
||||
<section id="meta-response-time">
|
||||
<h4><a href="#meta-response-time">Response-Time</a></h4>
|
||||
<p>The time, in milliseconds, it took Crafatar to process the request.</p>
|
||||
</section>
|
||||
<section id="meta-x-storage-type">
|
||||
<h4><a href="#meta-x-storage-type">X-Storage-Type</a></h4>
|
||||
<p>Details about how the requested image was stored on the server</p>
|
||||
|
||||
<section id="usernames">
|
||||
<h3><a href="#usernames">About Usernames</a></h3>
|
||||
<p>
|
||||
We <strong>strongly</strong> advise you to use UUIDs instead of usernames! UUIDs never change while usernames do.<br>
|
||||
Looking up players by username has officially been deprecated by Mojang ever since UUIDs were introduced.<br>
|
||||
Crafatar uses a legacy API to retrieve skins for usernames that updates very slowly.<br>
|
||||
Skins come without any details, including whether a player uses the Alex or Steve skin model.<br>
|
||||
Additionally, Mojang has stated that this legacy interface may be disabled anytime, causing all requests to fail.
|
||||
</p>
|
||||
<p>Malformed usernames are rejected.</p>
|
||||
</section>
|
||||
|
||||
<section id="meta-about-caching">
|
||||
<h3><a href="#meta-about-caching">About Caching</a></h3>
|
||||
<p>Crafatar caches skins for <%= config.caching.local / 60 %> minutes before checking for skin updates.<br>
|
||||
Images are cached in your browser for <%= config.caching.browser / 60 %> minutes until a new request to Crafatar is made.<br>
|
||||
When you changed your skin you can try clearing your browser cache to see the change faster.</p>
|
||||
</section>
|
||||
|
||||
<section id="meta-cors">
|
||||
<h3><a href="#meta-cors">CORS</a></h3>
|
||||
<p>Crafatar supports CORS, so you can make AJAX request from other sites!</p>
|
||||
</section>
|
||||
|
||||
<section id="meta-http-headers">
|
||||
<h3><a href="#meta-http-headers">HTTP Headers</a></h3>
|
||||
<p>
|
||||
Responses come with some custom HTTP headers, useful for debugging.<br>
|
||||
Please note that these headers are cached by CloudFlare <small>(CF-Cache-Status: HIT)</small>.
|
||||
</p>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<b>X-Storage-Type</b>: Details about how the requested image was stored on the server
|
||||
<ul>
|
||||
<li><b>none</b>: No external requests. Cached: User has no skin.</li>
|
||||
<li><b>cached</b>: No external requests. Skin cached and stored locally.</li>
|
||||
@ -287,101 +215,28 @@
|
||||
<li><b>user error</b>: You have done something wrong, such as requesting a malformed uuid.<br>
|
||||
Check the response body for details.</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="meta-x-request-id">
|
||||
<h4><a href="#meta-x-request-id">X-Request-ID</a></h4>
|
||||
<p>The internal ID assigned to this request.<br>
|
||||
If you think something is wrong with your request, please <a href="#contact">contact us</a> and provide this ID.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="usernames">
|
||||
<h3><a href="#usernames">About Usernames</a></h3>
|
||||
<p>
|
||||
We <strong>strongly</strong> advise you to use UUIDs instead of usernames! UUIDs never change while usernames do.<br>
|
||||
Looking up players by username has officially been deprecated by Mojang ever since UUIDs were introduced.<br>
|
||||
Crafatar uses a legacy API to retrieve skins for usernames that updates very slowly.<br>
|
||||
Skins come without any details, including whether a player uses the Alex or Steve skin model.<br>
|
||||
Additionally, Mojang has stated that this legacy interface may be disabled anytime, causing all requests to fail.<br>
|
||||
Malformed usernames are rejected.
|
||||
</p>
|
||||
</section>
|
||||
<section id="meta-about-uuids">
|
||||
<h3><a href="#meta-about-uuids">About UUIDs</a></h3>
|
||||
<p>UUIDs may use the blank or dashed format.<br>
|
||||
Malformed UUIDs are rejected.</p>
|
||||
</section>
|
||||
<section id="meta-about-caching">
|
||||
<h3><a href="#meta-about-caching">About Caching</a></h3>
|
||||
<p>Crafatar caches skins for <%= config.caching.local / 60 %> minutes before checking for skin changes.<br>
|
||||
Images are cached in your browser for <%= config.caching.browser / 60 %> minutes until a new request to Crafatar is made.<br>
|
||||
When you changed your skin you can try clearing your browser cache to see the change faster.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="contact">
|
||||
<h2><a href="#contact">Contact</a></h2>
|
||||
<ul>
|
||||
<li>Follow us on twitter <a href="https://twitter.com/crafatar" target="_blank">@crafatar</a></li>
|
||||
<li>Open an issue <a href="https://github.com/crafatar/crafatar/issues" target="_blank">on GitHub</a></li>
|
||||
<li><a href="https://webchat.esper.net/?channels=crafatar" target="_blank">Join us</a> in #crafatar on irc.esper.net</li>
|
||||
<li>
|
||||
<b>X-Request-ID</b>: The internal ID assigned to this request.<br>
|
||||
If you think something is wrong with your request, please <a href="#contact">contact us</a> and provide this ID.
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section id="contact">
|
||||
<h2><a href="#contact">Contact</a></h2>
|
||||
<ul>
|
||||
<li>Follow us on twitter <a href="https://twitter.com/crafatar" target="_blank">@crafatar</a></li>
|
||||
<li>Open an issue <a href="https://github.com/crafatar/crafatar/issues" target="_blank">on GitHub</a></li>
|
||||
<li><a href="https://webchat.esper.net/?channels=crafatar" target="_blank">Join us</a> in #crafatar on irc.esper.net</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
<footer>
|
||||
<hr>
|
||||
<p class="pull-right">Copyright Crafatar <%= new Date().getFullYear() %></p>
|
||||
</footer>
|
||||
</div>
|
||||
<img src="/avatars/020242a17b9441799eff511eea1221da?size=64" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/020242a17b9441799eff511eea1221da?size=64&helm" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/069a79f444e94726a5befca90e38aaf5?size=64" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/0?default=MHF_Alex" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/0?default=https%3A%2F%2Fi.imgur.com%2FocJVWAc.png" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/0ea8eca3dbf647cc9d1ac64551ca975c?size=64" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/0ea8eca3dbf647cc9d1ac64551ca975c?size=64&helm" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/1c1bd09a6a0f4928a7914102a35d2670?size=64" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/1c1bd09a6a0f4928a7914102a35d2670?size=64&helm" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/2d5aa9cdaeb049189930461fc9b91cc5?size=64" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/2d5aa9cdaeb049189930461fc9b91cc5?size=64&helm" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/4566e69fc90748ee8d71d7ba5aa00d20?size=64" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/4566e69fc90748ee8d71d7ba5aa00d20?size=64&helm" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/61699b2ed3274a019f1e0ea8c3f06bc6?size=64" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/61699b2ed3274a019f1e0ea8c3f06bc6?size=64&helm" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/696a82ce41f44b51aa31b8709b8686f0?size=64" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/696a82ce41f44b51aa31b8709b8686f0?size=64&helm" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/7125ba8b1c864508b92bb5c042ccfe2b?size=64" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/7125ba8b1c864508b92bb5c042ccfe2b?size=64&helm" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/7d043c7389524696bfba571c05b6aec0?size=64" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/7d043c7389524696bfba571c05b6aec0?size=64&helm" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/853c80ef3c3749fdaa49938b674adae6" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/853c80ef3c3749fdaa49938b674adae6?size=64" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/853c80ef3c3749fdaa49938b674adae6?size=64&helm" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/9769ecf6331448f3ace67ae06cec64a3?size=64" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/9769ecf6331448f3ace67ae06cec64a3?size=64&helm" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/ae795aa86327408e92ab25c8a59f3ba1?size=64" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/ae795aa86327408e92ab25c8a59f3ba1?size=64&helm" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/af74a02d19cb445bb07f6866a861f783?size=64" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/af74a02d19cb445bb07f6866a861f783?size=64&helm" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/b05881186e75410db2db4d3066b223f7?size=64" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/b05881186e75410db2db4d3066b223f7?size=64&helm" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/b9583ca43e64488a9c8c4ab27e482255?size=64" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/b9583ca43e64488a9c8c4ab27e482255?size=64&helm" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/c9b54008fd8047428b238787b5f2401c?size=64" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/c9b54008fd8047428b238787b5f2401c?size=64&helm" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/d8f9a4340f2d415f9acfcd70341c75ec?size=64" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/d8f9a4340f2d415f9acfcd70341c75ec?size=64&helm" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/e6b5c088068044df9e1b9bf11792291b?size=64" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/e6b5c088068044df9e1b9bf11792291b?size=64&helm" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/f8cdb6839e9043eea81939f85d9c5d69?size=64" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/f8cdb6839e9043eea81939f85d9c5d69?size=64&helm" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/853c80ef3c3749fdaa49938b674adae6" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/853c80ef3c3749fdaa49938b674adae6?helm" alt="preloaded image" class="preload">
|
||||
<img src="/avatars/853c80ef3c3749fdaa49938b674adae6?size=128" alt="preloaded image" class="preload">
|
||||
<img src="/capes/61699b2ed3274a019f1e0ea8c3f06bc6" alt="preloaded image" class="preload">
|
||||
<img src="/capes/af74a02d19cb445bb07f6866a861f783" alt="preloaded image" class="preload">
|
||||
<img src="/renders/body/853c80ef3c3749fdaa49938b674adae6?helm&scale=4" alt="preloaded image" class="preload">
|
||||
<img src="/renders/head/853c80ef3c3749fdaa49938b674adae6?scale=8" alt="preloaded image" class="preload">
|
||||
<img src="/skins/0?default=MHF_Alex" alt="preloaded image" class="preload">
|
||||
<img src="/skins/853c80ef3c3749fdaa49938b674adae6" alt="preloaded image" class="preload">
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Loading…
x
Reference in New Issue
Block a user