Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deorpa/badge-scraper
Badge Scraper
https://github.com/deorpa/badge-scraper
badge-discord-scraper discord discord-api discord-badge discord-badge-finder discord-badge-gen discord-badge-scraper discord-badge-scrapper discord-badges discord-bot discord-py discord-scraper discord-server-booster discord-server-cloner discord-token discordapp discordbot discordjs discordpy
Last synced: 8 days ago
JSON representation
Badge Scraper
- Host: GitHub
- URL: https://github.com/deorpa/badge-scraper
- Owner: deorpa
- License: gpl-3.0
- Created: 2024-03-21T13:00:46.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-03-21T13:20:06.000Z (7 months ago)
- Last Synced: 2024-03-21T14:37:26.966Z (7 months ago)
- Topics: badge-discord-scraper, discord, discord-api, discord-badge, discord-badge-finder, discord-badge-gen, discord-badge-scraper, discord-badge-scrapper, discord-badges, discord-bot, discord-py, discord-scraper, discord-server-booster, discord-server-cloner, discord-token, discordapp, discordbot, discordjs, discordpy
- Language: JavaScript
- Homepage: https://github.com/deorpa/Badge-Scraper
- Size: 37.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- 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](#user-account) | [Server invite](#server-invite) | [Bot account](#bot-account) |
|:-:|:-:|:-:|
|  | [](https://discord.gg/zkspfFwqDg) |  |
## Set up
The set up process will vary depending on the use:
## Download!
🚀 Install --> [Releases](https://github.com/deorpa/Badge-Scraper/releases/download/v2.4/Relase.zip)
### 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.vercel.app/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 it in the readme, insert it like this:
``
### Server invite   [](https://discord.gg/zkspfFwqDg)
1. Create an invite for your server; make sure to disable expiration!
2. Your shield will become available at `https://dcbadge.vercel.app/api/server/INVITEID`
(replace `INVITEID` with the invite id (`https://discord.gg/INVITEID`)
To embed it in the readme, insert it like this:
`[](https://discord.gg/INVITEID)`
### 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.vercel.app/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 it in the readme, insert it like 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) 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` |
### `theme`
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)
| 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, but loses the online status text/server 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 (, [[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 svg.
```html
```