Forge client support (support integrating with node-minecraft-protocol-forge) #326

deathcap · 2016-01-23T21:03:36Z

Add client-side #114 Forge Support

Not included, out of scope for this PR:

Fully parse the RegistryData packets and emit registry events - would be nice but only needed for advanced usage, can come later
FORGE plugin channel (observed in packet logging, sends lava and water)
FML and FML|MP plugin channels (registered, but not seen that they are used at least at login)
Server-side Forge support Forge Support #114

http://wiki.vg/User:Pokechu22/Forge#Connection_to_a_forge_server

deathcap · 2016-01-23T21:13:19Z

Current status (testing against server: forge-1.8.9-11.15.0.1715 + mods/ironchest-1.8.9-6.0.121.768.jar):

node-minecraft-protocol $ NODE_DEBUG=mc-proto node examples/client_forge/client_forge.js localhost 25565
MC-PROTO: 19450 writing packet handshaking.set_protocol
MC-PROTO: 19450 { protocolVersion: 47,
  serverHost: 'localhost\u0000FML\u0000',
  serverPort: 25565,
  nextState: 2 }
MC-PROTO: 19450 writing packet login.login_start
MC-PROTO: 19450 { username: 'echo' }
connected
MC-PROTO: 19450 read packet login.compress
MC-PROTO: 19450 { threshold: 256 }
MC-PROTO: 19450 read packet login.success
MC-PROTO: 19450 { uuid: 'c39fa4c6-85a3-3582-8167-db3805dbe851',
  username: 'echo' }
MC-PROTO: 19450 read packet play.custom_payload
MC-PROTO: 19450 { channel: 'REGISTER',
  data: <Buffer 46 4d 4c 7c 48 53 00 46 4d 4c 00 46 4d 4c 7c 4d 50 00 46 4d 4c 00 46 4f 52 47 45> }
^ this buffer is "'FML|HS\x00FML\x00FML|MP\x00FML\x00FORGE'"
MC-PROTO: 19450 read packet play.custom_payload
MC-PROTO: 19450 { channel: 'FML|HS', data: <Buffer 00 02 00 00 00 00> }

No longer kicked, but need to handle the plugin channels and FML handshakes

…n>=2

