-
-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: rewrite! 1 app now that i have an actual server
- Loading branch information
Showing
22 changed files
with
2,382 additions
and
1,455 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| PORT=9398 | ||
| DC_TOKEN="dfgdgdfgfd" | ||
| SHIELDS_IO_INSTANCE="https://shields.io" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,39 +4,39 @@ A customizable badge that shows your Discord account, a server invite, or a bot | |
|
|
||
| | [User account](#user-account) | [Server invite](#server-invite) | [Bot account](#bot-account) | | ||
| |:-:|:-:|:-:| | ||
| |  | [](https://discord.gg/zkspfFwqDg) |  | | ||
| |  | [](https://discord.gg/zkspfFwqDg) |  | | ||
|
|
||
| ## Set up | ||
|
|
||
| The set up process will vary depending on the use: | ||
|
|
||
| ### User account  | ||
| ### 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` | ||
| 2. Your shield will become available at `https://dcbadge.limes.pink/api/shield/USERID` | ||
| <br>(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: | ||
| <br>`` | ||
| <br>`` | ||
|
|
||
| ### Server invite [](https://discord.gg/zkspfFwqDg) | ||
| ### 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` | ||
| 2. Your shield will become available at `https://dcbadge.limes.pink/api/server/INVITEID` | ||
| <br>(replace `INVITEID` with the invite id (`https://discord.gg/INVITEID`) | ||
|
|
||
| To embed it in the readme, insert it like this: | ||
| <br>`[](https://discord.gg/INVITEID)` | ||
| <br>`[](https://discord.gg/INVITEID)` | ||
|
|
||
| ### Bot account  | ||
| ### Bot account  | ||
|
|
||
| 1. DM me () your bot's invite link | ||
| 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` | ||
| 3. Your shield will become available at `https://dcbadge.limes.pink/api/shield/BOTID?bot=true` | ||
| <br>(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: | ||
| <br>`` | ||
| <br>`` | ||
|
|
||
| ## Styling | ||
|
|
||
|
|
@@ -48,11 +48,11 @@ This uses [shields.io](https://shields.io) to generate the badge, so you can cho | |
|
|
||
| | Badge | Style | Query | | ||
| | :----------------------------------------------------------------------------------------------------------- | :------------ | :------------------- | | ||
| |  | flat | `?style=flat` | | ||
| |  | flat-square | `?style=flat-square` | | ||
| |  | for-the-badge | None (default) | | ||
| |  | plastic | `?style=plastic` | | ||
| |  | social | `?style=social` | | ||
| |  | flat | `?style=flat` | | ||
| |  | flat-square | `?style=flat-square` | | ||
| |  | for-the-badge | None (default) | | ||
| |  | plastic | `?style=plastic` | | ||
| |  | social | `?style=social` | | ||
|
|
||
| ### `theme` | ||
|
|
||
|
|
@@ -61,15 +61,15 @@ 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` | | ||
| |  | 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`. | ||
|
|
||
|
|
@@ -79,29 +79,29 @@ Makes the badge more compact, but loses the online status text/server member cou | |
|
|
||
| | Badge | Query | | ||
| | :-------------------------------------------------------------------------------------------------- | :-------------- | | ||
| |  | `?compact=true` | | ||
| |  | `?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 `#` | | ||
| |  | `?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])) | ||
| 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 | ||
| <img src="https://dcbadge.vercel.app/api/shield/USERID" /> | ||
| <img src="https://dcbadge.limes.pink/api/shield/USERID" /> | ||
| ``` | ||
File renamed without changes.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.