Generate fast, beautiful and consistent embeddable cards and badges for Modrinth, CurseForge, Hangar and Spigot content.

Quick Start

Use the Website to visually configure and preview your embeds. The api docs can be found at here.

Examples:

Endpoints

Base URL: https://modfolio.creeperkatze.de

Pattern: /<platform>/<entity-type>/<identifier>?<option>=<value>

Cards

Rich cards showing stats, versions, projects, and activity sparklines.

Modrinth

Card Type	Path	Example
Project	/modrinth/project/<slug>
User	/modrinth/user/<username>
Organization	/modrinth/organization/<slug>
Collection	/modrinth/collection/<id>

CurseForge

Card Type	Path	Example
Project	/curseforge/project/<id>
User	/curseforge/user/<id>

Hangar

Card Type	Path	Example
Project	/hangar/project/<slug>
User	/hangar/user/<username>

Spigot

Card Type	Path	Example
Resource	/spigot/resource/<id>
Author	/spigot/author/<id>

Card Options

Parameter	Description	Default
color	Accent color (hex)	Platform default
backgroundColor	Background color (hex)	transparent
showProjects	Show top projects section	true
showVersions	Show versions section	true
maxProjects	Max projects to display (1-10)	5
maxVersions	Max versions to display (1-10)	5
relativeTime	Show relative time for dates	true
showSparklines	Display activity sparklines	true

Platform defaults: Modrinth #1bd96a | CurseForge #F16436 | Hangar #3371ED | Spigot #E8A838

Badges

Pattern: /<platform>/<entity-type>/<identifier>/<metric>?<option>=<value>

Compact badges showing a single metric.

Modrinth

Badge	Path	Example
Downloads	/modrinth/<type>/<id>/downloads
Followers	/modrinth/<type>/<id>/followers
Versions	/modrinth/<type>/<id>/versions
Projects	/modrinth/<type>/<id>/projects

CurseForge

Badge	Path	Example
Downloads	/curseforge/<type>/<id>/downloads
Rank	/curseforge/project/<id>/rank
Files	/curseforge/project/<id>/versions
Projects	/curseforge/user/<id>/projects
Followers	/curseforge/user/<id>/followers

Hangar

Badge	Path	Example
Downloads	/hangar/<type>/<id>/downloads
Stars	/hangar/project/<id>/stars
Versions	/hangar/project/<id>/versions
Views	/hangar/project/<id>/views
Projects	/hangar/user/<id>/projects

Spigot

Badge	Path	Example
Downloads	/spigot/<type>/<id>/downloads
Likes	/spigot/<type>/<id>/likes
Rating	/spigot/<type>/<id>/rating
Versions	/spigot/project/<id>/versions
Resources	/spigot/author/<id>/resources

Badge Options

Parameter	Description	Default
color	Accent color (hex)	Platform default
backgroundColor	Background color (hex)	transparent
format	Output format (svg / png)	svg

Platform Defaults

Platform	Accent color (hex)
Modrinth	#1bd96a
CurseForge	#F16436
Hangar	#3371ED
Spigot	#E8A838

Development

Prequisites

• Node.js
• pnpm

Installation

# Clone the repository
git clone https://github.com/creeperkatze/modrinth-embeds.git
cd modrinth-embeds

# Install dependencies
pnpm install

# Start development server
pnpm dev

Environment Variables

Copy the .env.example file and rename it to .env.

Contributing

Contributions are always welcome!

Please ensure you run pnpm lint before opening a pull request.

License

AGPL-3.0