# minecraft-server-util

> A Node.js library for Minecraft servers that can retrieve status, perform queries, and RCON into servers.

Latest version **5.4.4** (published 2023-05-19) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install minecraft-server-util
pnpm add minecraft-server-util
yarn add minecraft-server-util
bun add minecraft-server-util
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 5.4.4 |
| Published | 2023-05-19 |
| First published | 2019-09-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=10.0.0 |
| Dependencies | 1 |
| Unpacked size | 313.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 148 |
| Author | Jacob Gunther |
| Maintainers | passthemayo |
| Keywords | minecraft, java, bedrock, server, status, ping, query, rcon, vote, votifier |

## Links

- npm: https://www.npmjs.com/package/minecraft-server-util
- Repository: https://github.com/PassTheMayo/minecraft-server-util
- Homepage: https://passthemayo.gitbook.io/minecraft-server-util/
- Issues: https://github.com/PassTheMayo/minecraft-server-util
- npm.io page: https://npm.io/package/minecraft-server-util

## Dependencies (1)

- [minecraft-motd-util](https://npm.io/package/minecraft-motd-util.md) ^1.1.9

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads

## Recent versions

- 5.4.4 (latest) — 2023-05-19
- 5.4.2 — 2023-04-03
- 5.4.1 — 2023-03-26
- 5.4.0 — 2023-02-22
- 5.3.2 — 2023-01-09
- 5.3.1 — 2022-08-26
- 5.3.0 — 2022-07-11
- 5.2.10 — 2022-06-23
- 5.2.9 — 2022-01-19
- 5.2.8 — 2021-12-31
- 5.2.7 — 2021-12-26
- 5.2.6 — 2021-12-24
- 5.2.5 — 2021-12-22
- 5.2.4 — 2021-12-21
- 5.2.3 — 2021-12-20
- … 57 more at https://npm.io/package/minecraft-server-util/versions

## README

# minecraft-server-util

[![npm version](https://img.shields.io/npm/v/minecraft-server-util?label=version)](https://www.npmjs.com/package/minecraft-server-util)
![Version](https://img.shields.io/github/languages/top/PassTheMayo/minecraft-server-util)
[![License](https://img.shields.io/npm/l/minecraft-server-util)](https://github.com/PassTheMayo/minecraft-server-util/blob/master/LICENSE)
![npm weekly downloads](https://img.shields.io/npm/dw/minecraft-server-util)
[![GitHub open issues](https://img.shields.io/github/issues-raw/PassTheMayo/minecraft-server-util)](https://github.com/PassTheMayo/minecraft-server-util/issues)

A Node.js library for Minecraft servers that can retrieve status, perform queries, and RCON into servers. It uses modern Minecraft protocols to support the latest servers and also includes backward compatibility for older versions. This library supports both Java Edition and Bedrock Edition servers, as long as the correct method is used.

---

**Deprecation Notice**

This library has been deprecated, meaning it is no longer actively maintained. While you can still use it, it is highly recommend that you do not as it may be removed from the npm registry in the far future. I have dedicated my time to an alternative service — [mcstatus.io](https://mcstatus.io) — which is more extensively tested, more stable, and contains more features than this library.

---

If you still wish to use this library, everything you need to know to get started is located within our documentation website: **https://passthemayo.gitbook.io/minecraft-server-util/**

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