Github NPM Docs

⚠ WARNING: This package is not finished and does not cover the full Minecraft protocol yet. It only covers parts of the 1.16.3 protocol. To check what parts of the protocol are covered, see the docs. New package updates will change the API and add more coverage.

Create Minecraft Servers with an easy to use API and with full control

This is a library that gives you access to an easy to use API that you can use to create Minecraft Java Edition servers. This package includes types so that your IDE has autocomplete. You have full control over the protocol and everything that is being sent to the client in an easy way. This means you have full control of what is being sent to each Client, and that you can send different information to different Clients.

Installation and usage

1. Install with npm i @boem312/minecraft-server.
2. Now you can use the library. Here's an example code:

const { Server } = require('@boem312/minecraft-server');
const server = new Server();

server.on('connect', client => {

    console.log(`${client.username} joined`);
    client.chat(`Hello world, ${client.username}`);

});

1. Join the server with Minecraft Java Edition version 1.16.3 on host localhost and on port 25565. Different versions and ports are currently not supported.

If you want to now how to use the rest of the library, please see the documentation.

For more examples, please see the examples folder.

If you have any questions please first read the FAQ. If your question isn't in there, you can ask a question in discussions.

Key features

• Fast, starting a server with this library is way faster than using the default Java server.
• Easy to use, you can create servers in an intuitive way.
• Everything is per Client, meaning you can send different information to different Clients.

Terms

These are some terms that are used in the code and documentation.

Client

The Client is the system that is connecting/connected to the Server.

Link to latest docs for Client

Player

A player is just a type of Entity. It is the thing that a Client sees, when they see other people. Each Client has it's own players. Here's an example:

• Notch (Client)
  • jeb_ (Player)
• jeb_ (Client)
  • Notch (Player)

In this case, there are two Clients online; Notch and jeb_ (top level) and they both see one another. A Player doesn't have to be a Client, it could also just look like one, without being actually connected to the server. Here's an example of that:

• Notch (Client)
  • jeb_ (Player)
  • Hub (Player)
• jeb_ (Client)
  • Hub (Player)

Here Notch sees jeb_, but jeb_ doesn't see Notch. Both jeb_ and Notch see the Player (not connected to the server) Hub. Hub isn't a Client that is connected to the server, but looks like one to Notch and jeb_.

Entity

Entities include all dynamic, moving objects throughout the Minecraft world. Some examples of entities are:

• Pigs
• Armor stands
• Minecarts
• Players
• Falling blocks

Contributing

See contributing.md

License

For the full license, see license.md. This package uses the ISC license.

Special thanks

• wiki.vg for documenting the full Minecraft protocol.
• minecraft-protocol for parsing all the packets and helping with the login process.
• All the contributors for helping improve the package.
• Typedoc for generating part of the documentation.