menzerath / mcgen

Golang JSON web API for generating custom Minecraft achievements

mcgen - Minecraft Achievement Generator

mcgen is a Golang-based JSON web API for generating custom Minecraft achievements.

Usage

A demo of the UI and API is available at https://mcgen.menzerath.eu.

UI

A simple UI is available at the base URL.
It allows you to generate achievements with a live preview using the API.

API

GET /api/v1/achievement

/api/v1/achievement?background=sword_diamond&title=Achievement%20Title&text=Achievement%20Text

POST /api/v1/achievement

{
    "background": "sword_diamond",
    "title": "Achievement Title",
    "text": "Achievement Text"
}

GET a.php

We also support the legacy api of https://github.com/menzerath/minecraft-achievement-generator.

/a.php?i=3&h=Achievement%20Title&t=Achievement%20Text

GET /a/:background/:title/:text

We also support the legacy api of https://github.com/menzerath/minecraft-achievement-generator.

/a/3/Achievement%20Title/Achievement%20Text

Icons

Available icons are listed in this directory.
Use their filename without the .png extension as the background parameter.

Download

To download an image, set the output parameter to download.
This is either in the query string or the JSON body.

Installation

Grab a current release for your platform and run the executable.
An http server will be exposed on port 8080 and serve the API.

Docker

Grab a current docker image from the GitHub Container Registry.
An http server will be exposed on port 8080 and serve the API.

Monitoring

Prometheus metrics are available at localhost:9100/metrics.

License

"Minecraft" is a trademark of Notch Development AB.

mcgen's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

dockerfile

Dockerfile

• alpine 3.20

github-actions

.github/workflows/build.yml

• actions/checkout v4.1.7
• actions/setup-go v5.0.2
• actions/upload-artifact v4.3.6
• actions/checkout v4.1.7
• actions/download-artifact v4.1.8
• docker/login-action v3.3.0
• docker/build-push-action v6.7.0
• docker/build-push-action v6.7.0
• actions/download-artifact v4.1.8
• softprops/action-gh-release v2.0.8

.github/workflows/test.yml

• actions/checkout v4.1.7
• actions/setup-go v5.0.2
• actions/checkout v4.1.7
• morphy2k/revive-action v2.5.9

gomod

go.mod

• go 1.23.0
• github.com/ansrivas/fiberprometheus/v2 v2.7.0
• github.com/fogleman/gg v1.3.0
• github.com/gofiber/fiber/v2 v2.52.5
• github.com/golang/freetype v0.0.0-20170609003504-e2365dfdc4a0@e2365dfdc4a0
• github.com/prometheus/client_golang v1.20.2
• github.com/samber/slog-fiber v1.16.2
• golang.org/x/image v0.19.0

---

• Check this box to trigger a request for Renovate to run again on this repository