Tribufu/node-gamedig
1
0
Fork 0
mirror of https://github.com/Tribufu/node-gamedig synced 2026-08-10 07:31:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: rewrite migration document

Browse source
This commit is contained in:
CosminPerRam 2024-01-22 22:57:22 +02:00
parent f46580d1ad
commit 898037bf76
4 changed files with 153 additions and 156 deletions
Download patch file Download diff file Expand all files Collapse all files

4
CHANGELOG.md
View file

@ -6,9 +6,9 @@
* Made the library a `module`.
* Removed `GameResolver`, moved the `GameDig` class in a separate file.
* Modified exports, now the library exports `games` and `protocols` alongside the `GameDig` class.
* A game always has these fields: `name`, `release_year` and `options` (which always contains `port`/`port_query`/`port_query_offset` and `protocol`).
* Many game ids have changed, see the [migrate ids](MIGRATE_IDS.md) file for more info regarding this.
* A game always has these fields: `name`, `release_year` and `options` (which always contains `port`/`port_query`/`port_query_offset` and `protocol`) and could contain `extra.old_id`.
* `maxAttempts` has been renamed to `maxRetries`.
* Updated `games` with new naming system, with new option field `options.extra.old_id` with the older ID
#### Games
* Almost all games ids have been changed to follow a standard, see [CONTRIBUTING.md#naming](https://github.com/gamedig/node-gamedig/blob/5ae12dd494c927abcbe43352609d9aa34a54753c/CONTRIBUTING.md?plain=1#L27C3-L27C3).