Parker2991/node-minecraft-protocol
1
0
Fork 0
mirror of https://github.com/PrismarineJS/node-minecraft-protocol.git synced 2024-11-14 19:04:59 -05:00
Code Issues Projects Releases Packages Wiki Activity

add a new section to README

Browse source
This commit is contained in:
Andrew Kelley 2013-01-02 01:47:18 -05:00
parent c2beb41fef
commit b99a319ef1
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -47,4 +47,15 @@ client.on('packet', function(packet) {
## Testing
* Ensure your system has the `java` executable in `PATH`.
* Download the appropriate version of `minecraft_server.jar`.
* `MC_SERVER_JAR=path/to/minecraft_server.jar MC_USERNAME=username MC_EMAIL=email@example.com MC_PASSWORD=password npm test`
## 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.