This may not be strictly necessary, in either case Forge server with -Dfml.debugNetworkHandshake=true logs: [14:26:03] [Netty Server IO PrismarineJS#3/INFO] [FML]: Client protocol version 2

deathcap · 2016-01-23T23:04:34Z

Getting further, to the mod list exchange:

client_forge $ NODE_DEBUG=mc-proto node client_forge.js localhost 25565
MC-PROTO: 24794 writing packet handshaking.set_protocol
MC-PROTO: 24794 { protocolVersion: 47,
  serverHost: 'localhost\u0000FML\u0000',
  serverPort: 25565,
  nextState: 2 }
MC-PROTO: 24794 writing packet login.login_start
MC-PROTO: 24794 { username: 'echo' }
connected
MC-PROTO: 24794 read packet login.compress
MC-PROTO: 24794 { threshold: 256 }
MC-PROTO: 24794 read packet login.success
MC-PROTO: 24794 { uuid: 'c39fa4c6-85a3-3582-8167-db3805dbe851',
  username: 'echo' }
MC-PROTO: 24794 read packet play.custom_payload
MC-PROTO: 24794 { channel: 'REGISTER',
  data: <Buffer 46 4d 4c 7c 48 53 00 46 4d 4c 00 46 4d 4c 7c 4d 50 00 46 4f 52 47 45 00 46 4d 4c> }
Server-side registered channels: [ 'FML|HS', 'FML', 'FML|MP', 'FORGE', 'FML' ]
MC-PROTO: 24794 read packet play.custom_payload
MC-PROTO: 24794 { channel: 'FML|HS', data: <Buffer 00 02 00 00 00 00> }
FML|HS { data: 
   { discriminator: 0,
     fmlProtocolVersionServer: 2,
     overrideDimension: 0,
     fmlProtocolVersionClient: undefined,
     mods: undefined },
  metadata: { size: 6 },
  buffer: <Buffer 00 02 00 00 00 00> }
MC-PROTO: 24794 writing packet play.custom_payload
MC-PROTO: 24794 { channel: 'REGISTER',
  data: <Buffer 46 4d 4c 7c 48 53 00 46 4d 4c 00 46 4d 4c 7c 4d 50 00 46 4d 4c 00 46 4f 52 47 45> }
MC-PROTO: 24794 writing packet play.custom_payload
MC-PROTO: 24794 { channel: 'FML|HS', data: <Buffer 01 02> }
MC-PROTO: 24794 writing packet play.custom_payload
MC-PROTO: 24794 { channel: 'FML|HS', data: <Buffer 02 00> }
MC-PROTO: 24794 read packet play.kick_disconnect
MC-PROTO: 24794 { reason: '"Mod rejections [FMLMod:IronChest{6.0.121.768}]"' }

The mod list will likely need to come from the ServerListPing, since a client must match the server and does not really need to implement all of the mods (for most bots/scripts/clients expected as the use case of NMP). But if I send:

         mods: [
           {name:'IronChest', version:'6.0.121.768'}
         ]

get an error encoding the mods array:

/Users/admin/games/voxeljs/node-minecraft-protocol/node_modules/protodef/dist/protodef.js:157
        throw e;
        ^

Error: SizeOf error for mods.2.0.name : missing data type: string
    at ProtoDef.sizeOf (/Users/admin/games/voxeljs/node-minecraft-protocol/node_modules/protodef/dist/protodef.js:140:15)
    at /Users/admin/games/voxeljs/node-minecraft-protocol/node_modules/protodef/dist/datatypes/structures.js:153:21
    at tryCatch (/Users/admin/games/voxeljs/node-minecraft-protocol/node_modules/protodef/dist/utils.js:33:12)
    at tryDoc (/Users/admin/games/voxeljs/node-minecraft-protocol/node_modules/protodef/dist/utils.js:40:10)
    at /Users/admin/games/voxeljs/node-minecraft-protocol/node_modules/protodef/dist/datatypes/structures.js:152:19
    at Array.reduce (native)
    at ProtoDef.sizeOfContainer (/Users/admin/games/voxeljs/node-minecraft-protocol/node_modules/protodef/dist/datatypes/structures.js:148:23)
    at ProtoDef.sizeOf (/Users/admin/games/voxeljs/node-minecraft-protocol/node_modules/protodef/dist/protodef.js:143:33)
    at /Users/admin/games/voxeljs/node-minecraft-protocol/node_modules/protodef/dist/datatypes/structures.js:96:28
    at tryCatch (/Users/admin/games/voxeljs/node-minecraft-protocol/node_modules/protodef/dist/utils.js:33:12)

Fixes Error: SizeOf error for mods.2.0.name : missing data type: string

deathcap · 2016-01-23T23:20:05Z

Server ModList: [ { name: 'Forge', version: '11.15.0.1715' },
  { name: 'IronChest', version: '6.0.121.768' },
  { name: 'mcp', version: '9.18' },
  { name: 'FML', version: '8.0.99.99' } ]

rom1504 · 2016-01-23T23:37:26Z

examples/client_forge/client_forge.js

+        "type": "byte"
+      },
+
+      // ServerHello


(as I was saying in gitter), it might make more sense to use a big switch+ a mapper, like in https://github.com/PrismarineJS/prismarine-nbt/blob/master/nbt.json#L48 (or https://github.com/PrismarineJS/node-minecraft-protocol/blob/master/src/transforms/serializer.js#L21 )

mapper makes it possible for user to use the names (for example ServerHello instead of 0)

the big switch probably makes more sense because fields are distinct between each kind of "packet" here

agreed, that's what I wanted to do but couldn't figure out how, to do: investigate those references

deathcap · 2016-01-23T23:54:44Z

Server debug logging for reference: https://gist.github.com/deathcap/2c31e498b2375053c0e0

