mirror of
https://github.com/NohamR/lanyard-profile-readme.git
synced 2026-05-25 20:00:40 +00:00
111 lines
5.2 KiB
Markdown
111 lines
5.2 KiB
Markdown
<!-- markdownlint-disable -->
|
|
|
|
# lanyard-profile-readme
|
|
|
|
🏷️ Utilize Lanyard to display your Discord Presence in your GitHub Profile
|
|
|
|
_Special thanks to [@Phineas](https://github.com/Phineas/) for creating Lanyard, and making this project possible_
|
|
|
|
## Usage
|
|
|
|
First, join the Lanyard [Discord](https://discord.com/invite/WScAm7vNGF) (if you haven't already) for this to work.
|
|
|
|
In a `README.md` file, include the following, replacing `:id` with your Discord user ID:
|
|
|
|
```md
|
|
[](https://discord.com/users/:id)
|
|
```
|
|
|
|
It should display something similar to the following (I am using my Discord user ID as an example):
|
|
|
|
[](https://discord.com/users/705665813994012695)
|
|
|
|
When others click it, they will be directed to your actual Discord profile. Neat!
|
|
|
|
## Options
|
|
|
|
There are a few options to customize this display using query parameters:
|
|
|
|
### **_Theme_**
|
|
|
|
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.
|
|
|
|
### **_Background Color_**
|
|
|
|
Append the query param `bg=:color` to the end of the URL, replacing `:color` with a hex color of your choice (omit the #)
|
|
|
|
### **_Border Radius_**
|
|
|
|
Append the query param `borderRadius=:radius` to the end of the URL, replacing `:radius` with a radius of your choice. (default `10px`)
|
|
|
|
### **_Toggle Animated Avatar_**
|
|
|
|
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.
|
|
|
|
### **_Custom Idle Message_**
|
|
|
|
If you don't want the default "`I'm not currently doing anything!`" as your idle message, you can change it by appending `idleMessage=:yourmessage` to the end of the URL.
|
|
|
|
### **_Show Display Name_**
|
|
|
|
If you'd like to show your global display name as well as your username, append the query param `showDisplayName=true` to the end of the URL. This is set to `false` by default.
|
|
|
|
### **_Avatar Decoration_**
|
|
|
|
#### **_Hide Avatar Decoration_**
|
|
|
|
If you don't want people seeing your Avatar Decoration, append the query param `hideDecoration=true` to the end of the URL. Your Avatar Decoration is shown by default if you have one.
|
|
|
|
#### **_Toogle Animated Avatar Decoration_**
|
|
|
|
If you have an Animated Avatar Decoration, append the query param `animatedDecoration=:bool` to the end of the URL, replacing `:bool` with `true` or `false`. This is set to `true` by default.
|
|
|
|
### **_Hide Status_**
|
|
|
|
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.
|
|
|
|
### **_Hide Elapsed Time_**
|
|
|
|
If you don't want people seeing the elapsed time on an activity, append the query param `hideTimestamp=true` to the end of the URL. Elapsed time is shown by default.
|
|
|
|
### **_Hide Clan Tag_**
|
|
|
|
If you don't want people seeing your Clan Tag (formerly known as Guilds), append the query param `hideClan=true` to the end of the URL. Clan Tag is shown by default.
|
|
|
|
### **_Hide Badges_**
|
|
|
|
If you don't want people seeing the badges you have on Discord, append the query param `hideBadges=true` to the end of the URL. Badges are shown by default.
|
|
|
|
### **_Hide Profile_**
|
|
|
|
If you don't want people seeing the profile you have on Discord, append the query param `hideProfile=true` to the end of the URL. Profile are shown by default.
|
|
|
|
### **_Hide Activity_**
|
|
|
|
If you don't want people seeing the your activity, append the query param `hideActivity=true` to the end of the URL or use `hideActivity=whenNotUsed` to hide activity section when there's no activity to display. Activity are shown by default.
|
|
|
|
### **_Hide Spotify_**
|
|
|
|
If you don't want people seeing your Spotify activity, append the query param `hideSpotify=true` to the end of the URL. Spotify activity is shown by default.
|
|
|
|
### **_Hide App by ID_**
|
|
|
|
If you don't want display a specific application, append the query param `ignoreAppId=:app_id` to the end of the URL, IDs separate by `,`.
|
|
|
|
### **_Hide Discriminator_** (DEPRECATED soon)
|
|
|
|
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.
|
|
|
|
## **_Example URL and result_**
|
|
|
|
```
|
|
[](https://discord.com/users/94490510688792576)
|
|
```
|
|
|
|
[](https://discord.com/users/94490510688792576)
|
|
|
|
\
|
|
Note: Current Nitro & Boosting badges **do not work due** to Discord API limitations, unless you currently have an animated avatar, in which case it will display the Nitro badge.
|
|
|
|
_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 :)_
|