Grounded in available product and source data
Nomlings Badge turns a GitHub README into a small habitat for a pixel pet that reacts to a developer's commit activity. Adding one line of markdown embeds an animated Nomling that reads the same contribution numbers shown on a GitHub profile graph, then shifts mood accordingly — celebrating on a day with 15 or more contributions, eating after any commit that day while showing the current streak, sitting idle when the week has activity but nothing yet today, falling asleep after seven days with no contributions, or staying an unhatched egg if there has been no activity in the past year.
The pet's species is derived automatically from the GitHub username the badge is added for, though a ?pet= URL parameter lets a user pick any of ten Nomling species instead. Other settings adjust the pixel scale from 2 to 8 (the default is 4), set a custom color via hex code, and toggle whether a text label appears next to the sprite.
Setup involves no signup, token, or configuration file — a single line of markdown is enough to add the badge to a README. It reads a public GitHub contribution calendar, using the same numbers that already appear on a standard GitHub profile graph. The source doesn't specify whether the badge can be embedded outside GitHub READMEs, so that's worth checking directly for other use cases.
Yes. The product's own FAQ confirms the badge is free, with no separate pricing plan mentioned.
Badge renders are cached for a few hours, so the pixel pet's mood can lag slightly behind the very latest commit activity.
Yes, but only if the connected GitHub profile is already set to display private contribution activity; otherwise the badge reflects public contributions only.
The badge service itself is closed source, though according to Nomlings the Nomling characters and pixel art are original work; the project does accept bug reports, ideas, and species requests through its repository issues.