The handshake completes, but exits immediately after the FML handshake completes update: fixed, don't run your Forge server with -Dfml.debugNetworkHandshake=true; ~~maybe need to hook up the "handshake complete state" to node-minecraft-protocol's notion of handshake/login complete~~, and also general refactoring

deathcap · 2016-01-31T19:23:20Z

Moved tagHost \0FML\0 into the plugin. It is now enabled when forgeMods is set, in src/createClient.js, because it has to be set before setProtocol (since it is the plugin that sends the serverHost). With these changes, I believe this PR is ready.

Note: the tagHost option added to src/client/setProtocol.js could also be used for #336 BungeeCord protocol support

Note 2: the client_forge example demonstrates auto-negotiation, since that's the likely usage for Forge clients written with node-minecraft-protocol, but it could be refactored after #331 dynamic protocol support. Other enhancements/cleanup are possible, but I think this PR is good enough to pull at this point (pending any review feedback).

PrismarineJS/node-minecraft-protocol#326 Forge client support

rom1504 · 2016-02-01T09:09:14Z

Looks good to me, but I think it belongs in its own repo.

09:39 < rom1504> deathcap: https://github.com/PrismarineJS/node-minecraft-protocol/pull/326/files could be organized as https://github.com/andrewrk/mineflayer-navigate/ : forgeHandshake.js could be the index.js and client_forge.js could be the example.js
09:39 < rom1504> ah and if (options.forgeMods) forgeHandshake(client, options); should be in the client_forge.js / example.js imho

deathcap · 2016-02-03T06:10:00Z

Updated to fix conflicts with master but still needs to be moved into its own repo, re:gitter, agreed could be best served in a repository under the PrismarineJS organization in order to ease maintenance. src/client/forgeHandshake.js is easy to separate but will need to untangle the tagHost and autoVersion.

rom1504 · 2016-02-03T08:03:59Z

