Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crafatar/crafatar
A blazing fast API for Minecraft faces
https://github.com/crafatar/crafatar
api avatar avatars caching crafatar minecraft minecraft-avatar
Last synced: 9 days ago
JSON representation
A blazing fast API for Minecraft faces
- Host: GitHub
- URL: https://github.com/crafatar/crafatar
- Owner: crafatar
- License: mit
- Created: 2014-10-18T18:56:55.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-02-01T21:56:35.000Z (9 months ago)
- Last Synced: 2024-04-14T07:07:46.423Z (7 months ago)
- Topics: api, avatar, avatars, caching, crafatar, minecraft, minecraft-avatar
- Language: JavaScript
- Homepage: https://crafatar.com
- Size: 1.12 MB
- Stars: 330
- Watchers: 12
- Forks: 69
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-blazingly-fast - crafatar - A blazing fast API for Minecraft faces (JavaScript)
README
# Crafatar
[](https://travis-ci.org/crafatar/crafatar/) [](https://coveralls.io/r/crafatar/crafatar) [](https://codeclimate.com/github/crafatar/crafatar) [](https://david-dm.org/crafatar/crafatar) [](https://david-dm.org/crafatar/crafatar#info=devDependencies) [](https://inch-ci.org/github/crafatar/crafatar)
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](https://github.com/EyalAr/lwip). 3D renders are created with [node-canvas](https://github.com/Automattic/node-canvas) / [cairo](http://cairographics.org/).
# Contributions welcome!
There are usually a few [open issues](https://github.com/crafatar/crafatar/issues).
We welcome any opinions or advice in discussions as well as pull requests.
Issues tagged with [](https://github.com/crafatar/crafatar/labels/help%20wanted) show where we could especially need your help!
# Examples
| | | | |
| :---: | :---: | :---: | :---: |
|  |  |  |  |  |
|  |  |  |  |  |
|  |  |  |  |  |
|  |  |  |  |  |
## Usage / Documentation
Please [visit the website](https://crafatar.com) for details.
## Contact
* You can [follow](https://twitter.com/crafatar) us on twitter
* Open an [issue](https://github.com/crafatar/crafatar/issues/) on GitHub
# Installation
## Docker
```sh
docker network create crafatar
docker run --net crafatar -d --name redis redis
docker run --net crafatar -v crafatar-images:/home/app/crafatar/images -e REDIS_URL=redis://redis -p 3000:3000 crafatar/crafatar
```
## Manual
- Install [nodejs](https://nodejs.org/) 12 (LTS)
- Install `redis-server`
- Run `npm install`
If that fails, it's likely because because of `node-canvas` dependencies. Follow [this guide](https://github.com/Automattic/node-canvas/wiki#installation-guides) to install them.
- Run `npm start`
Crafatar is now available at http://0.0.0.0:3000.
## Configration / Environment variables
See the `config.js` file.
# Operational notes
## inodes
Crafatar stores a lot of images on disk. For avatars, these are 8×8 px PNG images with an average file size of \~90 bytes. This can lead to issues on file systems such as ext4, which (by default) has a bytes-per-inode ratio of 16Kb. With thousands of files with an average file size below this ratio, you will run out of available inodes before running out of disk space. (Note that this will still be reported as `ENOSPC: no space left on device`).
Consider using a different file system, changing the inode ratio, or deleting files before the inode limit is reached.
## disk space and memory usage
Eventually you will run out of disk space and/or redis will be out of memory. Make sure to delete image files and/or flush redis before this happens.
# Tests
```sh
npm test
```
If you want to debug failing tests:
```sh
# show logs during tests
env VERBOSE_TEST=true npm test
```
It can be helpful to monitor redis commands to debug caching errors:
```sh
redis-cli monitor
```