mcpfp-api

This project is an API server designed to generate cute profile pictures from Minecraft skins. It's based on mcpfp by MauritsWilke, with additional features like overlays and cosmetics.

Also this project utilizes 🔥 Hono and 🫓 Bun along with @napi-rs/canvas (instead of skia-canvas) resulting in faster performance.

You can try a public instance of this here: https://pfp.arcticbd.net

Installation

Make sure you have Bun installed. Install from: https://bun.sh/

Clone the repository from the command line:

git clone https://github.com/towsifkafi/mcpfp.git
cd mcpfp

Then install the required the dependencies:

bun install --cwd ./api
bun install --cwd ./web

Also, you need to build the static webpages before running the dev server:

bun run --cwd ./web build

Now you can start the dev server:

bun run --cwd ./api dev

But if you want to run this API server in production, you have to build the server & you can use the pm2.config.js using pm2.

pm2 start pm2.config.js

Or if you would like to use Docker:

docker-compose build
docker-compose up

Contributing

Contributions are welcome! Please feel free to submit pull requests or issues.