https://github.com/domi-btnr/clientmodbadges-api

API for getting badges from other discord client mods
https://github.com/domi-btnr/clientmodbadges-api

aliucord api betterdiscord discord enmity replugged velocity vencord

Last synced: 22 days ago
JSON representation

API for getting badges from other discord client mods

• Host: GitHub
• URL: https://github.com/domi-btnr/clientmodbadges-api
• Owner: domi-btnr
• Created: 2022-12-26T13:50:23.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T09:03:40.000Z (about 2 months ago)
• Last Synced: 2024-10-29T10:56:57.368Z (about 2 months ago)
• Topics: aliucord, api, betterdiscord, discord, enmity, replugged, velocity, vencord
• Language: JavaScript
• Homepage: https://clientmodbadges-api.herokuapp.com
• Size: 3.41 MB
• Stars: 15
• Watchers: 2
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ClientModBadges-API

This API allows you to retrieve user badges for various discord client mods.

### Supported client mods:

- [Aliucord](https://github.com/Aliucord/Aliucord)

- [BetterDiscord](https://github.com/BetterDiscord/BetterDiscord)

- [BadgeVault](https://github.com/WolfPlugs/BadgeVault)

- [Opti](https://github.com/opti-mod/Opti)

- [Enmity](https://github.com/enmity-mod/enmity)

- [Replugged](https://github.com/replugged-org/replugged)

- [Vencord](https://github.com/Vendicated/Vencord)

### Endpoints

`/users/:userId` Returns the badges for the user

Example Response:

```json

{

    "BadgeVault": [

        {

            "name": "Astronaut",

            "badge": "https://gb.obamabot.me/1fdb7e114a428c3d7a063f15d7616b59447e490f.png"

        }

    ],

    "Enmity": [

        "supporter"

    ],

    "Vencord": [

        "Contributor"

    ]

}

```

`/badges/:clientMod/:badge` Returns the badge icon

The response will be the badge icon in `image/png` format.

## Contributing

We welcome contributions to the ClientModBadges-API! If you're looking to contribute, here's how you can help:

- **Support for New Client Mods:** If you want to add support for a new client mod, please ensure it is not a fork of an existing mod unless the original mod has reached its end-of-life (EOL). In such cases, contributions to support forks are acceptable.

- **Feature Requests:** If you have ideas on how to improve the API or add new features, we encourage you to open a feature request. This helps us understand what the community needs and prioritize accordingly.

- **Bug Reports:** If you encounter any bugs or issues, please report them by opening an issue. Provide as much detail as possible to help us understand and fix the problem quickly.

Remember, all contributions should aim to improve the API and support the wider community of client mod users. We look forward to your contributions!