Parker2991/node-minecraft-protocol
1
0
Fork 0
mirror of https://github.com/PrismarineJS/node-minecraft-protocol.git synced 2024-11-15 03:14:56 -05:00
Code Issues Projects Releases Packages Wiki Activity

add auth and session server to doc

Browse source
This commit is contained in:
Romain Beaumont 2020-08-03 01:48:23 +02:00
parent ec4501bf4c
commit edece010bb
No known key found for this signature in database
GPG key ID: DB60E388B3BCF286
1 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/API.md
View file

@ -77,6 +77,8 @@ Returns a `Client` instance and perform login.
* host : default to localhost * host : default to localhost
* clientToken : generated if a password is given * clientToken : generated if a password is given
* accessToken : generated if a password is given * accessToken : generated if a password is given
* authServer : auth server, default to https://authserver.mojang.com
* sessionServer : session server, default to https://sessionserver.mojang.com
* keepAlive : send keep alive packets : default to true * keepAlive : send keep alive packets : default to true
* closeTimeout : end the connection after this delay in milliseconds if server doesn't answer to ping, default to `120*1000` * closeTimeout : end the connection after this delay in milliseconds if server doesn't answer to ping, default to `120*1000`
* checkTimeoutInterval : default to `30*1000` (30s), check if keepalive received at that period, disconnect otherwise. * checkTimeoutInterval : default to `30*1000` (30s), check if keepalive received at that period, disconnect otherwise.