JSPM

@tram-ai/mcquery

1.0.0
    • ESM via JSPM
    • ES Module Entrypoint
    • Export Map
    • Keywords
    • License
    • Repository URL
    • TypeScript Types
    • README
    • Created
    • Published
    • Downloads 4
    • Score
      100M100P100Q66422F
    • License MIT

    Node.js port of mcutil (Minecraft status/query/rcon/vote utilities)

    Package Exports

    • @tram-ai/mcquery

    Readme

    @tram-ai/mcquery

    Node.js Minecraft utility library for server status, query, RCON, vote, and text formatting.

    Install

    npm i @tram-ai/mcquery

    Usage

    import { status, query, rcon, formatting } from "@tram-ai/mcquery";
    
    // 1) Java modern status
    const modern = await status.modern("example.com", 25565, {
      enableSRV: true,
      ping: true,
      timeoutMs: 5000
    });
    console.log(modern.players.online, modern.players.max);
    console.log(modern.motd.clean);
    
    // 2) Query basic/full
    const basic = await query.basic("example.com", 25565);
    const full = await query.full("example.com", 25565);
    console.log(basic, full);
    
    // 3) RCON
    const client = await rcon.dial("example.com", 25575, { timeoutMs: 5000 });
    await client.login("your-rcon-password");
    const output = await client.execute("list");
    console.log(output);
    await client.close();
    
    // 4) Formatting parser
    const parsed = formatting.parse("§cHello §lWorld");
    console.log(parsed.clean); // Hello World
    console.log(parsed.html);

    API Overview

    • status.modern(host, port?, options?)
    • status.modernRaw(host, port?, options?)
    • status.legacy(host, port?, options?)
    • status.bedrock(host, port?, options?)
    • query.basic(host, port?, options?)
    • query.full(host, port?, options?)
    • rcon.dial(host, port?, options?)
    • vote.sendVote(host, port, options)
    • formatting.parse(input)