From b99a319ef12af7cf7e644b56335b1695448e15f9 Mon Sep 17 00:00:00 2001 From: Andrew Kelley Date: Wed, 2 Jan 2013 01:47:18 -0500 Subject: [PATCH] add a new section to README --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index c2a95ab..caad4e5 100644 --- a/README.md +++ b/README.md @@ -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.