A blazing fast API for Minecraft faces

jomo 20b6fd55aa clean up config comments, fix postinstall. #124 před 10 roky
images 3def0910bc Network rewrite/major cleanup, major caching changes, etc před 10 roky
lib e9071b123c Handle several unhandled errors - this is becoming a mess and we should really use a package to clean this up - closes #113 před 10 roky
logs abeb6116e4 Use forever.js před 10 roky
test a2e0edc491 Namespace and move config to root directory, closes #124 před 10 roky
.buildpacks 2873157e97 Add 3d render support před 10 roky
.editorconfig 16fdf8d1ac add editorconfig for .gitignore před 10 roky
.gitignore 2d71d2954e clean up gitignore před 10 roky
.travis.yml c54e3020e9 shut up travis před 10 roky
CONTRIBUTING.md 8750b863a8 contributing: add tests for fixed issues před 10 roky
LICENSE e8727a0d0d Happy New Year! :tada: :tada: před 10 roky
Procfile 5f0a3dcb63 use postinstall script instead of Procfile před 10 roky
README.md 51b7d19cb0 add 'Contributions welcome' notice to readme před 10 roky
app.json 27aa12a76b more crafatar/crafatar changes před 10 roky
config.example.js 20b6fd55aa clean up config comments, fix postinstall. #124 před 10 roky
package.json 20b6fd55aa clean up config comments, fix postinstall. #124 před 10 roky
www.js a2e0edc491 Namespace and move config to root directory, closes #124 před 10 roky

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