https://github.com/bram-bolt/mc-moji-api

RESTful API for mc-moji
https://github.com/bram-bolt/mc-moji-api

fastapi minecraft minecraft-avatar minecraft-skin-renderer profile-picture-generator

Last synced: 3 months ago
JSON representation

RESTful API for mc-moji

• Host: GitHub
• URL: https://github.com/bram-bolt/mc-moji-api
• Owner: Bram-Bolt
• License: mit
• Created: 2024-07-25T13:46:57.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-08-27T19:35:19.000Z (5 months ago)
• Last Synced: 2024-08-27T21:34:45.501Z (5 months ago)
• Topics: fastapi, minecraft, minecraft-avatar, minecraft-skin-renderer, profile-picture-generator
• Language: Python
• Homepage: https://api.brambolt.me/mc-moji/
• Size: 16.6 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
> **DISCLAIMER**: API is currently deployed at the free plan of render.com, therefore will take a couple seconds at first boot.

# mc-moji-API

This project is a FastAPI-based web service for generating and serving Minecraft avatar images using [mc-moji.](https://github.com/Bram-Bolt/mc-moji)

 ##  Usage

The most basic usage consists of:

```vbnet

https://api.brambolt.me/mc-moji/[your playername]

```

This returns a 330x480 avatar of a minecraft skin.

A more complex usage can be found below.

### API Endpoints

- **GET /mc-moji/{playername}**

    - **Description**: Generate and retrieve a Minecraft avatar image.

    - **Parameters**:

        - `playername` (path): The name of the player.

        - `shadows` (query, optional): Include shadows in the avatar. Default is `True`.

        - `overlay` (query, optional): Include overlay in the avatar. Default is `True`.

        - `size` (query, optional): Size of the avatar. Must be between 1 and 255. Default is `30`.

    - **Example Request**:

		 ```vbnet

		https://api.brambolt.me/mc-moji/Steve?shadows=true&overlay=true&size=30

		```

	

	 - **Example Response**:

	![example](https://i.imgur.com/YIR6egw.png)

## Self-Hosting

Please feel free to host this API yourself. However, for large scale personal use I recommend using the mc-moji package.

## Contact & Contributing

All types of contributions are encouraged and valued. From adding extra mappings to code refactors. Just open a pull request or issue and I will take a look at it.

For more complex suggestions, or questions, reach out to [[email protected]](mailto:[email protected]).

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.