mowojang

Important

This is a third party wrapper for the Mowojang API!

✨ Quick Start

import { Client as MowojangClient } from "mowojang"

const Mowojang = new MowojangClient()

const UUID = await Mowojang.getUUID("Pixelic")
const username = await Mowojang.getUsername("14727fae-fbdc-4aff-848c-d2713eb9939e")

⚙️ Configuration

The Client constructor accepts an optional configuration object.

const Mowojang = new MowojangClient({
  baseURL: "https://mowojang.matdoes.dev", // The base URL for the Mowojang API
  fallback: true, // Whether to fallback to mowojang.seraph.si if the default baseURL is down
  timeout: 10000, // Request timeout in milliseconds
  validation: {
    enabled: true, // Enable automatic validation for inputs (UUIDs and Usernames)
    minimumUsernameLength: 1, // Minimum username length required to pass validation (1 or 2), default is 3.
  },
})

Tip

If you plan on using this in a long-running process with heavy usage check out this guide on how to setup custom caching to prevent memory leaks. Guide: Custom-Caching

🔧 Functions / Supported Endpoints

• getProfiles(): Retrieve full Player Data of multiple Players by UUID or Username
• getProfile(): Retrieve full Player Data by UUID or Username
• getSessions(): Retrieve Player Session Data of multiple Players by UUID or Username
• getSession(): Retrieve Player Session Data by UUID or Username
• getUUID(): Converts a Player's Username to UUID
• getUsername(): Converts a Player's UUID to Username
• getSkin(): Returns the Skin the specified Player is currently wearing
• getSkinBuffer(): Returns Skin Image fetched via getSkin() as a Buffer
• getCape(): Returns the Cape the specified Player has currently selected
• getCapeBuffer(): Returns Cape Image fetched via getCape() as a Buffer

All above Functions accept an second Argument containing an optional config object. Cache options can also be passed there via the cache key. All available cache options can be found here.

Note: getProfiles() defaults to fetching each profile via individual GET requests to improve reliability. To use the POST bulk endpoint instead, pass { usePost: true } as the second argument to getProfiles().

🗃️ Utility Functions

All Utility Functions are exported combined as utlis.x.

• dashUUID(): Adds dashes to UUIDv4 (If the UUIDv4 is already dashed nothing will change)
• undashUUID(): Removes all dashes from UUIDv4

🗂️ Validator Functions

All Validator Functions are exported combined as validate.x.

• UUID(): Returns whether the provided String is an valid UUID (Accepts both undashed and dashed UUIDv4 Strings)
• username(): Returns whether the provided String is an valid Username (Accepts a second argument stating the minimum length required to pass the validation)
• player(): Combines the above

📦 CLI

You can also use this package from the CLI using mowojang-cli. (Repository)

⚙️ Development

• pnpm install: Installs all required dependencies
• pnpm build: Runs the compiler
• pnpm test: Runs tests for all functions

📎 Credits

• Mowojang Creator (Mat): Website, GitHub or Ko-Fi

📡 Mowojang Status

Show status badges

• Mowojang API - GET /:username ->
• Mowojang API - GET /:UUID ->
• Mowojang API - GET /session/minecraft/profile/:UUID ->
• Mowojang API - GET /users/profiles/minecraft/:username ->
• Mowojang API - POST / - [username,UUID] ->
• Minecraft API - GET /texture/:hash ->