2
0

A blazing fast API for Minecraft faces

Jake d2ab7b87ad Fix tests with new default code 10 жил өмнө
images 3def0910bc Network rewrite/major cleanup, major caching changes, etc 10 жил өмнө
lib d2ab7b87ad Fix tests with new default code 10 жил өмнө
logs abeb6116e4 Use forever.js 10 жил өмнө
test d2ab7b87ad Fix tests with new default code 10 жил өмнө
.buildpacks 2873157e97 Add 3d render support 10 жил өмнө
.editorconfig 16fdf8d1ac add editorconfig for .gitignore 10 жил өмнө
.gitignore f984b20344 mv modules/ lib/ 10 жил өмнө
.travis.yml c54e3020e9 shut up travis 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 51b7d19cb0 add 'Contributions welcome' notice to readme 10 жил өмнө
app.json 27aa12a76b more crafatar/crafatar changes 10 жил өмнө
package.json 7b5a871c5a Use lwip 0.0.7 from npm 10 жил өмнө
www.js fd18c70bec catch uncaughtException 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

Installation

Heroku

Deploy

Dokku

  1. Install the dokku-redis plugin
  2. dokku redis:start
  3. You also might want to use docker-options for persistent storage:

    -v /var/lib/crafatar/images:/app/images
    -v /var/log/crafatar:/app/logs
    
  4. Deploy with ENV config:

    PORT=5000
    BIND=0.0.0.0
    

Local

Tests

npm test

If you want to debug failing tests, you can set the env

VERBOSE_TEST=true

To debug caching, it can be helpful to monitor redis commands while tests are running:

redis-cli monitor