Home

Installation

Installing this package requires that both Node.js and npm are installed. npm is required to be located within the PATH variable in order for the installation command to work. Simply run the below command within your project's root directory and ensure a package.json file exists by using npm init beforehand.

npm install minecraft-server-util

TypeScript Support This module is written purely in TypeScript, but is compiled to JavaScript as a CommonJS module. In previous versions, you could simply import by using the following code:

// INCORRECT!!!
import util from 'minecraft-server-util';

... but with the recent v5.0.0 release, the import syntax has changed. You can import the method you need directly from the module or import everything:

import * as util from 'minecraft-server-util';

// or

import { status } from 'minecraft-server-util';

Bug Reports

You can report bugs by opening a new issue on GitHub. Make sure to include as much detail as possible to get the issue resolved in the least amount of time.