https://github.com/creeperkatze/modfolio
Flex your modrinth stats anywhere
https://github.com/creeperkatze/modfolio
modrinth modrinth-api readme readme-badges readme-card
Last synced: 4 months ago
JSON representation
Flex your modrinth stats anywhere
- Host: GitHub
- URL: https://github.com/creeperkatze/modfolio
- Owner: creeperkatze
- License: agpl-3.0
- Created: 2026-01-17T15:52:17.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2026-01-26T21:12:12.000Z (4 months ago)
- Last Synced: 2026-01-27T08:30:49.854Z (4 months ago)
- Topics: modrinth, modrinth-api, readme, readme-badges, readme-card
- Language: JavaScript
- Homepage: https://modfolio.creeperkatze.de
- Size: 3.08 MB
- Stars: 6
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - creeperkatze/modrinth-embeds - embeds.creeperkatze.de](https://modrinth-embeds.creeperkatze.de)) - A flexible, reusable and fast embed generator for all things Modrinth. Get styled details about a user, project, organization or collection. (Miscellaneous / In-game)
README
# 
Generate fast, beautiful and consistent embeddable cards and badges for Modrinth, CurseForge, Hangar and Spigot content.
[](https://status.creeperkatze.de)
## Quick Start
Use the **[Website](https://modfolio.creeperkatze.de)** to visually configure and preview your embeds.
Examples:
[](https://modrinth.com/project/modmenu)
[](https://www.curseforge.com/minecraft/mc-mods/geckolib)
[](https://hangar.papermc.io/henkelmax/SimpleVoiceChat)
[](https://spigotmc.org/resources/28140/)
## Endpoints
Base URL: `https://modfolio.creeperkatze.de`
Pattern: `///?=`
### Cards
Rich cards showing stats, versions, projects, and activity sparklines.
#### Modrinth
| Card Type | Path | Example |
|-----------|------|---------|
| Project | `/modrinth/project/` | [](https://modrinth.com/project/modmenu) |
| User | `/modrinth/user/` | [](https://modrinth.com/user/prospector) |
| Organization | `/modrinth/organization/` | [](https://modrinth.com/organization/caffeinemc) |
| Collection | `/modrinth/collection/` | [](https://modrinth.com/collection/VEgGDFFE) |
#### CurseForge
| Card Type | Path | Example |
|-----------|------|---------|
| Project | `/curseforge/project/` | [](https://www.curseforge.com/minecraft/mc-mods/geckolib) |
#### Hangar
| Card Type | Path | Example |
|-----------|------|---------|
| Project | `/hangar/project/` | [](https://hangar.papermc.io/plugins/SimpleVoiceChat) |
| User | `/hangar/user/` | [](https://hangar.papermc.io/u/henkelmax) |
#### Spigot
| Card Type | Path | Example |
|-----------|------|---------|
| Resource | `/spigot/resource/` | [](https://spigotmc.org/resources/28140/) |
| Author | `/spigot/author/` | [](https://spigotmc.org/authors/100356) |
#### 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: `////?=`
Compact badges showing a single metric.
#### Modrinth
| Badge | Path | Example |
|-------|------|---------|
| Downloads | `/modrinth///downloads` | [](https://modrinth.com/project/modmenu) |
| Followers | `/modrinth///followers` | [](https://modrinth.com/project/modmenu) |
| Versions | `/modrinth///versions` | [](https://modrinth.com/project/modmenu) |
| Projects | `/modrinth///projects` | [](https://modrinth.com/user/prospector) |
#### CurseForge
| Badge | Path | Example |
|-------|------|---------|
| Downloads | `/curseforge/project//downloads` | [](https://www.curseforge.com/minecraft/mc-mods/geckolib) |
| Rank | `/curseforge/project//rank` | [](https://www.curseforge.com/minecraft/mc-mods/geckolib) |
| Files | `/curseforge/project//versions` | [](https://www.curseforge.com/minecraft/mc-mods/geckolib) |
#### Hangar
| Badge | Path | Example |
|-------|------|---------|
| Downloads | `/hangar///downloads` | [](https://hangar.papermc.io/plugins/SimpleVoiceChat) |
| Stars | `/hangar///stars` | [](https://hangar.papermc.io/u//enkelmax) |
| Versions | `/hangar///versions` | [](https://hangar.papermc.io/plugins/SimpleVoiceChat) |
| Views | `/hangar/project//views` | [](https://hangar.papermc.io/plugins/SimpleVoiceChat) |
| Projects | `/hangar/user//projects` | [](https://hangar.papermc.io/u/henkelmax) |
#### Spigot
| Badge | Path | Example |
|-------|------|---------|
| Downloads | `/spigot///downloads` | [](https://spigotmc.org/resources/28140/) |
| Likes | `/spigot///likes` | [](https://spigotmc.org/resources/28140/) |
| Rating | `/spigot///rating` | [](https://spigotmc.org/resources/28140/) |
| Versions | `/spigot///versions` | [](https://spigotmc.org/resources/28140/) |
| Resources | `/spigot/author//resources` | [](https://spigotmc.org/authors/100356) |
#### Badge Options
| Parameter | Description | Default |
|-----------|-------------|---------|
| `color` | Accent color (hex) | Platform default |
| `backgroundColor` | Background color (hex) | `transparent` |
| `format` | Output format (`svg` / `png`) | `svg` |
**Platform defaults:** Modrinth `#1bd96a` | CurseForge `#F16436` | Hangar `#3371ED` | Spigot `#E8A838`
## Development
### Prequisites
- Node.js
- pnpm
### Installation
```bash
# 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