CurseForge Badges - The ugly API documentation page

Usage

The base url is https://cf.way2muchnoise.eu. This url can be appended by following patterns. Use of https is available, but GitHub doesn't seem to like that. The examples below are but a subset of all possibilities go check out the code on Github for all possible options

/<project>.svg

project being either the id or name(link in the url).

  • -> https://cf.way2muchnoise.eu/240630.svg
  • -> https://cf.way2muchnoise.eu/jei.svg

/<style>_<project>_<extra>.svg

style can either 'short' or 'full', extra is optional text to be appended.

  • -> https://cf.way2muchnoise.eu/short_jei.svg
  • -> https://cf.way2muchnoise.eu/full_240630_downloads.svg

/versions/<project>.svg

project being either the id or name(link in the url)

  • -> https://cf.way2muchnoise.eu/versions/jei.svg
  • -> https://cf.way2muchnoise.eu/versions/240630.svg

/versions/<text>_<project>_<style>.svg

text is optional and replaces the default 'Available for' text. The style can be either 'all' or 'latest'

  • -> https://cf.way2muchnoise.eu/versions/jei_latest.svg
  • -> https://cf.way2muchnoise.eu/versions/For%20MC_240630_all.svg

/packs/<project>.svg

project being either the id or name(link in the url).

  • -> https://cf.way2muchnoise.eu/packs/240630.svg
  • -> https://cf.way2muchnoise.eu/packs/jei.svg

/packs/<style>_<project>_<before>_<after>.svg

style can either 'short' or 'full', before and after are the added text.

  • -> https://cf.way2muchnoise.eu/packs/short_jei.svg
  • -> https://cf.way2muchnoise.eu/packs/full_240630_in_packs.svg

/mods/<project>.svg

project being either the id or name(link in the url).

  • -> https://cf.way2muchnoise.eu/mods/240630.svg
  • -> https://cf.way2muchnoise.eu/mods/jei.svg

/mods/<style>_<project>_<before>_<after>.svg

style can either 'short'(dunno, if any mod is required by that many other you would need short style) or 'full', before and after are the added text.

  • -> https://cf.way2muchnoise.eu/mods/short_jei.svg
  • -> https://cf.way2muchnoise.eu/mods/full_240630_used%20by_mods.svg

/supported/<project>.svg

project being either the id or name(link in the url).

  • -> https://cf.way2muchnoise.eu/supported/240630.svg
  • -> https://cf.way2muchnoise.eu/supported/jei.svg

/supported/<style>_<project>_<before>_<after>.svg

style can either 'short'(dunno, if any mod is required by that many other you would need short style) or 'full', before and after are the added text.

  • -> https://cf.way2muchnoise.eu/supported/short_jei.svg
  • -> https://cf.way2muchnoise.eu/supported/full_240630_used%20in_other%20mods.svg

/title/<project>.svg

project being either the id or name(link in the url).

  • -> https://cf.way2muchnoise.eu/title/jei.svg
  • -> https://cf.way2muchnoise.eu/title/240630.svg

/title/<project>_<prefix>_<suffix>.svg

project being either the id or name(link in the url), prefix and suffix are added are the added text.

  • -> https://cf.way2muchnoise.eu/title/jei_Get_Today!.svg
  • -> https://cf.way2muchnoise.eu/title/240630_%20_Is%20Awesome!.svg

Different badge styles

Using the get param badge_style allows for changing the badge style. Currently the only alternative option is for_the_badge

  • -> https://cf.way2muchnoise.eu/240630.svg?badge_style=for_the_badge
  • -> https://cf.way2muchnoise.eu/jei.svg?badge_style=for_the_badge