Merge branch 'ArchipelagoMW:main' into Satisfactory_ToBeVerified

docs/contributing.md

@@ -16,7 +16,7 @@ game contributions:
 * **Do not introduce unit test failures/regressions.**
   Archipelago supports multiple versions of Python. You may need to download older Python versions to fully test
   your changes. Currently, the oldest supported version
-  is [Python 3.10](https://www.python.org/downloads/release/python-31015/).
+  is [Python 3.11](https://www.python.org/downloads/release/python-31113/).
   It is recommended that automated github actions are turned on in your fork to have github run unit tests after
   pushing.
   You can turn them on here:  

docs/options api.md

@@ -344,7 +344,7 @@ names, and `def can_place_boss`, which passes a boss and location, allowing you
 your game. When this function is called, `bosses`, `locations`, and the passed strings will all be lowercase. There is
 also a `duplicate_bosses` attribute allowing you to define if a boss can be placed multiple times in your world. False
 by default, and will reject duplicate boss names from the user. For an example of using this class, refer to
-`worlds.alttp.options.py`
+`worlds/alttp/Options.py`
 
 ### OptionDict
 This option returns a dictionary. Setting a default here is recommended as it will output the dictionary to the

docs/running from source.md

@@ -7,7 +7,7 @@ use that version. These steps are for developers or platforms without compiled r
 ## General
 
 What you'll need:
- * [Python 3.10.11 or newer](https://www.python.org/downloads/), not the Windows Store version
+ * [Python 3.11.9 or newer](https://www.python.org/downloads/), not the Windows Store version
    * On Windows, please consider only using the latest supported version in production environments since security
      updates for older versions are not easily available.
    * Python 3.12.x is currently the newest supported version

docs/webhost api.md

@@ -16,6 +16,8 @@ Current endpoints:
     - [`/status/<suuid:seed>`](#status)
 - Room API
     - [`/room_status/<suuid:room_id>`](#roomstatus)
+- Tracker API
+    - [`/tracker/<suuid:tracker>`](#tracker)
 - User API
     - [`/get_rooms`](#getrooms)
     - [`/get_seeds`](#getseeds)
@@ -244,6 +246,214 @@ Example:
 }
 ```
 
+## Tracker Endpoints
+Endpoints to fetch information regarding players of an active WebHost room with the supplied tracker_ID. The tracker ID
+can either be viewed while on a room tracker page, or from the [room's endpoint](#room-endpoints).
+
+### `/tracker/<suuid:tracker>`
+<a name=tracker></a>
+Will provide a dict of tracker data with the following keys:
+
+- item_link groups and their players (`groups`)
+- Each player's slot_data (`slot_data`)
+- Each player's current alias (`aliases`)
+  - Will return the name if there is none
+- A list of items each player has received as a NetworkItem (`player_items_received`)
+- A list of checks done by each player as a list of the location id's (`player_checks_done`)
+- The total number of checks done by all players (`total_checks_done`)
+- Hints that players have used or received (`hints`)
+- The time of last activity of each player in RFC 1123 format (`activity_timers`)
+- The time of last active connection of each player in RFC 1123 format (`connection_timers`)
+- The current client status of each player (`player_status`)
+- The datapackage hash for each player (`datapackage`)
+  - This hash can then be sent to the datapackage API to receive the appropriate datapackage as necessary
+
+
+Example:
+```json
+{
+  "groups": [
+    {
+      "team": 0,
+      "groups": [
+        {
+          "slot": 5,
+          "name": "testGroup",
+          "members": [
+            1,
+            2
+          ]
+        },
+        {
+          "slot": 6,
+          "name": "myCoolLink",
+          "members": [
+            3,
+            4
+          ]
+        }
+      ]
+    }
+  ],
+  "slot_data": [
+    {
+      "team": 0,
+      "players": [
+        {
+          "player": 1,
+          "slot_data": {
+            "example_option": 1,
+            "other_option": 3
+          }
+        },
+        {
+          "player": 2,
+          "slot_data": {
+            "example_option": 1,
+            "other_option": 2
+          }
+        }
+      ]
+    }
+  ],
+  "aliases": [
+    {
+      "team": 0,
+      "players": [
+        {
+          "player": 1,
+          "alias": "Incompetence"
+        },
+        {
+          "player": 2,
+          "alias": "Slot_Name_2"
+        }
+      ]
+    }
+  ],
+  "player_items_received": [
+    {
+      "team": 0,
+      "players": [
+        {
+          "player": 1,
+          "items": [
+            [1, 1, 1, 0],
+            [2, 2, 2, 1]
+          ]
+        },
+        {
+          "player": 2,
+          "items": [
+            [1, 1, 1, 2],
+            [2, 2, 2, 0]
+          ]
+        }
+      ]
+    }
+  ],
+  "player_checks_done": [
+    {
+      "team": 0,
+      "players": [
+        {
+          "player": 1,
+          "locations": [
+            1,
+            2
+          ]
+        },
+        {
+          "player": 2,
+          "locations": [
+            1,
+            2
+          ]
+        }
+      ]
+    }
+  ],
+  "total_checks_done": [
+    {
+      "team": 0,
+      "checks_done": 4
+    }
+  ],
+  "hints": [
+    {
+      "team": 0,
+      "players": [
+        {
+          "player": 1,
+          "hints": [
+            [1, 2, 4, 6, 0, "", 4, 0]
+          ]
+        },
+        {
+          "player": 2,
+          "hints": []
+        }
+      ]
+    }
+  ],
+  "activity_timers": [
+    {
+      "team": 0,
+      "players": [
+        {
+          "player": 1,
+          "time": "Fri, 18 Apr 2025 20:35:45 GMT"
+        },
+        {
+          "player": 2,
+          "time": "Fri, 18 Apr 2025 20:42:46 GMT"
+        }
+      ]
+    }
+  ],
+  "connection_timers": [
+    {
+      "team": 0,
+      "players": [
+        {
+          "player": 1,
+          "time": "Fri, 18 Apr 2025 20:38:25 GMT"
+        },
+        {
+          "player": 2,
+          "time": "Fri, 18 Apr 2025 21:03:00 GMT"
+        }
+      ]
+    }
+  ],
+  "player_status": [
+    {
+      "team": 0,
+      "players": [
+        {
+          "player": 1,
+          "status": 0
+        },
+        {
+          "player": 2,
+          "status": 0
+        }
+      ]
+    }
+  ],
+  "datapackage": {
+    "Archipelago": {
+      "checksum": "ac9141e9ad0318df2fa27da5f20c50a842afeecb",
+      "version": 0
+    },
+    "The Messenger": {
+      "checksum": "6991cbcda7316b65bcb072667f3ee4c4cae71c0b",
+      "version": 0
+    }
+  }
+}
+```
+
 ## User Endpoints
 User endpoints can get room and seed details from the current session tokens (cookies)
 

docs/world api.md

@@ -257,6 +257,14 @@ another flag like "progression", it means "an especially useful progression item
   combined with `progression`; see below)
 * `progression_skip_balancing`: the combination of `progression` and `skip_balancing`, i.e., a progression item that
   will not be moved around by progression balancing; used, e.g., for currency or tokens, to not flood early spheres
+* `deprioritized`: denotes that an item should not be placed on priority locations
+  (to be combined with `progression`; see below)
+* `progression_deprioritized`: the combination of `progression` and `deprioritized`, i.e. a progression item that
+  should not be placed on priority locations, despite being progression;
+  like skip_balancing, this is commonly used for currency or tokens.
+* `progression_deprioritized_skip_balancing`: the combination of `progression`, `deprioritized` and `skip_balancing`.
+  Since there is overlap between the kind of items that want `skip_balancing` and `deprioritized`,
+  this combined classification exists for convenience
 
 ### Regions