A blazing fast API for Minecraft faces

jomo ed25d30ff0 remove unnecessary log 10 년 전
images 3def0910bc Network rewrite/major cleanup, major caching changes, etc 10 년 전
lib ed25d30ff0 remove unnecessary log 10 년 전
logs abeb6116e4 Use forever.js 10 년 전
test 9f04fbc136 allow multiple checksums for tests, fixes #119 10 년 전
.buildpacks 2873157e97 Add 3d render support 10 년 전
.editorconfig 16fdf8d1ac add editorconfig for .gitignore 10 년 전
.gitignore f984b20344 mv modules/ lib/ 10 년 전
.travis.yml 67e635dbbb remove unnecessary quotes in .travis.yml 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 67fd75b91e fix logo in readme 10 년 전
app.json 27aa12a76b more crafatar/crafatar changes 10 년 전
package.json 22ea5a7e27 use iojs 1.8.x 10 년 전
www.js b84a65fd8e restructure directories 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.

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