# mine-status

> This npm package allows you to retrieve information about Minecraft servers for both Java and Bedrock editions.

Latest version **1.0.3** (published 2023-12-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install mine-status
pnpm add mine-status
yarn add mine-status
bun add mine-status
```

## 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.3 |
| Published | 2023-12-18 |
| First published | 2023-12-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | luoshenshi |
| Maintainers | luoshenshi |
| Keywords | minecraft |

## Links

- npm: https://www.npmjs.com/package/mine-status
- Repository: https://github.com/luoshenshi/MineStatus
- Issues: https://github.com/luoshenshi/MineStatus/issues
- npm.io page: https://npm.io/package/mine-status

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^1.6.2

## Recent versions

- 1.0.3 (latest) — 2023-12-18
- 1.0.2 — 2023-12-18
- 1.0.1 — 2023-12-18
- 1.0.0 — 2023-12-18

## README

## MineStatus

This npm package lets you obtain information about Minecraft servers for both Java and Bedrock.

**Note:** *May not be compatible with Aternos Servers*

### Getting Started

```bash
npm i mine-status
```

```javascript
const { MineStatus } = require("mine-status");

const minestatus = new MineStatus();
//without port
minestatus.getJavaServerStatus("hypixel.net", (response) => {
  console.log(response);
});
```

OR

```javascript
const { MineStatus } = require("mine-status");

const minestatus = new MineStatus();
//with port
minestatus.getJavaServerStatus("hypixel.net", 25565, (response) => {
  console.log(response);
});
```

And you can also check out many more...

### Functions:

- getJavaServerStatus(server_name, portOrCallback, callback);
- getJavaServerWidget(server_name, portOrCallback, callback);
- getBedrockServerStatus(server_name, portOrCallback, callback);
- getServerIcon(server_name, portOrCallback, callback);

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