mirror of
https://github.com/unmojang/node-minecraft-protocol.git
synced 2025-09-27 21:24:25 -04:00
update README
This commit is contained in:
parent
1979ef3848
commit
6333fbd893
17
README.md
17
README.md
@ -1,19 +1,18 @@
|
|||||||
# minecraft protocol
|
# minecraft protocol
|
||||||
|
|
||||||
Parse minecraft
|
Parse and serialize minecraft packets, plus authentication and encryption.
|
||||||
This project simply provides protocol support. You'll want to use a higher
|
|
||||||
level library to write bots.
|
|
||||||
|
|
||||||
Hopefully eventually we can merge
|
|
||||||
[mineflayer](https://github.com/superjoe30/mineflayer) with this project.
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
* (TODO #8) Parse all packets and emit `packet` events with packet fields as JavaScript
|
* Parses all packets and emits `packet` 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.
|
||||||
* (TODO #9) Send keep-alive packet at the correct interval.
|
* Supports authenticating and logging in.
|
||||||
* Supports encryption, no encryption (TODO #2), online, and offline (TODO #1) modes.
|
- Supports encryption enabled
|
||||||
|
- Supports encryption disabled (TODO #2)
|
||||||
|
- Supports online mode
|
||||||
|
- Supports offline mode (TODO #1)
|
||||||
|
* Send keep-alive packet at the correct interval.
|
||||||
* Reasonable amount of test coverage (TODO #3)
|
* Reasonable amount of test coverage (TODO #3)
|
||||||
* Optimized for rapidly staying up to date with Minecraft protocol updates.
|
* Optimized for rapidly staying up to date with Minecraft protocol updates.
|
||||||
|
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "minecraft-protocol",
|
"name": "minecraft-protocol",
|
||||||
"version": "0.0.0",
|
"version": "0.0.0",
|
||||||
"description": "minecraft protocol",
|
"description": "Parse and serialize minecraft packets, plus authentication and encryption.",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "mocha"
|
"test": "mocha"
|
||||||
|
Loading…
x
Reference in New Issue
Block a user