docs: update CHANGELOG and GAMES_LIST for Hawakening

RattleSN4K3 · Oct 4, 2024 · 55b9a9b · 55b9a9b
1 parent eba1b6a
commit 55b9a9b
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,7 @@
 * Feat: Satisfactory - Added support (By @Smidy13 #645)
 * Feat: Update Soldat protocol (#642)
 * Feat: TOXIKK (2016) - Added support (#641)
+* Feat: Hawakening (2024) - Added support ()
 
 ## 5.1.3
 * Fix: `Deus Ex` using the wrong protocol (#621)

diff --git a/GAMES_LIST.md b/GAMES_LIST.md
@@ -150,6 +150,7 @@
 | gus                  | Gore: Ultimate Soldier                           |                                                 |
 | halo                 | Halo                                             |                                                 |
 | halo2                | Halo 2                                           |                                                 |
+| hawakening           | Hawakening                                       | [Notes](#hawakening)                            |
 | heretic2             | Heretic II                                       |                                                 |
 | hexen2               | Hexen II                                         |                                                 |
 | hiddendangerous2     | Hidden & Dangerous 2                             |                                                 |
@@ -479,6 +480,22 @@ If you know your use case, it's better to use a single protocol or make your own
 Farming Simulator servers need a token (reffered as code in the game). It can be obtained at your server's web interface (http://ip:port/settings.html). It can be passed to GameDig with the additional option: `token`. It does only work for your own server.
 The response includes much information about the server. Currently, only the fields about server information (name, map, version, etc.), players and mods are parsed.
 
+
+### <a name='hawakening'></a>Hawakening
+Querying server info for Hawakening requires a _ServerId_ to be passed to GameDig instead of an IP address. You can acquire such a _ServerId_ from the master query protocol `protocol-hawakening` (see `raw.listing.Guid`).
+
+Additionally, the master server requires authorization. A **user profile is required** for querying the API. Such a profile can be created on the [_official page_](https://hawakening.com/enlist).
+
+- Provide a Server Id via `serverId`
+- Provide a client profile with `username` (email address, not callsign)
+
+And one of the following options for gaining access:  
+- Provide a client access token via the option `token`
+- Provide the user profile password via the option `password`
+
+> **_NOTE:_** The protocol `hawakening` will query additional server info by requesting a matchmaking _token_, which will fail for full servers. Due to this, the IP address and port cannot be queried for such servers.
+
+
 Protocols with Additional Notes
 ---
 

diff --git a/lib/games.js b/lib/games.js
@@ -1464,6 +1464,9 @@ export const games = {
       port: 7777,
       port_query: 27015,
       protocol: 'hawakening'
+    },
+    extra: {
+      doc_notes: 'hawakening'
     }
   },
   heretic2: {