Bedwars Favourites Display

Bedwars Favourites Display is a Node.js package that retrieves a player's Bedwars item shop favorites from the Hypixel API and draws them using the HTML5 canvas. Perfect for displaying or analyzing your favourites in the Bedwars item shop programmatically with ease.

Disclaimer

This project is not affiliated with, endorsed by, or maintained by Hypixel or Mojang.
It uses the Hypixel API to retrieve player data. You must comply with Hypixel's API terms of service when using this package.

Limitations

The Hypixel API has rate limits depending on the type of API key you use, so be mindful of its limit.

Installation

To install the package, ensure that you have Node.js installed, then run the following command in your terminal:

npm i bedwars-favourites-display

Methods

display(uuid, api_key)

Draws the player's favourites from the Bedwars item shop and returns the image data in PNG format.

Parameters:

• uuid (string): The UUID of the Minecraft player.
• api_key (string): Your Hypixel API key. Get one here.

Example Code Snippet

const fs = require("fs");
const path = require("path");
const bfd = require("bedwars-favourites-display");

(async () => {
    try {
        // Replace "YOUR_API_KEY" with your actual Hypixel API key
        const resp = await bfd.display("da500367-bc0f-45cc-9432-a78175d958f1", "YOUR_API_KEY");
        fs.writeFile("output.png", resp, (err) => {
            if (err != null) throw err;
            console.log(`Successfully saved rendered favourites at "${path.join(process.cwd(), "output.png")}"`);
        });
    } catch (e) {
        console.error(`Failed to render favorites: ${e}`);
    }
})();

Output

Below is an example of a rendered output showing a player's Bedwars favorites:

License

This project is licensed under the MIT License. See the LICENSE file for more details.