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

expose constants; update README

Browse Source
This commit is contained in:
Andrew Kelley 2013-01-04 23:22:48 -05:00
parent 3e7501b215
commit b9bea65e50
2 changed files with 2 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -4,6 +4,7 @@ Parse and serialize minecraft packets, plus authentication and encryption.
## Features ## Features
* Supports Minecraft version 1.4.7pre
* Parses all packets and emits events with packet fields as JavaScript * Parses all packets and emits events with packet fields as JavaScript
objects. objects.
* Send a packet by supplying fields as a JavaScript object. * Send a packet by supplying fields as a JavaScript object.
@ -23,10 +24,6 @@ Parse and serialize minecraft packets, plus authentication and encryption.
* Robust test coverage. See Test Coverage section below. * Robust test coverage. See Test Coverage section below.
* Optimized for rapidly staying up to date with Minecraft protocol updates. * Optimized for rapidly staying up to date with Minecraft protocol updates.
## Minecraft Compatibility
Supports Minecraft version 1.4.7pre
## Usage ## Usage
### Echo client example ### Echo client example
@ -107,13 +104,3 @@ server.on('login', function(client) {
11 tests complete (45 seconds) 11 tests complete (45 seconds)
``` ```
## Updating to a newer protocol version
In most cases you should only have to do the following:
1. In `packets.json`:
* Update `protocolVersion` to the correct number.
* Edit the data structure to reflect the new packet layout.
2. Update the "Minecraft Compatibility" section above in this README.
3. Run the test suite to make sure everything still works. See "Testing" above.

1
index.js
View File

@ -15,6 +15,7 @@ module.exports = {
Client: Client, Client: Client,
Server: Server, Server: Server,
ping: require('./lib/ping'), ping: require('./lib/ping'),
constants: protocol.constants,
}; };
function createServer(options) { function createServer(options) {