node-minecraft-protocol/docs/API.md

Documentation

mc.createServer(options)

Returns a Server instance and starts listening. All clients will be automatically logged in and validated against mojang's auth.

options is an object containing the properties :

• port : default to 25565
• host : default to undefined which means listen to all available ipv4 and ipv6 adresses (see https://nodejs.org/api/net.html#net_server_listen_port_host_backlog_callback for details)
• kickTimeout : default to 10*1000 (10s), kick client that doesn't answer to keepalive after that time
• checkTimeoutInterval : default to 4*1000 (4s), send keepalive packet at that period
• online-mode : default to true
• beforePing : allow customisation of the answer to ping the server does. It takes a function with argument response and client, response is the default json response, and client is client who sent a ping. It can take as third argument a callback. If the callback is passed, the function should pass its result to the callback, if not it should return.
• motd : default to "A Minecraft server"
• maxPlayers : default to 20
• keepAlive : send keep alive packets : default to true
• version : 1.8 or 1.9 : default to 1.8
• customPackets (optional) : an object index by version/state/direction/name, see client_custom_packet for an example
• errorHandler : A way to override the default error handler for client errors. A function that takes a Client and an error. The default kicks the client.
• hideErrors : do not display errors, default to false
• agent : a http agent that can be used to set proxy settings for yggdrasil authentication confirmation (see proxy-agent on npm)

mc.Server(version,[customPackets])

Create a server instance for version of minecraft.

server.onlineModeExceptions

This is a plain old JavaScript object. Add a key with the username you want to be exempt from online mode or offline mode (whatever mode the server is in).

Make sure the entries in this object are all lower case.

server.clients

Javascript object mapping a Client from a clientId.

server.playerCount

The amount of players currently present on the server.

server.maxPlayers

The maximum amount of players allowed on the server.

server.motd

The motd that is sent to the player when he is pinging the server

server.favicon

A base64 data string representing the favicon that will appear next to the server on the mojang client's multiplayer list.

connection event

Called when a client connects, but before any login has happened. Takes a Client parameter.

login event

Called when a client is logged in against server. Takes a Client parameter.

mc.createClient(options)

Returns a Client instance and perform login.

options is an object containing the properties :

• username
• port : default to 25565
• password : can be omitted (if the tokens and profilesFolder are also omitted then it tries to connect in offline mode)
• host : default to localhost
• clientToken : generated if a password is given
• accessToken : generated if a password or microsoft account is given
• auth : the type of auth server to use, either 'microsoft' or 'mojang'. default to 'mojang'
• authServer : auth server, default to https://authserver.mojang.com
• sessionServer : session server, default to https://sessionserver.mojang.com
• keepAlive : send keep alive packets : default to true
• closeTimeout : end the connection after this delay in milliseconds if server doesn't answer to ping, default to 120*1000
• noPongTimeout : after the server opened the connection, wait for a default of 5*1000 after pinging and answers without the latency
• checkTimeoutInterval : default to 30*1000 (30s), check if keepalive received at that period, disconnect otherwise.
• version : 1.8 or 1.9 or false (to auto-negotiate): default to 1.8
• customPackets (optional) : an object index by version/state/direction/name, see client_custom_packet for an example
• hideErrors : do not display errors, default to false
• skipValidation : do not try to validate given session, defaults to false
• stream : a stream to use as connection
• connect : a function taking the client as parameter and that should client.setSocket(socket) and client.emit('connect') when appropriate (see the proxy examples for an example of use)
• agent : a http agent that can be used to set proxy settings for yggdrasil authentication (see proxy-agent on npm)
• profilesFolder : the path to the folder that contains your launcher_profiles.json. defaults to your minecraft folder if it exists, otherwise the local directory. set to false to disable managing profiles

mc.Client(isServer,version,[customPackets])

Create a new client, if isServer is true then it is a server-side client, otherwise it's a client-side client. Takes a minecraft version as second argument.

client.write(name, params)

write a packet

client.end(reason, fullReason)

Ends the connection with reason or fullReason If fullReason is not defined, then the reason will be used.

fullReason is a JSON object, which represents chat message.

client.state

The internal state that is used to figure out which protocol state we are in during packet parsing. This is one of the protocol.states.

client.isServer

True if this is a connection going from the server to the client, False if it is a connection from client to server.

client.socket

Returns the internal nodejs Socket used to communicate with this client.

client.uuid

A string representation of the client's UUID. Note that UUIDs are unique for each players, while playerNames, as of 1.7.7, are not unique and can change.

client.username

The user's username.

client.session

The user's session, as returned by the Yggdrasil system. (only client-side)

client.profile

The player's profile, as returned by the Yggdrasil system. (only server-side)

client.latency

The latency of the client, in ms. Updated at each keep alive.

packet event

Called with every packet parsed. Takes three params, the JSON data we parsed, , the packet metadata (name, state) and the initial buffer

raw event

Called with every packet, but as a buffer. Takes two params, the buffer and the packet metadata (name, state)

state event

Called when the protocol changes state. Takes the new state and old state as parameters.

session event

Called when user authentication is resolved. Takes session data as parameter.

per-packet events

Check out the minecraft-data docs to know the event names and data field names.

client.writeChannel(channel, params)

write a packet to a plugin channel

client.registerChannel(name, typeDefinition, [custom])

Register a channel name using the protodef typeDefinition and sending the register packet if custom is true.

Start emitting channel events of the given name on the client object.

client.unregisterChannel(name, [custom])

Unregister a channel name and send the unregister packet if custom is true.

Not Immediately Obvious Data Type Formats

Note : almost all data formats can be understood by looking at minecraft-data docs or minecraft-data protocol.json

entityMetadata

Value looks like this:

[
  {type: 1, value: 2, key: 3},
  {type: 2, value: 3, key: 4},
  ...
]

Where the key is the numeric metadata key and the value is the value of the correct data type. You can figure out the types here

mc.ping(options, callback)

Ping a minecraft server and retrieve information about it

callback(err, pingResults)

pingResults:

Old version

• prefix
• protocol
• version
• motd
• playerCount
• maxPlayers

New version

• description
• players
  • max
  • online
  • sample
    • id
    • name
• version
  • name
  • protocol
• favicon
• latency

mc.states

The minecraft protocol states.

mc.supportedVersions

The supported minecraft versions.

mc.createSerializer({ state = states.HANDSHAKING, isServer = false , version})

Returns a minecraft protocol serializer for these parameters.

mc.createDeserializer({ state = states.HANDSHAKING, isServer = false, packetsToParse = {"packet": true}, version })

Returns a minecraft protocol deserializer for these parameters.