Skip to content
/ minehut Public

Node.js wrapper for the Minehut HTTP API

License

Notifications You must be signed in to change notification settings

jellz/minehut

Folders and files

NameName
Last commit message
Last commit date

Latest commit

5e67c6e · Mar 26, 2025

History

82 Commits
Mar 26, 2025
Nov 1, 2024
Jul 10, 2020
Nov 1, 2024
Nov 1, 2024
Mar 26, 2025
Mar 26, 2025
Nov 21, 2024
Feb 8, 2025

Repository files navigation

Minehut

A TypeScript wrapper for the Minehut HTTP API

Installation

Install minehut with NPM

  npm install minehut

Features

  • Get basic Minehut network information.
  • Get information about a Minehut server.
  • Get a list of online servers.
  • Get information about server icons and categories.
  • Get information about a Minehut player such as their rank.
  • Generate a random story from Minehut's Future News.

Basic Usage

const minehut = new Minehut();

async function main() {
    const stats = await minehut.getSimpleStats();
    console.log(stats);

    const lifestealServers = await minehut.servers.getOnlineServers({ category: "lifesteal" });
    console.log(lifestealServers);

    const player = await minehut.players.get('_Tarna_');
    console.log(player);
}

For more examples, visit example.ts.

Notice

Warning

Please keep in mind that usage of the API is meant for private use only, and using the API for malicious purposes is not allowed. Please review the rules and terms of service before using the API.

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

License

MIT

Contributors