AstralTransRocketries/node-minecraft-protocol
1
0
Fork 0
mirror of https://github.com/unmojang/node-minecraft-protocol.git synced 2025-09-28 05:35:56 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #182 from rom1504/add_info_about_options

Browse Source 
document options in mc.createClient(options)
This commit is contained in:
Robin Lambertz 2015-05-29 12:46:42 +02:00
commit 4752a0d759
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -173,9 +173,18 @@ The motd that is sent to the player when he is pinging the server
A base64 data string representing the favicon that will appear next to the server
on the mojang client's multiplayer list.
### mc.createClient(option)
### mc.createClient(options)
Returns a `Client` instance and perform login
Returns a `Client` instance and perform login.
`options` is an object containing the properties :
* username
* 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
* clientToken : generated if a password is given
* accessToken : generated if a password is given
* keepAlive : send keep alive packets : default to true
### Client