node-minecraft-protocol/README.md

26 lines
771 B
Markdown
Raw Normal View History

2012-12-24 13:55:46 -05:00
# minecraft protocol
2013-01-01 21:02:07 -05:00
Parse and serialize minecraft packets, plus authentication and encryption.
2013-01-01 16:01:43 -05:00
## Features
2013-01-01 21:02:07 -05:00
* Parses all packets and emits `packet` events with packet fields as JavaScript
2013-01-01 16:01:43 -05:00
objects.
* Send a packet by supplying fields as a JavaScript object.
2013-01-01 21:02:07 -05:00
* Supports authenticating and logging in.
- Supports encryption enabled
- Supports encryption disabled (TODO #2)
- Supports online mode
- Supports offline mode (TODO #1)
* Send keep-alive packet at the correct interval.
2013-01-01 16:01:43 -05:00
* Reasonable amount of test coverage (TODO #3)
* Optimized for rapidly staying up to date with Minecraft protocol updates.
## Minecraft Compatibility
Supports Minecraft version 1.4.6
## Try it out so far
2013-01-01 16:01:43 -05:00
`MC_EMAIL=you@example.com MC_PASSWORD=your_pass node test.js`