A blazing fast API for Minecraft faces

jomo cc2840ae4b log error if http code not available 10 年 前
images 47a978df6c add image dir to git 10 年 前
lib cc2840ae4b log error if http code not available 10 年 前
test a15cb20144 TooManyRequestsException shouldn't actually throw an error 10 年 前
.buildpacks 2873157e97 Add 3d render support 10 年 前
.editorconfig 16fdf8d1ac add editorconfig for .gitignore 10 年 前
.gitignore 47a978df6c add image dir to git 10 年 前
.travis.yml 90022d9e6c revert 4d949362beeaf432201f576d83518dd0bb0351a8 10 年 前
CONTRIBUTING.md 8750b863a8 contributing: add tests for fixed issues 10 年 前
LICENSE e8727a0d0d Happy New Year! :tada: :tada: 10 年 前
Procfile 5f0a3dcb63 use postinstall script instead of Procfile 10 年 前
README.md 7e77142b29 add link to crafatar/setup 10 年 前
app.json fe12901f41 update app.json 10 年 前
config.example.js 8ddc300a11 #138 bump http_timeout to 2 seconds 10 年 前
package.json fe12901f41 update app.json 10 年 前
www.js 85e7b4b571 remove clusters 10 年 前

README.md

Crafatar travis Coverage Status Code Climate

dependency status devDependency status docs status

logo Crafatar serves Minecraft avatars based on the skin for use in external applications. Inspired by Gravatar (hence the name) and Minotar.

Image manipulation is done by lwip. 3D renders are created with node-canvas, based on math by confuser.

Contributions welcome!

There are usually a few open issues.
We welcome any opinions or advice in discussions as well as pull requests.
Issues tagged with help wanted show where we could especially need your help!

Examples

jomo's avatar Jake_0's avatar Notch's avatar sk89q's avatar
jomo's 3d head Jake_0's 3d head Notch's 3d head sk89q's 3d head
jomo's 3d body Jake_0's 3d body Notch's 3d body sk89q's 3d body
jomo's skin Jake_0's skin Notch's skin sk89q's skin

Usage / Documentation

Please visit the website for details.

Contact

  • You can follow us on twitter
  • Open an issue on GitHub
  • You can join IRC in #crafatar on irc.esper.net.

Installation

Have a look at crafatar/setup to see how we set things up at Crafatar.

Installation on Heroku

Deploy

Installation on Dokku

[dokku server]

Install the dokku-redis plugin.

dokku redis:start
dokku apps:create crafatar
dokku config:set crafatar BIND=0.0.0.0 PORT=5000

For persistent images and logs:

dokku docker-options:add crafatar deploy "-v /var/lib/crafatar/images:/app/images"
dokku docker-options:add crafatar deploy "-v /var/log/crafatar:/app/logs"

If you want to listen on extra domains:

dokku domains crafatar:add example.com
[your machine]

Add dokku remote and deploy!

git remote add dokku dokku@example.com:crafatar
git push dokku master

Installation on your machine

Tests

npm test

If you want to debug failing tests:

# show logs during tests
env VERBOSE_TEST=true npm test

It can be helpful to monitor redis commands to debug caching errors:

redis-cli monitor