-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5d4c74a
commit dce1a90
Showing
1 changed file
with
43 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| # Badge Server | ||
|
|
||
| --- | ||
| This is a simple project made mostly for personal use and the main goal was for me to challenge myself and learn how to do it. | ||
| The idea (still incomplete) was for me to have stylized badges for both minecraft mod providers, Modrinth and CurseForge, while using the (almost) same url. | ||
|
|
||
| ### Usage | ||
|
|
||
| `[domain]/[provider]/[modid]/[data]` | ||
|
|
||
| Currently only Modrinth data fetching is implemented but ideally this is how you'd generate the badge for both services: | ||
|
|
||
| `` | ||
|  | ||
|
|
||
| `` | ||
|  | ||
|
|
||
| At the moment there is only one style with the provider logo on the left and text on the right, but the plan it to have more flexibility on that as well as the date displayed. | ||
| The available preset data options are: | ||
|
|
||
| `[none] or /download` - displays a shortened version of the mod's download count. | ||
| `/name` - displays the title of the project | ||
| `/versions` - displays the latest 3 minecraft versions (supported by the project) | ||
| `/loaders` - displays the supported mod loaders by the project | ||
| `/licence` - displays the name of the project's licence, if available | ||
|
|
||
| ### Disclaimer | ||
|
|
||
| This service is currently hosted, but it's not quite ready for use, anything mentioned above is prone (and mostly already planned) to change. | ||
|
|
||
| #### Examples | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
|
|
||
|
|