Skip to content

Commit

Permalink
docs: note on the readme that the reported players array length could…
Browse files Browse the repository at this point in the history
… be different lenght compared to the reported numplayers field
  • Loading branch information
CosminPerRam committed Nov 12, 2023
1 parent c56a057 commit e31da4d
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,9 @@ The returned state object will contain the following keys:
* **password**: boolean - If a password is required
* **numplayers**: number
* **maxplayers**: number
* **players**: array of objects
* **players**: array of objects - note that this could be of a different length compared to **numplayers**
* **name**: string - If the player's name is unknown, the string will be empty.
* **raw**: object - Additional information about the player if available (**unstable**).
* **raw**: object - Additional information about the player if available.
* **bots**: array of objects - Same schema as `players`
* **connect**: string
* This will typically include the game's `ip:port`
Expand All @@ -71,7 +71,7 @@ The returned state object will contain the following keys:
* Note that this is not the RTT of an ICMP echo, as ICMP packets are often blocked by NATs and node
has poor support for raw sockets.
* This value is derived from the RTT of one of the query packets, which is usually quite accurate, but may add a bit due to server lag.
* **raw**: freeform object (**unstable**)
* **raw**: object
* Contains all information received from the server in a disorganized format.

Note that `raw` (or **unstable**) objects contents MAY change on a per-protocol basis between GameDig patch releases (although not typical).
Expand Down

0 comments on commit e31da4d

Please sign in to comment.