mirror of
https://github.com/unmojang/node-minecraft-protocol.git
synced 2025-09-27 21:24:25 -04:00
expose constants; update README
This commit is contained in:
parent
3e7501b215
commit
b9bea65e50
15
README.md
15
README.md
@ -4,6 +4,7 @@ Parse and serialize minecraft packets, plus authentication and encryption.
|
||||
|
||||
## Features
|
||||
|
||||
* Supports Minecraft version 1.4.7pre
|
||||
* Parses all packets and emits events with packet fields as JavaScript
|
||||
objects.
|
||||
* 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.
|
||||
* Optimized for rapidly staying up to date with Minecraft protocol updates.
|
||||
|
||||
## Minecraft Compatibility
|
||||
|
||||
Supports Minecraft version 1.4.7pre
|
||||
|
||||
## Usage
|
||||
|
||||
### Echo client example
|
||||
@ -107,13 +104,3 @@ server.on('login', function(client) {
|
||||
|
||||
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.
|
||||
|
Loading…
x
Reference in New Issue
Block a user