From 92b6c3778bce57103f97021b581a9d243dea03e9 Mon Sep 17 00:00:00 2001 From: deathcap Date: Sat, 23 Jan 2016 21:00:00 -0800 Subject: [PATCH] Add documentation for forge/forgeMods options and forgeMods event --- doc/README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/README.md b/doc/README.md index daca5a1..bb60825 100644 --- a/doc/README.md +++ b/doc/README.md @@ -69,6 +69,8 @@ Returns a `Client` instance and perform login. * port : default to 25565 * password : can be omitted (if the tokens are also omitted then it tries to connect in offline mode) * host : default to localhost + * forge : if true, will attempt to negotiate a FML/Forge handshake + * forgeMods : array of objects with `modid` and `version` properties for the Forge mods the client supports * clientToken : generated if a password is given * accessToken : generated if a password is given * keepAlive : send keep alive packets : default to true @@ -131,6 +133,11 @@ and the packet metadata (name, state) Called when the protocol changes state. Takes the new state and old state as parameters. +### `forgeMods` event + +Called when the client receives the server's `ModList`, when connecting to an +FML/Forge server. + ### per-packet events Check out the [minecraft-data docs](https://prismarinejs.github.io/minecraft-data/?v=1.8&d=protocol) to know the event names and data field names.