AstralTransRocketries/node-minecraft-protocol
1
0
Fork 0
mirror of https://github.com/unmojang/node-minecraft-protocol.git synced 2025-09-29 14:13:45 -04:00
Code Issues Packages Projects Releases Wiki Activity

add doc

Browse Source
This commit is contained in:
Romain Beaumont 2016-08-10 20:06:40 +02:00
parent a0717a1232
commit 10b3cba5f8
No known key found for this signature in database
GPG Key ID: DB60E388B3BCF286
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/README.md
View File

@ -82,6 +82,10 @@ Returns a `Client` instance and perform login.
Create a new client, if `isServer` is true then it is a server-side client, otherwise it's a client-side client. 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. Takes a minecraft `version` as second argument.
### client.write(name, params)
write a packet
### client.state ### client.state
The internal state that is used to figure out which protocol state we are in during The internal state that is used to figure out which protocol state we are in during
@ -137,6 +141,23 @@ parameters.
Check out the [minecraft-data docs](https://prismarinejs.github.io/minecraft-data/?v=1.8&d=protocol) to know the event names and data field names. Check out the [minecraft-data docs](https://prismarinejs.github.io/minecraft-data/?v=1.8&d=protocol) 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 ## Not Immediately Obvious Data Type Formats
Note : almost all data formats can be understood by looking at Note : almost all data formats can be understood by looking at