A blazing fast API for Minecraft faces

Jake 4ed0b75c9d More meta tags před 10 roky
images 3def0910bc Network rewrite/major cleanup, major caching changes, etc před 10 roky
lib 4ed0b75c9d More meta tags před 10 roky
logs abeb6116e4 Use forever.js před 10 roky
test 72840433cb use proper URL encoding in tests 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 5de8c77ffb fix docker-options před 10 roky
app.json 27aa12a76b more crafatar/crafatar changes před 10 roky
config.example.js 34f94bf9b5 get rid of redundant config names #124 před 10 roky
package.json 44cff242d7 update dependencies 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

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

Installation on Heroku

Deploy

Installation on Dokku

[dokku server]

Install the dokku-redis plugin.

dokku redis:start
dokku apps:create crafatar
dokku config:set crafatar BIND=0.0.0.0 PORT=5000

For persistent images and logs:

dokku docker-options:add crafatar deploy "-v /var/lib/crafatar/images:/app/images"
dokku docker-options:add crafatar deploy "-v /var/log/crafatar:/app/logs"

If you want to listen on extra domains:

dokku domains crafatar:add example.com
[your machine]

Add dokku remote and deploy!

git remote add dokku dokku@example.com:crafatar
git push dokku master

Installation on your machine

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