OLD_README.md

PersonalBadges

Create profile badges that are exclusively visible to you through JSON.

Want to install this plugin?

https://docs.vencord.dev/installing/custom-plugins/

Usage

Once the plugin is enabled, you should immediately have a directory created within your %AppData%/Roaming/Vencord folder or wherever your Vencord local data is stored named badges .

• If you try to edit the 'settings' of the plugin by clicking on the cog wheel, you should see a few buttons. Click on the button that says Locate Badges Folder and it should take you directly to where the badges directory is located.

Or if you so truly desire to take an alternative route . . .

• Navigate to this directory manually by accessing %AppData% or wherever your Vencord local data may be stored on your system. Find the Vencord folder and inside should have badges.

To begin creating your first badge, you must create a .json file. The name does not matter, but the contents do.

Badge Properties

Property	Description	Required?
image	An image link that is set for the badge. I don't think the file type matters; feel free to use gifs, etc.	false
tooltip	The tooltip / description that appears when hovering over the badge.	false
position	The badge position of which can be either START or END, by default it is START. It is also case-insensitive.	false
link	A link that is opened upon clicking the badge. If this is not set by default, it will link to this repository. :]	false
users	An array of users listed by ID that will have this badge. No, they cannot see it.	true if global is not set.
global	Whether or not the badge is globally visible. This just means it's added to everyone; it will override users.	true if users is not set.
excluded	An array of users listed by ID, that will not have this badge. This will override global and users. Now, they really can't see it.	false

Example

Remember that some of these override each other, so it could be useless to keep them. I am just showcasing all of the properties in use at once, even though not all of them are needed.

sparkly.json

[
    {
        "image": "https://i.imgur.com/ubPqge8.png",
        "tooltip": "Sparkly ✨",
        "position": "start",
        "link": "https://github.com/YLohkuhl/personalBadges",
        "users": ["USER_ID_HERE_THOUGH_IT_GETS_OVERRIDDEN_ANYWAYS", "MAYBE_ANOTHER_ONE"],
        "global": true,
        "excluded": ["USER_ID_IN_QUOTATION_MARKS_ONLY"]
    }
]

_{If you actually wanna use this badge, just remove users, excluded, positions and link (unless you wanted any of these). Feel free to enjoy being ✨ Sparkly ✨ .}

It is important to have the [] as your start before {}. This gives support for having multiple badges in one file in case you ever want to have less files.

If you want, you could share these files with other users who you'd like to see the same badge as you. Even something made to be private like this could still be public if you decide so!

✨ Thank you for using my plugin if you decided to do so! ✨

_{Notice! I may not have to mention this but you know... if you go haywire when adding a ton of badges to a user, might not look so good with the UI. That takes a lot of badges for that though... maybe fix it with some CSS, idk.}

_{Another Notice! If you want to update your badges without refreshing / restarting Discord; use the Update Badges button in the settings. Enabling the VencordToolbox plugin; it will have an option to do this as well for ease of access.}

_{. . . This is my first plugin for Vencord-}