Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gitlimes/discord-md-badge
A customizable badge displaying your Discord account, a server invite, or a bot account.
https://github.com/gitlimes/discord-md-badge
badge-generator discord markdown profile-readme
Last synced: about 2 months ago
JSON representation
A customizable badge displaying your Discord account, a server invite, or a bot account.
- Host: GitHub
- URL: https://github.com/gitlimes/discord-md-badge
- Owner: gitlimes
- License: gpl-3.0
- Created: 2021-06-13T18:25:52.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-15T20:26:23.000Z (4 months ago)
- Last Synced: 2024-06-09T19:13:30.817Z (3 months ago)
- Topics: badge-generator, discord, markdown, profile-readme
- Language: JavaScript
- Homepage: https://dcbadge.limes.pink/api/shield/USERID
- Size: 278 KB
- Stars: 180
- Watchers: 2
- Forks: 53
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Discord Markdown Badge
A customizable badge that shows your Discord account, a server invite, or a bot account.
User Account
Server Invite
Bot Account
## Set up
### User Account 
1. Join the [Discord server](https://discord.gg/zkspfFwqDg) (required, as that's where the bot gets your presence information from)
2. Your shield will become available at `https://dcbadge.limes.pink/api/shield/USERID`
(replace `USERID` with [your Discord user ID](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-))
To embed the shield in a Markdown file, do this:
``
### Server Invite [](https://discord.gg/zkspfFwqDg)
1. Create an invite for your server; make sure to set it to never expire!
2. Your shield will become available at `https://dcbadge.limes.pink/api/server/INVITE`
(e.g. `https://dcbadge.limes.pink/api/server/https://discord.gg/zkspfFwqDg`)
To embed the shield in a Markdown file, do this:
`[](https://discord.gg/INVITE)`
### Bot Account 
1. DM me () your bot's invite link
2. Wait for me to read the DM (it might take some time as it's a manual process)
3. Your shield will become available at `https://dcbadge.limes.pink/api/shield/BOTID?bot=true`
(replace `BOTID` with [your Discord bot's user ID](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-))
To embed the shield in a Markdown file, do this:
``
## Styling
You can chain parameters by connecting them with `&` (e.g. `?style=flat&theme=clean&compact=true`).
### `style`
This uses [shields.io](https://shields.io) under the hood, so you can just use one of the styles from there via the `?style=` param.
| Badge | Style | Query |
| :-------------------------------------------------------------------------------------------------- | :------------ | :------------------- |
|  | flat | `?style=flat` |
|  | flat-square | `?style=flat-square` |
|  | for-the-badge | None (default) |
|  | plastic | `?style=plastic` |
|  | social | `?style=social` |
### `theme`
You can also use the `theme` query option to change the colors of the shield (the green in the following badges corresponds to the online/idle/dnd/offline status)
| Badge | Theme | Query |
| :------------------------------------------------------------------------------------------------------------ | :--------------- | :------------------------ |
|  | Default | None (default) |
|  | Default inverted | `?theme=default-inverted` |
|  | Clean | `?theme=clean` |
|  | Clean inverted | `?theme=clean-inverted` |
|  | Discord | `?theme=discord` |
|  | Discord inverted | `?theme=discord-inverted` |
|  | Full presence | `?theme=full-presence` |
|  | Gray | `?theme=gray` |
|  | Blurple | `?theme=blurple` |
Note: the `theme` option will not work with the social `style`.
### `compact`
Makes the badge more compact, at the expense of the status text/member count.
| Badge | Query |
| :----------------------------------------------------------------------------------------- | :-------------- |
|  | `?compact=true` |
### `logoColor`
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](https://shields.io/#colors) |
|  | `?logoColor=ff6b6b` | Any hex code, without the `#` |
## I've added this to my GitHub bio and it doesn't work!
This **won't** work in bios, only in profile readmes (and any other part of GitHub that supports markdown).
[Here](https://mansik16.medium.com/adding-a-readme-to-your-github-profile-2ec88bfedeb)'s some info on what a profile readme is and how to set it up.
For any questions feel free to contact me on Discord () or via email ([[email protected]](mailto:[email protected]))
## HTML
The API returns an SVG image, so you can embed it in your html just like you would with any other image:
```html
```