Merge remote-tracking branch 'upstream/master'

Author: Scarsz

.github/workflows/ci.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        mcVersion: ['1.7', '1.8', '1.9', '1.10', '1.11.2', '1.12.2', '1.13.2', '1.14.4', '1.15.2', '1.16.5', '1.17']
+        mcVersion: ['1.7', '1.8', '1.9', '1.10', '1.11.2', '1.12.2', '1.13.2', '1.14.4', '1.15.2', '1.16.5', '1.17', '1.17.1', '1.18']
 
     steps:
     - uses: actions/checkout@v2
@@ -24,7 +24,7 @@ jobs:
     - name: Setup Java JDK
       uses: actions/[email protected]
       with:
-        java-version: '16'
+        java-version: '17'
         distribution: 'adopt'
     - name: Install dependencies
       run: npm install

docs/API.md

@@ -104,11 +104,13 @@ Returns a `Client` instance and perform login.
  * connect : a function taking the client as parameter and that should client.setSocket(socket) 
  and client.emit('connect') when appropriate (see the proxy examples for an example of use)
  * agent : a http agent that can be used to set proxy settings for yggdrasil authentication (see proxy-agent on npm) 
+ * fakeHost : (optional) hostname to send to the server in the set_protocol packet
  * profilesFolder : optional
    * (mojang account) the path to the folder that contains your `launcher_profiles.json`. defaults to your minecraft folder if it exists, otherwise the local directory. set to `false` to disable managing profiles 
    * (microsoft account) the path to store authentication caches, defaults to .minecraft
  * onMsaCode(data) : (optional) callback called when signing in with a microsoft account
  with device code auth. `data` is an object documented [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-device-code#device-authorization-response)
+ * id : a numeric client id used for referring to multiple clients in a server
 
 
 ## mc.Client(isServer,version,[customPackets])
@@ -120,13 +122,37 @@ Takes a minecraft `version` as second argument.
 
 write a packet
 
+### client.writeRaw(buffer)
+
+write a raw buffer as a packet
+
 ### client.end(reason, fullReason)
 
 Ends the connection with `reason` or `fullReason`
 If `fullReason` is not defined, then the `reason` will be used.
 
 `fullReason` is a JSON object, which represents [chat](https://wiki.vg/Chat) message.
 
+### client.connect(port, host)
+
+Used by the [Client Class](https://github.com/PrismarineJS/node-minecraft-protocol/blob/d9d01c8be4921bb38e7b59d9c18afd771615ba22/src/client.js) to connect to a server, done by createClient automatically
+
+### client.setSocket(socket)
+
+Sets the client's connection socket.
+
+### client.registerChannel(name, typeDefinition, custom)
+
+Registers a plugin channel with the given `name` and protodef `typeDefinition`
+
+### client.unregisterChannel(name)
+
+Unregisters a plugin channel.
+
+### client.writeChannel(channel, params)
+
+Write to [Plugin Channels](https://wiki.vg/Plugin_channels)
+
 ### client.state
 
 The internal state that is used to figure out which protocol state we are in during
@@ -137,7 +163,6 @@ packet parsing. This is one of the protocol.states.
 True if this is a connection going from the server to the client,
 False if it is a connection from client to server.
 
-
 ### client.socket
 
 Returns the internal nodejs Socket used to communicate with this client.
@@ -163,24 +188,47 @@ The player's profile, as returned by the Yggdrasil system. (only server-side)
 
 The latency of the client, in ms. Updated at each keep alive.
 
+### client.customPackets
+
+An object index by version/state/direction/name, see client_custom_packet for an example
+
+### client.protocolVersion
+
+The client's protocol version
+
+### client.version
+
+The client's version
+
 ### `packet` event
 
-Called with every packet parsed. Takes three params, the JSON data we parsed,
-, the packet metadata (name, state) and the initial buffer
+Called with every packet parsed. Takes four paramaters, the JSON data we parsed, the packet metadata (name, state), the buffer (raw data) and the full buffer (includes surplus data and may include the data of following packets on versions below 1.8) 
 
 ### `raw` event
 
 Called with every packet, but as a buffer. Takes two params, the buffer
 and the packet metadata (name, state)
 
+### `connect` event
+
+when the socket connects to the server, this is emitted
+
+### `end` event
+
+Called when the client's connection is disconnected. Takes the reason as parameter
+
+### `session` event
+
+Called when user authentication is resolved. Takes session data as parameter.
+
 ### `state` event
 
 Called when the protocol changes state. Takes the new state and old state as
 parameters.
 
-### `session` event
+### `error` event
 
-Called when user authentication is resolved. Takes session data as parameter.
+Called when an error occurs within the client. Takes an Error as parameter.
 
 ### per-packet events
 
@@ -228,9 +276,9 @@ correct data type. You can figure out the types [here](http://wiki.vg/Entities#E
 ## mc.ping(options, callback)
 
 `options` is an object containing the following:
-* host : default too locahost
-* port : default too 25565
-* version: default too most recent version
+* host : default to localhost
+* port : default to 25565
+* version: default to most recent version
 
 Ping a minecraft server and return a promise or use an optional callback containing the information about it
 

docs/HISTORY.md

@@ -1,5 +1,69 @@
 # History
 
+## 1.29.0
+
+* 1.18.0 support
+
+## 1.28.1
+
+* Fix microsoft auth error condition handling (@extremeheat)
+
+## 1.28.0
+
+* Fixed TypeScript error TS2769 when authenticating with mojang (#922) (@liquiddevelopmentnet)
+* Update prismarine-auth usage (#923) (@extremeheat)
+* types(Client): fix events (#918) (@muchnameless and Robert Hartmann)  
+* add default for authTitle (#920) (@U5B)
+* Update ping function return type and make callback optional (#909) (@ShayBox)
+* Fixed typo's (#915) (@OscarNOW)
+* Add the ability to send a fake hostname in set_protocol (#913) (@GhqstMC and u9g)
+
+## 1.27.2
+
+* try again to enable prismarine-auth
+
+## 1.27.1
+
+* revert prismarine-auth usage for now (see https://github.com/panva/jose/issues/307)
+
+## 1.27.0
+
+* use prismarine-auth
+
+## 1.26.6
+
+* Lazily generate serverKey
+* Make all events have promiselike returns for async
+
+## 1.26.5
+
+* update Online Mode Exceptions
+
+## 1.26.4
+
+* add once to typescript types for all events
+
+## 1.26.3
+
+* fix typescript types
+
+## 1.26.2
+
+* fix typescript types
+
+## 1.26.1
+
+* temporarily revert prismarine-auth
+
+## 1.26.0
+
+* move microsoft auth to prismarine-auth (@Kashalls)
+* Add beforeLogin function option on server (@rob9315)
+* Make cache path creation recursive (@DecentralisedTech)
+* Mc.ping return a promise and use callbacks (@AngeryFrog)
+* Add a way to encode a packet only once and send it to multiple clients (@GroobleDierne)
+* launcher_accounts.json account corruption fix (@Moondarker)
+
 ## 1.25.0
 
 * add fullBuffer to packet event

docs/README.md

@@ -13,7 +13,7 @@ Parse and serialize minecraft packets, plus authentication and encryption.
 
  * Supports Minecraft PC version 1.7.10, 1.8.8, 1.9 (15w40b, 1.9, 1.9.1-pre2, 1.9.2, 1.9.4),
   1.10 (16w20a, 1.10-pre1, 1.10, 1.10.1, 1.10.2), 1.11 (16w35a, 1.11, 1.11.2), 1.12 (17w15a, 17w18b, 1.12-pre4, 1.12, 1.12.1, 1.12.2), and 1.13 (17w50a, 1.13, 1.13.1, 1.13.2-pre1, 1.13.2-pre2, 1.13.2), 1.14 (1.14, 1.14.1, 1.14.3, 1.14.4)
-  , 1.15 (1.15, 1.15.1, 1.15.2) and 1.16 (20w13b, 20w14a, 1.16-rc1, 1.16, 1.16.1, 1.16.2, 1.16.3, 1.16.4), 1.17 (21w07a, 1.17)
+  , 1.15 (1.15, 1.15.1, 1.15.2) and 1.16 (20w13b, 20w14a, 1.16-rc1, 1.16, 1.16.1, 1.16.2, 1.16.3, 1.16.4), 1.17 (21w07a, 1.17, 1.17.1), 1.18
  * Parses all packets and emits events with packet fields as JavaScript
    objects.
  * Send a packet by supplying fields as a JavaScript object.
@@ -44,15 +44,27 @@ node-minecraft-protocol is pluggable.
 
 ## Projects Using node-minecraft-protocol
 
- * [mineflayer](https://github.com/PrismarineJS/mineflayer/) - create minecraft
+ * [mineflayer](https://github.com/PrismarineJS/mineflayer/) - Create minecraft
    bots with a stable, high level API.
- * [mcserve](https://github.com/andrewrk/mcserve) - runs and monitors your
+ * [mcserve](https://github.com/andrewrk/mcserve) - Runs and monitors your
    minecraft server, provides real-time web interface, allow your users to
    create bots.
- * [flying-squid](https://github.com/PrismarineJS/flying-squid) create minecraft
+ * [flying-squid](https://github.com/PrismarineJS/flying-squid) - Create minecraft
    servers with a high level API, also a minecraft server by itself.
- * [pakkit](https://github.com/Heath123/pakkit) To monitor your packets
- * [minecraft-packet-debugger](https://github.com/wvffle/minecraft-packet-debugger) to easily debug your minecraft packets
+ * [pakkit](https://github.com/Heath123/pakkit) - A GUI tool to monitor Minecraft packets in real time, allowing you to view their data and interactively edit and resend them
+ * [minecraft-packet-debugger](https://github.com/wvffle/minecraft-packet-debugger) - A tool to capture Minecraft packets in a buffer then view them in a browser
+ * [aresrpg](https://github.com/aresrpg/aresrpg) - An open-source mmorpg minecraft server
+ * and [several thousands others](https://github.com/PrismarineJS/node-minecraft-protocol/network/dependents?package_id=UGFja2FnZS0xODEzMDk0OQ%3D%3D)
+
+## Installation
+
+`npm install minecraft-protocol`
+
+## Documentation
+
+* [API doc](API.md)
+* [faq](FAQ.md)
+* [protocol doc](https://minecraft-data.prismarine.js.org/?d=protocol) and [wiki.vg/Protocol](https://wiki.vg/Protocol)
 
 ## Usage
 
@@ -135,16 +147,6 @@ server.on('login', function(client) {
 });
 ```
 
-## Installation
-
-`npm install minecraft-protocol`
-
-## Documentation
-
-See [doc](API.md)
-See [faq](FAQ.md)
-
-
 ## Testing
 
 * Ensure your system has the `java` executable in `PATH`.

examples/client_electron/package.json

@@ -8,7 +8,7 @@
     "start": "electron ."
   },
   "dependencies": {
-    "electron": "^9.1.2",
+    "electron": "^11.5.0",
     "electron-reload": "^1.5.0"
   }
 }

examples/client_microsoft_auth/client_microsoft_auth.js

@@ -2,16 +2,17 @@
 
 const mc = require('minecraft-protocol')
 
-if (process.argv.length < 4 || process.argv.length > 6) {
-  console.log('Usage : node echo.js <host> <port> [<email>] [<password>]')
+const [,, host, port, userOrEmail, password] = process.argv
+if (!userOrEmail) {
+  console.log('Usage : node client_microsoft_auth.js <host> <port> <username/email> [<password>]')
   process.exit(1)
 }
 
 const client = mc.createClient({
-  host: process.argv[2],
-  port: parseInt(process.argv[3]),
-  username: process.argv[4], // your microsoft account email
-  password: process.argv[5], // your microsoft account password
+  host,
+  port: parseInt(port),
+  username: userOrEmail, // your microsoft account email
+  password: password, // your microsoft account password
   auth: 'microsoft' // This option must be present and set to 'microsoft' to use Microsoft Account Authentication. Failure to do so will result in yggdrasil throwing invalid account information.
 })
 

examples/server/server.js

@@ -26,7 +26,7 @@ server.on('login', function (client) {
     entityId: client.id,
     isHardcore: false,
     gameMode: 0,
-    previousGameMode: 255,
+    previousGameMode: 1,
     worldNames: loginPacket.worldNames,
     dimensionCodec: loginPacket.dimensionCodec,
     dimension: loginPacket.dimension,

examples/server_channel/server_channel.js

@@ -18,7 +18,7 @@ server.on('login', function (client) {
     entityId: client.id,
     isHardcore: false,
     gameMode: 0,
-    previousGameMode: 255,
+    previousGameMode: 1,
     worldNames: loginPacket.worldNames,
     dimensionCodec: loginPacket.dimensionCodec,
     dimension: loginPacket.dimension,

examples/server_custom_channel/server_custom_channel.js

@@ -15,7 +15,7 @@ server.on('login', function (client) {
     entityId: client.id,
     isHardcore: false,
     gameMode: 0,
-    previousGameMode: 255,
+    previousGameMode: 1,
     worldNames: loginPacket.worldNames,
     dimensionCodec: loginPacket.dimensionCodec,
     dimension: loginPacket.dimension,

examples/server_helloworld/server_helloworld.js

@@ -26,7 +26,7 @@ server.on('login', function (client) {
     entityId: client.id,
     isHardcore: false,
     gameMode: 0,
-    previousGameMode: 255,
+    previousGameMode: 1,
     worldNames: loginPacket.worldNames,
     dimensionCodec: loginPacket.dimensionCodec,
     dimension: loginPacket.dimension,