๐ท๏ธ Utilize Lanyard to display your Discord Presence in your GitHub Profile
Special thanks to @Phineas for creating Lanyard, and making this project possible
First, join the Lanyard Discord (if you haven't already) for this to work.
In a README.md
file, include the following, replacing :id
with your Discord user ID:
[![Discord Presence](https://lanyard-profile-readme.vercel.app/api/:id)](https://discord.com/users/:id)
It should display something similar to the following (I am using my Discord user ID as an example):
When others click it, they will be directed to your actual Discord profile. Neat!
There are a few options to customize this display using query parameters:
Append the query param theme=:theme
to the end of the URL, replacing :theme
with either light
or dark
. This will change the background and the font colors, but the background can be overridden with the Background Color parameter.
Append the query param bg=:color
to the end of the URL, replacing :color
with a hex color of your choice (omit the #)
Append the query param borderRadius=:radius
to the end of the URL, replacing :radius
with a radius of your choice. (default 10px
)
If you have an animated avatar, append the query param animated=:bool
to the end of the URL, replacing :bool
with true
or false
. This is set to true
by default.
If you don't want people seeing your discriminator (most likely for privacy reasons), append the query param hideDiscrim=true
to the end of the URL. Your discriminator is shown by default.
If you don't want people seeing your status, append the query param hideStatus=true
to the end of the URL. Your status is shown by default if you have one.
[![Discord Presence](https://lanyard-profile-readme.vercel.app/api/94490510688792576?theme=light&bg=809ecf&animated=false&hideDiscrim=true&borderRadius=30px)](https://discord.com/users/94490510688792576)
Note: Current Nitro & Boosting badges do not work due to Discord API limitations.
If you're using this in your profile, feel free to show support and give this repo a โญ star! It means a lot, thank you :)