docs: update CHANGELOG and GAMES_LIST for Broke Protocol

RattleSN4K3 · Oct 12, 2024 · fb3410f · fb3410f
1 parent 922a902
commit fb3410f
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,7 @@
 * Feat: TOXIKK (2016) - Added support (#641)
 * Feat: Renegade X (2014) - Added support (#643)
 * Feat: Hawakening (2024) - Added support (#648)
+* Feat: BROKE PROTOCOL (2024) - Added support (#651)
 
 ## 5.1.3
 * Fix: `Deus Ex` using the wrong protocol (#621)

diff --git a/GAMES_LIST.md b/GAMES_LIST.md
@@ -53,6 +53,7 @@
 | breach               | Breach                                           | [Valve Protocol](#valve)                        |
 | breed                | Breed                                            |                                                 |
 | brink                | Brink                                            | [Valve Protocol](#valve)                        |
+| brokeprotocol        | BROKE PROTOCOL                                   | [Notes](#brokeprotocol)                         |
 | c2d                  | CS2D                                             |                                                 |
 | c3db                 | Commandos 3: Destination Berlin                  |                                                 |
 | cacr                 | Command and Conquer: Renegade                    |                                                 |
@@ -497,6 +498,14 @@ And one of the following options for gaining access:
 > **_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.
 
 
+### <a name='brokeprotocol'></a>BROKE PROTOCOL
+When querying a server on [BROKE PROTOCOL](https://brokeprotocol.com/), you have two options for querying the server:
+1. Passing the `address` and `port` request fields (or `--address` and `--port` when using the cli to the server).
+2. Setting the `serverId` request field or `--serverId` when using the cli to the publicId of the server.
+
+You can acquire a _ServerId_ from the master query protocol `protocol-brokeprotocolmaster` (see `raw.servers[].raw.id`).
+
+
 Protocols with Additional Notes
 ---
 

diff --git a/lib/games.js b/lib/games.js
@@ -457,6 +457,9 @@ export const games = {
     release_year: 2024,
     options: {
       protocol: 'brokeprotocol'
+    },
+    extra: {
+      doc_notes: 'brokeprotocol'
     }
   },
   basedefense: {