|
|
@@ -64,7 +64,7 @@
|
|
|
<h5>Usernames are deprecated!</h5>
|
|
|
You should only use usernames for <i>testing</i>.<br>
|
|
|
Updates are slower, some features are not available, and it may <strong>break anytime</strong>!<br>
|
|
|
- <i>We strongly advise you to use UUIDs instead of usernames.</i> <small><a href="#usernames">more info</a></small>
|
|
|
+ <i>We strongly advise you to use UUIDs instead of usernames.</i> <small><a href="#meta-usernames">more info</a></small>
|
|
|
</div>
|
|
|
</div>
|
|
|
|
|
|
@@ -109,7 +109,7 @@
|
|
|
</div>
|
|
|
<p>
|
|
|
Accepted <a href="#meta-parameters">modifiers</a>: <i><b>scale</b>, <b>helm</b>, <b>default</b></i>.<br>
|
|
|
- Please note renders are still beta and have some issues. New renders are <a href="https://github.com/crafatar/crafatar/pull/134" target="_blank">in progress</a>!
|
|
|
+ Please note that renders are still beta and have some issues. New renders are <a href="https://github.com/crafatar/crafatar/pull/134" target="_blank">in progress</a>!
|
|
|
</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
@@ -127,7 +127,7 @@
|
|
|
</div>
|
|
|
<p>
|
|
|
Accepted <a href="#meta-parameters">modifiers</a>: <i><b>scale</b>, <b>helm</b>, <b>default</b></i>.<br>
|
|
|
- Please note renders are still beta and have some issues. New renders are <a href="https://github.com/crafatar/crafatar/pull/134" target="_blank">in progress</a>!
|
|
|
+ Please note that renders are still beta and have some issues. New renders are <a href="https://github.com/crafatar/crafatar/pull/134" target="_blank">in progress</a>!
|
|
|
</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
@@ -191,7 +191,7 @@
|
|
|
</p>
|
|
|
<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>scale</b>: The scale factor for 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>
|
|
|
@@ -199,28 +199,28 @@
|
|
|
</ul>
|
|
|
</p>
|
|
|
|
|
|
- <section id="meta-about-uuids">
|
|
|
- <h3><a href="#meta-about-uuids">About UUIDs</a></h3>
|
|
|
+ <section id="meta-uuids">
|
|
|
+ <h3><a href="#meta-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="usernames">
|
|
|
- <h3><a href="#usernames">About Usernames</a></h3>
|
|
|
+ <section id="meta-usernames">
|
|
|
+ <h3><a href="#meta-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 <span title="Mojang interface we get data from">API</span> to retrieve skins for usernames that updates very slowly.<br>
|
|
|
+ Crafatar uses a legacy <span title="Mojang interface we get data from">API</span> which updates very slowly to retrieve skins for usernames.<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>
|
|
|
+ <section id="meta-caching">
|
|
|
+ <h3><a href="#meta-caching">About Caching</a></h3>
|
|
|
<p>
|
|
|
- Crafatar caches skins for <%= config.caching.local / 60 %> minutes before checking for skin updates.<br>
|
|
|
+ Crafatar checks for skin updates every <%= config.caching.local / 60 %> minutes.<br>
|
|
|
Images are cached in your browser for <%= config.caching.browser / 60 %> minutes until a new request to Crafatar is made.<br>
|
|
|
In addition, <span title="A CDN and caching proxy">CloudFlare</span> caches up to 2 hours on a per-url basis.
|
|
|
</p>
|
|
|
@@ -243,11 +243,11 @@
|
|
|
<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>
|
|
|
- <li><b>checked</b>: 1 external request. Skin cached, checked for updates, no skin downloaded.<br>
|
|
|
+ <li><b>none</b>: No external requests. Player has no skin (cached)</li>
|
|
|
+ <li><b>cached</b>: No external requests. (skin cached)</li>
|
|
|
+ <li><b>checked</b>: Requested skin details, skin cached. (1 external request)<br>
|
|
|
This happens either when the user removed their skin or when it didn't change.</li>
|
|
|
- <li><b>downloaded</b>: 2 external requests. First request or skin changed, skin downloaded.</li>
|
|
|
+ <li><b>downloaded</b>: Requested skin details, skin downloaded. (2 external requests)</li>
|
|
|
<li><b>server error</b>: This can happen, for example, when Mojang's servers are down.<br>
|
|
|
If possible, a cached image is served instead.</li>
|
|
|
<li><b>user error</b>: You have done something wrong, such as requesting a malformed uuid.<br>
|
jomo