A blazing fast API for Minecraft faces

jomo 9c59d302c9 Merge branch 'http-response' hace 10 años
images 3def0910bc Network rewrite/major cleanup, major caching changes, etc hace 10 años
lib 6273e3bcc8 adjust 422 messages hace 10 años
logs abeb6116e4 Use forever.js hace 10 años
test 6273e3bcc8 adjust 422 messages hace 10 años
.buildpacks 2873157e97 Add 3d render support hace 10 años
.editorconfig 16fdf8d1ac add editorconfig for .gitignore hace 10 años
.gitignore f984b20344 mv modules/ lib/ hace 10 años
.travis.yml d27eb0049f update to iojs 2.0 hace 10 años
CONTRIBUTING.md 8750b863a8 contributing: add tests for fixed issues hace 10 años
LICENSE e8727a0d0d Happy New Year! :tada: :tada: hace 10 años
Procfile 5f0a3dcb63 use postinstall script instead of Procfile hace 10 años
README.md 189d1c7010 show travis status for master branch hace 10 años
app.json 27aa12a76b more crafatar/crafatar changes hace 10 años
package.json d27eb0049f update to iojs 2.0 hace 10 años
www.js b84a65fd8e restructure directories hace 10 años

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.

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