🍄 Mush-API.JS

An unofficial Node.js wrapper for the Mush API.

[!NOTE] Please note that the typings were generated based on data collected from multiple players and may be outdated or change over time.

📦 Installation

Install the package using your preferred package manager:

| Package Manager | Command | |-----------------|---------| | npm | npm install mush-api.js | | pnpm | pnpm add mush-api.js | | yarn | yarn add mush-api.js |

This package requires Node.js 18 or higher.

📡 Usage

import { MushClient, Routes } from "mush-api.js";
// You can use CommonJS as well
// const { MushClient, Routes } = require("mush-api.js");

const client = new MushClient();

const player = await client.api.request(Routes.Player("mariaum"));

console.log(player);

📝 To-do

• Reduce typings for bedwars, duels & hungergames files.
• Typings, classes and routes for Player, Game, Punishment & XP table
• Rate limit handling

✨ Credits

• Mush for providing the public API
• yPandinho for documenting the API in this forum topic

⭐ Contributing

Contributions are welcome!

If you want to improve this package, feel free to open a pull request.
If you find a bug or want to suggest a feature, please open an issue describing the problem or idea.