firstdarkdev/skinatar
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions
No description
18 commits 1 branch 6 tags 61 KiB
Find a file
Exact
Rover656 24d4b4331d
All checks were successful
Build and Publish Docker Image / build (push) Successful in 37s
Details
Update .github/workflows/docker-publish.yml
2025-10-12 20:58:56 +00:00
.github/workflows Update .github/workflows/docker-publish.yml 2025-10-12 20:58:56 +00:00
.gitignore Initial Commit 2025-04-01 23:53:47 +02:00
cache.go [CHANGE] Lift Cache Time to 2 hours, to match Cloudflare Cache Config 2025-04-02 13:07:46 +02:00
cleanup.go [BUG] Replace faulty cleanup go-routine with cron job 2025-08-08 18:52:27 +02:00
docker-compose.yml [DEV] Update WebP dependency and fix docker cache paths 2025-07-09 21:43:29 +02:00
Dockerfile [DEV] Add webp build-dependencies 2025-04-05 22:58:47 +02:00
fallback.png Initial Commit 2025-04-01 23:53:47 +02:00
go.mod [BUG] Replace faulty cleanup go-routine with cron job 2025-08-08 18:52:27 +02:00
go.sum [BUG] Replace faulty cleanup go-routine with cron job 2025-08-08 18:52:27 +02:00
http.go [IMPROVE] Cache renders and use WEBP instead of png. Lowers overall CPU usage and render performance 2025-04-05 22:55:47 +02:00
license.md Initial Commit 2025-04-01 23:53:47 +02:00
main.go [BUG] Replace faulty cleanup go-routine with cron job 2025-08-08 18:52:27 +02:00
ratelimiter.go [FEAT] Basic ratelimiter to prevent overloading CPU on requests 2025-04-02 13:17:47 +02:00
readme.md [CHORE] Update Readme 2025-04-02 13:27:45 +02:00
skins.go [IMPROVE] Cache renders and use WEBP instead of png. Lowers overall CPU usage and render performance 2025-04-05 22:55:47 +02:00
structs.go Initial Commit 2025-04-01 23:53:47 +02:00
utils.go [IMPROVE] Cache renders and use WEBP instead of png. Lowers overall CPU usage and render performance 2025-04-05 22:55:47 +02:00

readme.md

Skinatar

Experimental minecraft avatar service for Simple Discord Link, Simple RPC and other mods.

As of now, this system is in testing, and not quite recommended for public use yet.

You are however, free to self-host this, for your own use.

What is this?

This is a simple Minecraft avatar api, that allows you to retrieve Minecraft Avatars, Heads or Full Body renders with either a UUID, Username or Texture Hash. This service should support Geyser Bedrock Accounts, as well as mods like Fabric Tailor.

Caching

The server itself, makes use of Caching to prevent spamming Mojang servers. Additionally, our production instance also uses Cloudflare caching.

Skins and Usernames are cached for 2 hours (both on the server, and via Cloudflare), before they are pulled again.

Ratelimits

Requests are limited to 5 requests per second. This is just to prevent frequent calls for skins, when trying to bypass the cloudflare cache, which would put additional load on our servers.

How do I host this?

Simple. Make a copy of the docker-compose.yml file found in this repo. Then, just run docker compose up -d.

You will need to handle your own URL management for this, either via Cloudflare Tunnels, Apache, NGINX or Nginx Proxy Manager. By default, the server uses port 8080. Caching is also up to you to configure. If you need help with this, we might be able to assist you via our discord server.

In the future, we might allow public usage of our hosted instance, once it's proven battle ready

Endpoints

The server includes the following endpoints for skins:

  • Head -> SERVERURL/head/{UUID|USERNAME|TEXTUREHASH} or SERVERURL/isometric/{UUID|USERNAME|TEXTUREHASH}
  • Full Body -> SERVERURL/body/{UUID|USERNAME|TEXTUREHASH}
  • Avatar -> SERVERURL/avarar/{UUID|USERNAME|TEXTUREHASH}

License

This application and code is licensed under MIT.