A blazing fast API for Minecraft faces

jomo 5a18fa155e Merge branch 'master' of github.com:crafatar/crafatar 9 years ago
images 47a978df6c add image dir to git 9 years ago
lib 96b277b806 add missing documentation 9 years ago
test 6594200500 Mojang updated all capes, fix tests 9 years ago
.buildpacks 2873157e97 Add 3d render support 10 years ago
.editorconfig 16fdf8d1ac add editorconfig for .gitignore 10 years ago
.gitignore 47a978df6c add image dir to git 9 years ago
.travis.yml fe16821cb7 update nodejs to 4.3.0 LTS 9 years ago
CONTRIBUTING.md 8750b863a8 contributing: add tests for fixed issues 10 years ago
LICENSE 2934b22da2 Crafatar Team 9 years ago
Procfile 5f0a3dcb63 use postinstall script instead of Procfile 10 years ago
README.md 0fb17e5e5e update README about renders 9 years ago
app.json fe12901f41 update app.json 9 years ago
config.example.js f0df78e6a9 allow editing index html when debug_enabled = true 9 years ago
package.json 21fbf3f8d7 chore(package): update mocha-lcov-reporter to version 1.1.0 9 years ago
www.js 85e7b4b571 remove clusters 10 years ago

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 / cairo.

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

  • You can follow us on twitter
  • Open an issue on GitHub
  • You can join IRC in #crafatar on irc.esper.net.

Installation

Have a look at crafatar/setup to see how we set things up at Crafatar.

For more info about local setup, Heroku, or Dokku please see Installation on the wiki.

Tests

npm test

If you want to debug failing tests:

# show logs during tests
env VERBOSE_TEST=true npm test

It can be helpful to monitor redis commands to debug caching errors:

redis-cli monitor