Merge pull request #46 from ManualForArchipelago/deathlink

Deathlink button!

Author: FuzzyGamesOn

docs/making/game.md

@@ -3,7 +3,7 @@
 Game.json contains the most fundamental details about your Manual Game, the details about the game itself.
 
 At its most basic, it needs the name of the game, and name of the creator (you).
-It also contains the name of the auto-generated filler item, and details about Starting Inventory (see below for more details)
+It also contains the name of the auto-generated filler item, and details about [Starting Inventory](#starting-inventory) and whether [Deathlink](#death-link) is enabled.
 
 ```json
 {
@@ -84,5 +84,19 @@ This works like the first one, except with categories instead of items. There's
 ```
 Lastly, this gives you three completely random items.
 
+## Death Link
+
+Enabling Deathlink is very simple.  Just add `"death_link": true` to your game.json, and you'll get a yaml setting and fancy button in the client.
+
+```json
+{
+    "game": "Snolf",
+    "creator": "YourNameHere",
+    "filler_item_name": "Gold Rings",
+    "death_link": true
+}
+```
+
+If you turn this on, make sure you have a clear (and documented) understanding of what a death is, when players should send one, and what it means to receive it.
 
 Next: Add your [items](/docs/making/items.md)

schemas/Manual.game.schema.json

@@ -28,6 +28,10 @@
                 "$ref": "#/definitions/Sitems"
             }
         },
+        "death_link": {
+            "description": "(Optional) Does your game support Deathlink?",
+            "type": "boolean"
+        },
         "_comment": {"$ref": "#/definitions/comment"}
     },
     "required":["game", "filler_item_name"],

src/ManualClient.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
+import time
 from typing import Any
+import typing
 from worlds import AutoWorldRegister, network_data_package
 import json
 
@@ -45,6 +47,10 @@ class ManualContext(SuperContext):
     tracker_reachable_locations = []
     tracker_reachable_events = []
 
+    set_deathlink = False
+    last_death_link = 0
+    deathlink_out = False
+
     def __init__(self, server_address, password, game, player_name) -> None:
         super(ManualContext, self).__init__(server_address, password)
 
@@ -55,7 +61,6 @@ def __init__(self, server_address, password, game, player_name) -> None:
 
         self.send_index: int = 0
         self.syncing = False
-        self.awaiting_bridge = False
         self.game = game
         self.username = player_name
 
@@ -145,6 +150,10 @@ def on_package(self, cmd: str, args: dict):
                 goal = args["slot_data"].get("goal")
                 if goal and goal < len(self.victory_names):
                     self.goal_location = self.get_location_by_name(self.victory_names[goal])
+                if args['slot_data'].get('death_link'):
+                    self.ui.enable_death_link()
+                    self.set_deathlink = True
+                    self.last_death_link = 0
                 logger.info(f"Slot data: {args['slot_data']}")
 
             self.ui.build_tracker_and_locations_table()
@@ -154,6 +163,12 @@ def on_package(self, cmd: str, args: dict):
         elif cmd in {"RoomUpdate"}:
             self.ui.update_tracker_and_locations_table(update_highlights=False)
 
+    def on_deathlink(self, data: typing.Dict[str, typing.Any]) -> None:
+        super().on_deathlink(data)
+        self.ui.death_link_button.text = f"Death Link: {data['source']}"
+        self.ui.death_link_button.background_color = [1, 0, 0, 1]
+        
+        
     def on_tracker_updated(self, reachable_locations: list[str]):
         self.tracker_reachable_locations = reachable_locations
         self.ui.update_tracker_and_locations_table(update_highlights=True)
@@ -265,6 +280,23 @@ def set_active_location_accordion(self, instance):
 
                     index += 1
 
+            def enable_death_link(self):
+                if not hasattr(self, "death_link_button"):
+                    self.death_link_button = Button(text="Death Link: Primed",
+                                                size_hint_x=None, width=150)
+                    self.connect_layout.add_widget(self.death_link_button)
+                    self.death_link_button.bind(on_press=self.send_death_link)
+
+            def send_death_link(self, *args):
+                if self.ctx.last_death_link:
+                    self.ctx.last_death_link = 0
+                    self.death_link_button.text = "Death Link: Primed"
+                    self.death_link_button.background_color = [1, 1, 1, 1]
+                else:
+                    self.ctx.deathlink_out = True
+                    self.death_link_button.text = "Death Link: Sent"
+                    self.death_link_button.background_color = [0, 1, 0, 1]
+
             def update_hints(self):
                 super().update_hints()
                 rebuild = False
@@ -599,6 +631,15 @@ async def game_watcher_manual(ctx: ManualContext):
                 sync_msg.append({"cmd": "LocationChecks", "locations": list(ctx.locations_checked)})
             await ctx.send_msgs(sync_msg)
             ctx.syncing = False
+
+        if ctx.set_deathlink:
+            ctx.set_deathlink = False
+            await ctx.update_death_link(True)
+
+        if ctx.deathlink_out:
+            ctx.deathlink_out = False
+            await ctx.send_death()
+
         sending = []
         victory = ("__Victory__" in ctx.items_received)
         ctx.locations_checked = sending

src/Options.py

@@ -1,7 +1,7 @@
-from Options import FreeText, NumericOption, Toggle, DefaultOnToggle, Choice, TextChoice, Range, NamedRange, PerGameCommonOptions
+from Options import FreeText, NumericOption, Toggle, DefaultOnToggle, Choice, TextChoice, Range, NamedRange, PerGameCommonOptions, DeathLink
 from dataclasses import make_dataclass
 from .hooks.Options import before_options_defined, after_options_defined
-from .Data import category_table
+from .Data import category_table, game_table
 from .Locations import victory_names
 from .Items import item_table
 
@@ -20,6 +20,9 @@ class FillerTrapPercent(Range):
 if any(item.get('trap') for item in item_table):
     manual_options["filler_traps"] = FillerTrapPercent
 
+if game_table.get("death_link"):
+    manual_options["death_link"] = DeathLink
+
 for category in category_table:
     for option_name in category_table[category].get("yaml_option", []):
         if option_name[0] == "!":

src/__init__.py

@@ -409,7 +409,7 @@ def __init__(self, display_name: str, script_name: Optional[str] = None, func: O
         self.version = version
 
 def add_client_to_launcher() -> None:
-    version = 2024_04_10 # YYYYMMDD
+    version = 2024_04_23 # YYYYMMDD
     found = False
     for c in components:
         if c.display_name == "Manual Client":

src/data/game.json

@@ -1,4 +1,5 @@
 {
+    "$schema": "https://github.com/ManualForArchipelago/Manual/raw/main/schemas/Manual.game.schema.json",
     "game": "UltimateMarvelVsCapcom3",
     "creator": "ManualTeam",
 
@@ -22,5 +23,6 @@
         {
             "random": 3
         }
-    ]
-}
+    ],
+    "death_link": false
+}