minecraft-server-data/README.md

A simple MCApi wrapper written in JavaScript.

# Minecraft Server Data
Get the status data of a Minecraft server by providing it's IP address.

## Installation

[![NPM](https://nodei.co/npm/minecraft-server-data.png)](https://nodei.co/npm/minecraft-server-data/)

```
npm install minecraft-server-data
```

### Usage

The only and mandatory parameter for this function to be executed is a server IP.  
You can provide a port as well if needed. The default one is 25565.

Here is a quick example of how to make a call
```javascript
const getData = require("minecraft-server-data");

// Not providing a port
getData("<YourServerIP>")
  .then(console.log)
  .catch(console.error);

// Providing a port
getData("<YourServerIP>", 43778)
  .then(console.log)
  .catch(console.error);
```

## Data Structure
The output data will look like the following:
```json
{
    "online": true,
    "motd": "<TheServersMOTD>",
    "players": {
        "max": 5,
        "now": 0
    },
    "server": {
        "version": "<TheServersMinecraftVersion>",
        "protocol": 340
    },
    "last_online": "LastSeenOnlineTimestamp",
    "last_updated": "LastUpdatedTimestamp",
    "queryDuration": 435
}
```
The queryDuration is output in millisecond.

© 2020 - Edouard Courty