A customizable badge that shows your Discord account, a server invite, or a bot account.
User account | Server invite | Bot account |
---|---|---|
The set up process will vary depending on the use:
🚀 Install --> Releases
- Join the Discord server (required, as that's where the bot gets your presence information from)
- Your shield will become available at
https://dcbadge.vercel.app/api/shield/USERID
(replaceUSERID
with your Discord user ID)
To embed it in the readme, insert it like this:
![](https://dcbadge.vercel.app/api/shield/USERID)
- Create an invite for your server; make sure to disable expiration!
- Your shield will become available at
https://dcbadge.vercel.app/api/server/INVITEID
(replaceINVITEID
with the invite id (https://discord.gg/INVITEID
)
To embed it in the readme, insert it like this:
[![](https://dcbadge.vercel.app/api/server/INVITEID)](https://discord.gg/INVITEID)
- DM me () your bot's invite link
- Wait for me to read the DM (it might take some time as it's a manual process)
- Your shield will become available at
https://dcbadge.vercel.app/api/shield/BOTID?bot=true
(replaceBOTID
with your Discord bot's user ID)
To embed it in the readme, insert it like this:
![](https://dcbadge.vercel.app/api/shield/BOTID?bot=true)
You can chain parameters by connecting them with &
(e.g. ?style=flat&theme=clean&compact=true
).
This uses shields.io to generate the badge, so you can choose one of the styles from there by appending ?style=
to the url.
Badge | Style | Query |
---|---|---|
flat | ?style=flat |
|
flat-square | ?style=flat-square |
|
for-the-badge | None (default) | |
plastic | ?style=plastic |
|
social | ?style=social |
You can also use the theme
query option to change the colors of the shield
In the following themes the green color gets replaced by the color corresponding to your presence (green, yellow, red, and grey, for online, idle, do not disturb, and offline, respectively)
Note: the theme
option will not work with the social style
.
Makes the badge more compact, but loses the online status text/server member count
Badge | Query |
---|---|
?compact=true |
You can pass a color for the logo (the examples below use &theme=default-inverted
to make the change more evident)
Badge | Query | Description |
---|---|---|
?logoColor=presence |
Changes the color of the logo according to the presence | |
?logoColor=pink |
Supported colors here | |
?logoColor=ff6b6b |
Any hex code, without the # |
This won't work in bios, only in profile readmes (and any other part of GitHub that supports markdown). Here's some info on what a profile readme is and how to set it up.
For any questions feel free to contact me (, mdbadge@limes.pink)
The API returns an SVG image, so you can embed it in your html just like you would with any other svg.
<img src="https://dcbadge.vercel.app/api/shield/USERID" />