Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

all-minecraft

mallusrgreatv295MIT1.0.14TypeScript support: included

Installation

minecraft, api, minetools, mcheads, mc-heads, mcapi, minecraft-api, mojang, skin, minecraft skin, head, minecraft head, typing, typescript, minecraft ts, minecraft typescript, api minecraft, minecraft server info, server info, minecraft info, information, minecraft information, mc info, mc api, mc server info, mc head, mc skin, mc servers, mc ts, mc typing, mc player, mc player info, mc player lookup, minecraft mods, minecraft commands, minecraft texture packs, minecraft enchantments, minecraft potions, minecraft biomes, minecraft animals, minecraft blocks, minecraft items, minecraft weapons, minecraft armor, minecraft tools, minecraft building, minecraft redstone, minecraft farming, minecraft mining, minecraft exploration, minecraft survival, minecraft creative mode, minecraft multiplayer, minecraft singleplayer, minecraft mini games, minecraft parkour, minecraft pvp, minecraft pve, minecraft factions, minecraft clans, minecraft servers, minecraft server hosting, minecraft server plugins, minecraft server commands, minecraft server setup, minecraft server mods, minecraft server management, minecraft server performance, achievements, advancements, annotations, anti-cheat, asset, authentication, banner, beacon, biome generation, block IDs, block states, boss battles, brewing, bug fixes, button, cartography, chat, chunk, client, commands, compatibility, compression, configuration, console, crafting, cross-play, custom items, damage, data packs, datapoints, death, debug, default resources, development, dimensions, directions, discovery, display, durability, dynamics, effects, efficiency, emotes, entities, entity IDs, experience, exploration maps, farms, file formats, filters, fire, fishing, fluid, food, game modes, game rules, gamerules, gaming, gate, generation, glitches, gravity, GUI, health, help, hitboxes, hopper, horses, hosting, hunger, implements, inventory, item IDs, item frames, items, Java edition, jumping, land generation, landscapes, lantern, launching, lava, level generation, lighting, loot tables, machines, magic, magma, map generation, maps, marketplace, materials, menu, messaging, metadata, mobs, mod compatibility, modpacks, mods, modding, monsters, mountains, multiplayer servers, music, nbt, navigation, network, nodes, notes, notifications, objectives, ocean, options, ores, overworld, painting, particles, patch notes, pathfinding, performance, persistence, physics, pickaxe, ping, player customization, player experience, player housing, player interaction, player movement, player skins, player versus player, player versus environment, plugin compatibility, plugins, pockets, portals, potions effects, power sources, progress, project management, protection, protocol, quests, quick access, quickslots, rabbits, raids, random number generation, realms, recipe book, redstone circuits, regeneration, rendering, respawn, resources, restrictions, rewards, riding, rights, river, roads, role playing, roof, rotation, rules, sandbox, save game, scaling, science, scripting, seasons, seeds, server administration, server configuration, server hosting, server management, server plugins, server setup, server software, server specs, server status, server tools, shaders, sharing, shelter, shop, signs, simulation, skin customization, skyblock, slabs, sleep, snapshot, social, software, sound effects, spawning, special abilities, spectator mode, speed, spigot, splash potions, sports, stability, stats, status, stone, storage, story, strategy, structure blocks, sub-servers, sun, survival, swimming, system requirements, team, technology, terrain, texture packs, third-party software, tick speed, time, tips, toggleable options, tools, torch, trading, traffic, trail, training, traps, trees, troubleshooting, tutorial, tweaks, updates, upgrades, user interface, utilities, versions, vertical slabs, video games, village, virtual reality, visibility, water, weather, web application, website, whitelist, wilderness, wiki, windows 10 edition, wire, world generation, world management, world seed, world settings, world types, x-ray, xp, youtube, zombie, zoom, 3D models, abstract, action, adventure, allegory, alternate history, alternate reality, amateur, analysis, android, animation, anniversary, apocalypse, arcade, art, artificial intelligence, asteroids, avatar, backtracking

readme

Discord NPM

all-minecraft

Installation

# NPM
npm install --save all-minecraft

# Yarn
yarn add all-minecraft

Usage

// ES5
const allMinecraft = require("all-minecraft");

// ES6
import allMinecraft from "all-minecraft";

Server Information

MinecraftServerInfo.serverInfo

const { MinecraftServerInfo } = require("all-minecraft");
const server = new MinecraftServerInfo({
  serverIp: "pika.host",
});
server.serverInfo().then(console.log);
Expected Output

MinecraftServerInfo.query

const server = new MinecraftServerInfo({
  serverIp: "lobby.freecraft.eu",
  queryPort: 25555,
});
server.query().then(console.log);
Expected Output

Others

const server = new MinecraftServerInfo({
  serverIp: "darklegacymc.tk",
});
console.log("Favicon: " + server.favicon());
console.log("Banner: " + server.getBannerURL({ title: "DarkLegacyMC" }));
console.log("IP: " + server.getServerIp);
console.log("Port: " + server.getServerPort);
Expected Output

Player Information

MinecraftPlayerInfo.getHead

const { MinecraftPlayerInfo } = require("all-minecraft");
const player = new MinecraftPlayerInfo({
  usernameOrUUID: "mallusrgreat",
});
console.log(
  player.getHead({
    extension: "png",
    helm: false,
    size: 100,
    facing: "left", // Facing is only for isometric
  })
);
Expected Output

MinecraftPlayerInfo.getSkin

console.log(
  player.getSkin({
    extension: "png",
    helm: false,
    size: 100,
    facing: "left", // Facing is only for isometric version
  })
);
Expected Output

MinecraftPlayerInfo.getPlayerInfo

player.getPlayerInfo().then(console.log);
Expected Output

Other

console.log("Username / UUID Specified in constructor: " + player.getUsernameOrUUID);
Expected Output

That's it! You're done