A blazing fast API for Minecraft faces

jomo a294a7c57f add 128px logo, polish README 10 éve
bin f984b20344 mv modules/ lib/ 10 éve
images 3def0910bc Network rewrite/major cleanup, major caching changes, etc 10 éve
lib abaf3f77aa add & clean up documentation 10 éve
logs abeb6116e4 Use forever.js 10 éve
public a294a7c57f add 128px logo, polish README 10 éve
routes f984b20344 mv modules/ lib/ 10 éve
test 4c7da4940e remove benchmark.sh, improve bulk.sh 10 éve
views 94fe61e076 add CORS info to website, fixes #110 10 éve
.buildpacks 2873157e97 Add 3d render support 10 éve
.editorconfig 16fdf8d1ac add editorconfig for .gitignore 10 éve
.gitignore f984b20344 mv modules/ lib/ 10 éve
.travis.yml dfaa79b9c7 use iojs 1.5.x, see iojs/io.js#1103 + iojs/io.js#1075 10 éve
CONTRIBUTING.md 8750b863a8 contributing: add tests for fixed issues 10 éve
LICENSE e8727a0d0d Happy New Year! :tada: :tada: 10 éve
Procfile 5f0a3dcb63 use postinstall script instead of Procfile 10 éve
README.md a294a7c57f add 128px logo, polish README 10 éve
app.json 27aa12a76b more crafatar/crafatar changes 10 éve
package.json dfaa79b9c7 use iojs 1.5.x, see iojs/io.js#1103 + iojs/io.js#1075 10 éve
server.js f984b20344 mv modules/ lib/ 10 éve

README.md

Crafatar travis Coverage Status Code Climate

dependency status devDependency status docs status

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