Skip to content

Commit

Permalink
docs: clarify playerInfo is only returned by modern query protocol
Browse files Browse the repository at this point in the history
  • Loading branch information
ayan4m1 committed Oct 21, 2024
1 parent 932a63e commit 8e148c8
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ If the server is online, the object will also contain the following properties:
| maxPlayers | `number` | The maximum number of players the server supports |
| playerInfo | `object[]` | An aray of { id, name } objects for each connected player |

**NOTE**: playerInfo is only populated if the server chooses to do so.
**NOTE**: playerInfo is only populated when using the modern query protocol and the server chooses to send it.

`fetchServerInfo` rejects if an error occurs during SRV record resolution.

Expand Down

0 comments on commit 8e148c8

Please sign in to comment.