hotsno / status-svg

Display your status on GitHub and other profiles

Home Page:https://status-svg.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

status-svg

🏷️ Utilize Lanyard to display your Discord Presence information on your GitHub/AniList/other profiles

Usage

First, join the Lanyard Discord (if you haven't already) for this to work.

For GitHub, in a .md file, include the following, replacing :id with your Discord user ID:

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://status-svg.vercel.app/api/:id">
  <img src="https://status-svg.vercel.app/api/:id?lightMode=true">
</picture>

For other services, figure out how to display an image and use the same URL.

It should display something similar to the following (I am using my Discord user ID as an example):

Note

Contains a custom configuration for the "Plex" status (will change the verb to "Watching", etc). It assumes you're using this for the Plex rich presence.

Options

There are a few options to customize this display using query parameters:

Left align

Append the query param leftAlign=:bool to the end of the URL, replacing :bool with either true or false. Default is false.

Light mode

Append the query param lightMode=:bool to the end of the URL, replacing :bool with either true or false. Default is false. Light mode will make the text dark to be readable in light mode, and vice-versa.

Color

Append the query param color=:hexCode to the end of the URL, replacing :hexCode with a color hex code (don't include the #). This will override the light mode option.

Credits

About

Display your status on GitHub and other profiles

https://status-svg.vercel.app


Languages

Language:TypeScript 99.6%Language:JavaScript 0.4%