Robot/node-gamedig
1
0
Fork 0
mirror of https://github.com/gamedig/node-gamedig.git synced 2024-11-17 17:25:19 +01:00
Code Issues Projects Releases Packages Wiki Activity

chore: add EOS protocol note (#489)

Browse source 
* chore: add EOS notes

* Update CHANGELOG.md
This commit is contained in:
Pedro Ivo Hudson 2024-01-18 19:39:59 -03:00 committed by GitHub
parent 10718d917c
commit 68a3ad40d1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 16 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
CHANGELOG.md
View file

@ -45,6 +45,7 @@
placeholders in the `players` fields.
* Valve: dont skip players with no name and keep state.raw.players.
* Stabilized field `numplayers`.
* Add note about EOS Protocol not providing players data.
* V Rising (2022) - Updated `options.port_query_offset` to `[1, 15]` (#438).
* BeamMP (2021) - Added support.
* Xonotic (2011) - Added support.

17
GAMES_LIST.md
View file

@ -20,7 +20,7 @@
| armagetronadvanced | Armagetron Advanced | |
| armareforger | ARMA: Reforger | [Valve Protocol](#valve) |
| armaresistance | ARMA: Resistance | |
| asa | Ark: Survival Ascended | |
| asa | Ark: Survival Ascended | [EOS Protocol](#eos) |
| ase | Ark: Survival Evolved | [Valve Protocol](#valve) |
| asr08 | Arca Sim Racing '08 | |
| assettocorsa | Assetto Corsa | |
@ -445,12 +445,19 @@ Valheim servers will only respond to queries if they are started in public mode
### <a name="dayz"></a>DayZ
DayZ stores some of it's servers information inside the `tags` attribute. Make sure to set `requestRules: true` to access it. Some data inside `dayzMods` attribute may be fuzzy, due to how mods are loaded into the servers. Players can be fetched, but will not show ingame names. Alternatively, some servers may have a [third party tool](https://dayzsalauncher.com/#/tools) that you can use to get the mods information. If it's installed, you can access it via browser with the game servers IP:PORT, but add up 10 to the port. (eg. if game port is 2302 then use 2312).
### <a name="valve"></a>Valve Protocol
For many valve games, additional 'rules' may be fetched into the unstable `raw` field by passing the additional
option: `requestRules: true`. Beware that this may increase query time.
### <a name="thefront"></a>The Front
Responses with wrong `name` (gives out a steamid instead of the server name) and `maxplayers` (always 200, whatever the config would be) field values.
### <a name="conanexiles">Conan Exiles
Conan Exiles never responds to player query.
Protocols with Additional Notes
---
### <a name="valve"></a>Valve Protocol
For many valve games, additional 'rules' may be fetched into the unstable `raw` field by passing the additional
option: `requestRules: true`. Beware that this may increase query time.
### <a name="eos"></a>Epic Online Services (EOS) Protocol
EOS does not provide players data.

3
tools/generate_games_list.js
View file

@ -34,6 +34,9 @@ for (const id in sortedGames) {
if (game.options.protocol === 'valve' || game.options.protocol === 'dayz') {
notes.push('[Valve Protocol](#valve)')
}
if (game.options.protocol === 'epic' || game.options.protocol === 'asa') {
notes.push('[EOS Protocol](#epic)')
}
if (notes.length) {
generated += ' | ' + notes.join(', ')
}