Minecraft-information NPM

MINECRAFT-INFORMATION

About

minecraft-information is an npm that makes it easy to find minecraft data for your projects in JavaScript.

Installation

Node.js 12 or newer is required

npm install minecraft-information
yarn add minecraft-information
pnpm add minecraft-information

How to use

const { Minecraft }  = require('minecraft-information');
const { HyPixel } = require('minecraft-information');
const hypixel = new HyPixel('HIPIXEL_API_KEY');


Minecraft.avatar('example').then(async(res) => {
  console.log(res)
})

hypixel.player('example').then(async x => {
    console.log(x)
})

How to use on discord.js

const { Client } = require('discord.js')
const client = new Client()
const { Minecraft }  = require('minecraft-information');

client.on('message', async(msg) => {
  if(msg.content.startsWith('?'+'avatar')){
    let avatar = await Minecraft.avatar('example')
    message.channel.send({files:[avatar]})
  }
})

Functions

Function	params
HyPixel	API-key
Minecraft

Hypixel

Require an api key

Function	Type	params
player	`Object`	name
friends	`Object`	name
recentGames	`Object`	name
status	`Object`	name
boosters	`Object`
playerCount	`Object`
leaderboards	`Object`
punishments	`Object`

How to get a hypixel key:

Join in the server (play.hypixel.net)
Type the command /api new

Minecraft

Function	Type	params
achievement	`String`	title, content, index
avatar	`String`	name, size
body	`String`	name, size
cape	`Object`	name
head	`String`	name
names	`Array`	name
profile	`Object`	name
skin	`String`	name
server	`Object`	ip
item	`Array` or `Object`	name
biome	`Array` or `Object`	name
block	`Array` or `Object`	name
entity	`Array` or `Object`	name