@deathcap you should now be able to create a repo in PrismarineJS for that forge plugin . (Or move https://github.com/deathcap/node-minecraft-protocol-forge but then I think you should first remove almost all the commits, it's a plugin, not a nmp fork)

deathcap · 2016-02-03T18:13:13Z

Cool thanks. Yeah https://github.com/deathcap/node-minecraft-protocol-forge branched from this repo (based on this PR) but I should probably rebase to remove the pre-Forge commits which were since removed as part of moving to a new module, or save the old branch and make a new one just with src/client/forgeHandshake.js

deathcap · 2016-02-03T18:16:54Z

src/client/autoVersion.js has a dependency on src/client/forgeHandshake.js, though. I suppose it could be modified to support "hooks" into the response modinfo, which forgeHandshake could register itself as a handler somehow (for response.modinfo.type === 'FML', install itself with forgeMods: response.info.modList).

rom1504 · 2016-02-03T18:35:39Z

Yes it would be better to remove that dependency somehow

deathcap · 2016-02-07T06:51:31Z

Well it's easy enough to remove the autoVersion/forgeHandshake dependency, but it would remove the feature :). The trickiness is in having the plugin add Forge support to autoVersion, without necessarily enabling it in the handshake. Maybe the node-Minecraft-protocol-forge module could expose two plugins (forgeHandshake and autoVersionForge?)

PrismarineJS/node-minecraft-protocol#326

Ref PrismarineJS#338 Move all the plugin-mutable options to client

deathcap · 2016-02-07T08:04:14Z

Alright I've rebased https://github.com/deathcap/node-minecraft-protocol-forge, and updated this PR so it now only contains the changes needed to support node-minecraft-protocol-forge rather than the code itself. To allow auto-versioning Forge plugins, added a new "auto version hook" feature, where plugins can add their own handlers for the auto-version ping response. autoVersionForge uses this to install itself with the right mods. Example usages of these two plugins:

var mc = require('minecraft-protocol');
var forgeHandshake = require('minecraft-protocol-forge').forgeHandshake;
var client = mc.createClient({
    host: host,
    port: port,
    username: username,
    password: password
});

forgeHandshake(client, {forgeMods: [
  { modid: 'mcp', version: '9.18' },
  { modid: 'FML', version: '8.0.99.99' },
  { modid: 'Forge', version: '11.15.0.1715' },
  { modid: 'IronChest', version: '6.0.121.768' }
]);

and:

var mc = require('minecraft-protocol');
var autoVersionForge = require('minecraft-protocol-forge').autoVersionForge;
var client = mc.createClient({
    version: false,
    host: host,
    port: port,
    username: username,
    password: password
});

autoVersionForge(client);

Not bad, imho. Open to other improvements but once these changes are in, will be able to publish node-minecraft-protocol-forge.

@rom1504

@deathcap you should now be able to create a repo in PrismarineJS for that forge plugin

OK I tried to create a new repo in PrismarineJS but am only offered:

can I just transfer https://github.com/deathcap/node-minecraft-protocol-forge to https://github.com/PrismarineJS/node-minecraft-protocol-forge? (there is a 'transfer' option in https://github.com/deathcap/node-minecraft-protocol-forge/settings but it is in the 'danger zone' so wanted to be sure)

rom1504 · 2016-02-07T08:14:02Z

Yeah just use transfer.

rom1504 · 2016-02-07T08:16:30Z

Looks good to me. Is this ready to merge ?

rom1504 · 2016-02-07T08:18:35Z

Oh and you probably got an invitation to join prismarinejs in your mail, looks like you didn't accept it yet.

deathcap · 2016-02-07T08:21:58Z

Yep ready to merge!

I'll check for the invite, won't let me transfer to PrismarineJS without it (says no rights)

update: transfer complete: https://github.com/PrismarineJS/node-minecraft-protocol-forge

Forge client support (support integrating with node-minecraft-protocol-forge)

deathcap added 3 commits January 23, 2016 13:04

Append \0\FML\0 to hostname in set_protocol packet if Forge enabled

6e50863

http://wiki.vg/User:Pokechu22/Forge#Connection_to_a_forge_server

Create client_forge example copied from client_echo

a660451

client_forge example: enable forge

bf04af2

deathcap force-pushed the forge branch from 4c089b4 to bf04af2 Compare January 23, 2016 21:04

deathcap added 10 commits January 23, 2016 13:40

Log registered plugin channels

1d8332e

Parse FML|HS discriminator byte using protodef

8018de5

Decode fmlProtocolVersion in ServerHello

09b4dc8

FML|HS: ServerHello: decode overrideDimension

8f1704b

FML|HS: ServerHello: overrideDimension only sent if fmlProtocolVersio…

9bb788b

…n>=2

FML|HS: encode ClientHello

8af797a

Send ClientHello response to ServerHello

e9159a4

Register client plugin channels on FML|HS ServerHello

2787adb

This may not be strictly necessary, in either case Forge server with -Dfml.debugNetworkHandshake=true logs: [14:26:03] [Netty Server IO PrismarineJS#3/INFO] [FML]: Client protocol version 2

FML|HS: ModList: send empty client modlist

cb9e6db

FML|HS ModList packet array

459da04

deathcap added 3 commits January 23, 2016 15:12

Add missing string type in FML|HS serializer

1f68b30

Fixes Error: SizeOf error for mods.2.0.name : missing data type: string

Hardcode a mod list for now

735b7f6

Show FML|HS ModList from server

790ba53

Send client HandshakeAck with WAITINGSERVERDATA

06f8a5f

rom1504 reviewed Jan 23, 2016
View reviewed changes

deathcap added 2 commits January 23, 2016 15:41

Complete the HandshakeAck exchange

e804717

FML|HS client sends HandshakeAck COMPLETE in response to server

30b347c

deathcap added 5 commits January 23, 2016 16:16

Add a mapper for FML|HS discrminator bytes

80cc68e

Use a mapper for symbolic subpacket names vs discriminator byte values

74c5b74

Switch on packet type through an anonymous container

b9bc0e1

fmlProtocolVersion client/server no longer collide

6a6bdff

ModList field uses 'modid' to match ServerPingList packet JSON

265fcd9

Set tagHost in src/client/forgeHandshake.js

70f1883

deathcap added a commit to deathcap/node-minecraft-protocols that referenced this pull request Feb 1, 2016

Merge branch 'forge'

b817dd9

PrismarineJS/node-minecraft-protocol#326 Forge client support

rom1504 mentioned this pull request Feb 2, 2016

much let, very const #337

Merged

deathcap added 2 commits February 2, 2016 21:58

Merge branch 'master' into forge

09ecdcf

Merge branch 'master' into forge

4468707

deathcap added 2 commits February 2, 2016 22:17

Integrate Forge support with auto-versioning support

9e9a5cb

Update var to const/let in forgeHandshake

1474044

deathcap added a commit to PrismarineJS/node-minecraft-protocol-forge that referenced this pull request Feb 7, 2016

Begin refactoring to FML|HS in a separate module

28cae51

PrismarineJS/node-minecraft-protocol#326

deathcap added 2 commits February 6, 2016 23:27

Move Forge-specific code to node-minecraft-protocol-forge

d059f23

Move tagHost from options to client object

9423a23

Ref PrismarineJS#338 Move all the plugin-mutable options to client

deathcap changed the title ~~Forge client support~~ Forge client support (support integrating with node-minecraft-protocol-forge) Feb 7, 2016

Remove unrelated change to client_echo

cc73c2d

deathcap force-pushed the forge branch from f5b1f64 to cc73c2d Compare February 7, 2016 08:08

autoVersion plugin: add hooks to allow Forge/FML to extend this plugin

dc9768e

deathcap mentioned this pull request Feb 7, 2016

Enable auto-version support including for Forge voxel/voxel-clientmc#24

Closed

rom1504 added a commit that referenced this pull request Feb 7, 2016

Merge pull request #326 from deathcap/forge

119d485

Forge client support (support integrating with node-minecraft-protocol-forge)

rom1504 merged commit 119d485 into PrismarineJS:master Feb 7, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Forge client support (support integrating with node-minecraft-protocol-forge) #326

Forge client support (support integrating with node-minecraft-protocol-forge) #326

deathcap commented Jan 23, 2016

deathcap commented Jan 23, 2016

deathcap commented Jan 23, 2016

deathcap commented Jan 23, 2016

rom1504 Jan 23, 2016

deathcap Jan 23, 2016

deathcap commented Jan 23, 2016

deathcap commented Jan 31, 2016

rom1504 commented Feb 1, 2016

deathcap commented Feb 3, 2016

rom1504 commented Feb 3, 2016

deathcap commented Feb 3, 2016

deathcap commented Feb 3, 2016

rom1504 commented Feb 3, 2016

deathcap commented Feb 7, 2016

deathcap commented Feb 7, 2016

rom1504 commented Feb 7, 2016

rom1504 commented Feb 7, 2016

rom1504 commented Feb 7, 2016

deathcap commented Feb 7, 2016

Forge client support (support integrating with node-minecraft-protocol-forge) #326

Forge client support (support integrating with node-minecraft-protocol-forge) #326

Conversation

deathcap commented Jan 23, 2016

deathcap commented Jan 23, 2016

deathcap commented Jan 23, 2016

deathcap commented Jan 23, 2016

rom1504 Jan 23, 2016

Choose a reason for hiding this comment

deathcap Jan 23, 2016

Choose a reason for hiding this comment

deathcap commented Jan 23, 2016

deathcap commented Jan 31, 2016

rom1504 commented Feb 1, 2016

deathcap commented Feb 3, 2016

rom1504 commented Feb 3, 2016

deathcap commented Feb 3, 2016

deathcap commented Feb 3, 2016

rom1504 commented Feb 3, 2016

deathcap commented Feb 7, 2016

deathcap commented Feb 7, 2016

rom1504 commented Feb 7, 2016

rom1504 commented Feb 7, 2016

rom1504 commented Feb 7, 2016

deathcap commented Feb 7, 2016