Parker2991/node-minecraft-protocol
1
0
Fork 0
mirror of https://github.com/PrismarineJS/node-minecraft-protocol.git synced 2024-12-04 04:51:09 -05:00
Code Issues Projects Releases Packages Wiki Activity

Add documentation for forge/forgeMods options and forgeMods event

Browse source
This commit is contained in:
deathcap 2016-01-23 21:00:00 -08:00
parent c0271874d2
commit 92b6c3778b
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/README.md
View file

@ -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.