connorslade/minecrafthead

🕹 Simple NPM package interface to the Mojang API

MinecraftHead

🕹 Simple NPM package interface to the Mojang API

Install

$ npm i minecraft_head

Documentation

You can find Documentation here

Examples

First import the package:

const mc = require('minecraft_head'); // Import Module
let player = new mc.player('Sigma76'); // Create a new Player (Can use Name or Uuid)

Get UUID or a player:

// Will take Player Object or player name as a string
mc.nameToUuid(player)
    .then(data => {
        console.log(data.uuid);
    })
    .catch(console.log);

// Another way if using player Object
player.uuid.then(uuid => {
    console.log(uuid);
});

Get Player Name:

// Will take player Object or Uuid as a string
mc.uuidToName(player)
    .then(data => {
        console.log(data.name);
    })
    .catch(console.log);

// Another way if using player Object
player.name.then(name => {
    console.log(name);
});

Get full name history of a player:

// Will take Player Object or Uuid as a string
mc.getNameHistory(player)
    .then(data => {
        console.log(data);
    })
    .catch(console.log);

Get a player's name at a specific time:

// Will take Player Object or Uuid as a string
// Also takes a Date Object
// Due to API limitations anything before the first name change will be the accounts original name.
mc.getNameAtDate(player, new Date('2017-01-01'))
    .then(name => {
        console.log(name);
    })
    .catch(console.log);

Get Player Skin (and cape):

// Will take Player Object or Uuid as a string
// Before the Player Object you would need to convert a player name to Uuid yourself
mc.getSkin(player)
    .then(skin => {
        console.log(skin);
    })
    .catch(console.log);

Check if server is banned by Mojang:

mc.isServerBlocked('playmc.mx')
    .then(data => {
        console.log(data);
    })
    .catch(console.log);