# @javahampus/minecraft-api

> A Minecraft API wrapper to easily gather information about a Minecraft server.

Latest version **1.0.1** (published 2021-07-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install @javahampus/minecraft-api
pnpm add @javahampus/minecraft-api
yarn add @javahampus/minecraft-api
bun add @javahampus/minecraft-api
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-07-02 |
| First published | 2021-06-28 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 5 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | javahampus |

## Links

- npm: https://www.npmjs.com/package/@javahampus/minecraft-api
- Repository: https://github.com/JavaHampus/mc-api
- Homepage: https://github.com/JavaHampus/mc-api#readme
- Issues: https://github.com/JavaHampus/mc-api/issues
- npm.io page: https://npm.io/package/@javahampus/minecraft-api

## Dependencies (3)

- [net](https://npm.io/package/net.md) ^1.0.2
- [axios](https://npm.io/package/axios.md) ^0.21.1
- [stream](https://npm.io/package/stream.md) 0.0.2

## Recent versions

- 1.0.1 (latest) — 2021-07-02
- 1.0.0 — 2021-06-28

## README

# `minecraft-api`
A Minecraft API wrapper to easily gather information about a Minecraft server.

## Installation
```bash
npm i @javahampus/minecraft-api
```

## Example
```ts
import { ServerManager } from '@javahampus/minecraft-api' // Import the package

let mc = new ServerManager('play.server.net')

async function displayPlayers() {
    let players = await mc.getPlayerCount();
    let max = await mc.getMaxPlayers();
    return console.log(`${players}/${max}`)
}

// ...
```

---
_Source: https://npm.io/package/@javahampus/minecraft-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._