npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

minecraft-java-server

v1.0.3

Published

Gives the ability to manage your Minecraft Java Edition server, using plain javascript/typescript. Inspired by @scriptserver/core

Downloads

16

Readme

Minecraft Java Server

This library helps you run and manage your Minecraft Java Edition server through a node.js environment. It supports type declarations with Typescript, meaning you don't need to install any @types library.

It is heavily inspired by @scriptserver/core. I created it after discovering a missing feature in the library, and decided to make my own, both to learn, and to be able to continue what I was working on.

The library utilizes Minecraft's rcon feature. It allows you to securely send commands through networking, and receive the output text through the response.

Usage

Installation

Run the following command in your project's root directory:

npm install minecraft-java-server --save

Basic Usage

import { MinecraftServer } from 'minecraft-java-server';

const server = new MinecraftServer({
    jar: 'server.jar',
    path: 'C:/path/to/your/minecraft/server/directory',

    args: ['-Xms4G', '-Xmx4G'],

    // Minecraft's eula must be agreed to using this value
    eula: true,

    // every property is the equivalent of server.properties, except for vital ones
    properties: {
        motd: "Minecraft server hosted with minecraft-java-server",
        "max-players": 10
    }
});

// Start event
server.on('start', () => {
    console.log('Server started');
});

// Stop event
server.on('stop', () => {
    console.log('Server stopped');
});

// Start the server
server.start();

server.send('ban herobrine').then(response => {
    console.log('Command result: ', response);
}).catch(err => console.log('Failed to run command', err));

Since server.send returns a promise, this also works in an asynchronous context using await. The promise is rejected if the server disconnects after queueing the command.