exp-runtime-cod 0.5.0__py3-none-any.whl

exp_runtime/cod/__init__.py

@@ -0,0 +1 @@
+"""Cause of Death native game contracts."""

exp_runtime/cod/assets.py

@@ -0,0 +1,76 @@
+"""Verified Cause of Death IPA UI roles. Script-visible IDs remain exact.
+
+CoD retains SHS's layout bank, but its title/menu fonts and relationship art
+have different numeric IDs. There is no fallback into an SHS library.
+"""
+from io import BytesIO
+
+from ..content import ContentError, MAX_PAYLOAD
+
+
+UI_IDS = {528: 292, 529: 293, 530: 294, 531: 295, 532: 296, 533: 297}
+# Host string roles use the existing SHS renderer's indices. These are
+# inspected semantic equivalents in CoD's own resource 13, never SHS text.
+STRING_IDS = {
+    9: 8, 10: 9, 11: 10, 21: 20, 23: 22, 25: 24, 26: 25, 128: 120,
+    29: 26, 30: 27, 31: 28, 35: 32, 36: 33, 37: 34, 39: 36,
+    82: 79, 91: 82, 125: 117, 126: 118, 127: 119, 164: 154,
+    238: 213, 252: 227, 258: 232, 260: 234, 302: 80,
+    **{role: role - 8 for role in range(118, 123)},
+}
+
+
+def ui_resource(library, role):
+    # Shared panel/art IDs retain their native values. Absent assets fail in
+    # this library; a coincident SHS role must not acquire unrelated CoD data.
+    if role in (290, 446, 496, 499, 502, 540, 541) or 508 <= role < 528 or 700 <= role <= 723:
+        raise ContentError(f'Cause of Death has no verified UI resource for role {role}')
+    return library.read_asset(UI_IDS.get(role, role))
+
+
+def validate_assets(read):
+    from PIL import Image, ImageFont
+    from ..atlas import AtlasFont
+    from ..content import ExpArchive
+    from ..menu_assets import MenuFont, MenuStrings
+    from ..ui_assets import ImagePack, LayoutBank, Rect
+
+    def check(resource, parser):
+        try:
+            return parser(read(resource))
+        except (ValueError, OSError, IndexError, Image.DecompressionBombError) as error:
+            raise ContentError(f'Incompatible or missing CoD asset {resource}: {error}') from error
+
+    episode = check(12, ExpArchive)
+    episode.metadata()
+    if 25001 not in episode.programs():
+        raise ContentError('CoD asset 12 is missing the bundled episode entry script')
+    if len(check(13, MenuStrings.parse).strings) < 257:
+        raise ContentError('CoD string bank 13 is missing required UI strings')
+    bank = check(14, LayoutBank.parse)
+    if len(bank.layouts) < 80:
+        raise ContentError('CoD layout bank 14 is missing required UI layouts')
+    for index, last in ((7, 9), (8, 9), (17, 87), (22, 18), (46, 46), (65, 4)):
+        bank.rectangle(index, last)
+    for index in range(len(bank.layouts)):
+        tuple(bank.walk(index))
+    for resource, count in ((6, 1), (7, 1), (8, 1), (9, 1), (16, 108), (126, 60),
+                            (204, 14), (220, 14), (236, 14), (252, 14), (268, 1), (272, 16)):
+        pack = check(resource, ImagePack.parse)
+        mode = 'A' if resource == 268 else 'RGBA'
+        if len(pack.images) < count or any(p.mode != mode for p in pack.images):
+            raise ContentError(f'CoD image pack {resource} has incompatible frames or pixel mode')
+        if resource == 268 and (pack.images[0].width, pack.images[0].height) != (128, 150):
+            raise ContentError('CoD portrait mask 268 must be 128 by 150')
+    check(291, lambda data: ImageFont.truetype(BytesIO(data), 24))
+    def png(data):
+        with Image.open(BytesIO(data)) as image:
+            if image.format != 'PNG' or image.width * image.height * 4 > MAX_PAYLOAD:
+                raise ContentError('Unsupported or oversized CoD UI image')
+            image.load()
+            return Rect(0, 0, image.width, image.height)
+    for resource in (292, 294):
+        rect = check(resource, png)
+        check(resource + 1, lambda data: AtlasFont.parse(data, rect))
+    for resource in (296, 297):
+        check(resource, MenuFont.parse)

exp_runtime/cod/audio.py

@@ -0,0 +1,6 @@
+"""CoD SHSSoundManager::playMusic (0004313c): each ID is its own source."""
+from ..audio import MusicCue
+
+
+def music_cue(resource_id):
+    return MusicCue(resource_id)

exp_runtime/cod/content.py

@@ -0,0 +1,7 @@
+"""Cause of Death's bundled Volume One is itself an EXP at base resource 12."""
+BUILTIN = 'volume-one'
+
+
+def extract_builtin(package, asset_root, *, ios):
+    from ..content import _zip_read
+    return _zip_read(package, asset_root + '12'), 'Volume_One.exp', dict(builtin=BUILTIN)

exp_runtime/cod/profile.py

@@ -0,0 +1,36 @@
+"""Cause of Death content and host-service profile (iOS 1.3.4 reference)."""
+from .audio import music_cue as MUSIC_CUE
+from .content import BUILTIN, extract_builtin
+from .services import dispatch as DISPATCH
+
+STATE_TYPES = {}
+
+KEY = 'cod'
+TITLE = 'Cause of Death'
+SOURCES = 'Cause of Death IPA'
+CATALOG_FILENAME = 'cod_options.sav'
+# Native loadOptions 00019098 / saveOptions 000195b4: five flag bytes and
+# two s32 values precede the current entry; EOF follows the rename table.
+CATALOG_LAYOUTS = {17: ((33, 0),)}
+PROFILES = {'cod-ios-assets-v1': 'ipa'}
+BUNDLE_PATTERN = r'com\.ea\.causeofdeath(?:\.[A-Za-z0-9-]+)*'
+NAME_FONT = ('VerdanaBoldItalic', 291)
+# SHSEngine::initFonts 000234da..000237ee; normal/gray/default dialogue
+# uses black body text and dark-red names. Theme 2 retains its rose color.
+DIALOGUE_COLORS = {1: (0, 0, 0), 2: (180, 78, 78), 3: (0, 0, 0), -1: (0, 0, 0)}
+NAME_COLORS = {'PajamaHip24': (41, 104, 221), 'PajamaHip26': (139, 0, 0),
+               'PajamaHip266': (180, 78, 78), 'PajamaHipG26': (139, 0, 0),
+               'PajamaHipY26': (139, 0, 0), 'PajamaHipS26': (254, 53, 0)}
+MUSIC_RANGE = range(8201, 8210)
+# CoD doSoundManagerTransition (00022b04), splashScreenFlewIn (00014c0c).
+MENU_MUSIC = 8209
+DEFAULT_EPISODE = (101, 1)
+RELATIONSHIP_ASSETS = (3000, 3001, 3002)
+RELATIONSHIP_FLASH = {3000: 3003, 3001: 3005, 3002: 3007}
+RELATIONSHIP_LOSS = {3000: 3004, 3001: 3006, 3002: 3008}
+# SHSEngine::buttonPressed 000249d0 and SHSWidgetMenu::buttonPressed 0003fd60.
+CLICK_SOUND = 8005
+# SHSEngine::buttonPressed pause branch (00024d86).
+PAUSE_SOUND = 8006
+# SHS answer-feedback resource IDs do not establish semantics for CoD assets.
+CHOICE_FEEDBACK_SOUNDS = {}

exp_runtime/cod/services.py

@@ -0,0 +1,56 @@
+"""Cause of Death host-service differences, recovered from its iOS dispatcher."""
+from ..vm import VMError
+
+
+def dispatch(engine, vm, *, resource_exists=None):
+    from ..engine import EngineAction
+    request = vm.pending
+    service, args = request.yield_id, request.args
+
+    def complete(name, result=0, **details):
+        vm.resume(result)
+        return EngineAction(name, request, True, dict(result=result, **details))
+
+    if service == 15:
+        # SHSScript::syscall 0003354c, case 0x0f: named dialogue on panel 3.
+        # Only the first two words are read, even in the four-word EXP form.
+        if len(args) < 2:
+            raise VMError(f'yield 15 at pc {request.pc}: needs at least 2 arguments')
+        speaker, text = (engine.read_text(vm, ref) for ref in args[:2])
+        return EngineAction('dialogue', request, False,
+                            engine.present_dialogue(-1, 0, text, 0, speaker=speaker))
+    if service == 70:
+        # 000335d6 reads stack[SP - argc], including retained backing for a
+        # zero-word call. Extra frame words are ignored, then popped normally.
+        selector = args[0] if args else vm.read_word(vm.stack_base + vm.sp)
+        if selector == 6:
+            # 000341fe writes CFBundleVersion to the first dynamic string.
+            # Bare EXP tracing has no native bundle; do not invent a version.
+            if engine.app_version is None:
+                return EngineAction('unhandled_yield', request, False, dict(
+                    selector=selector, reason='CoD version query requires CFBundleVersion from its IPA'))
+            engine.dynamic_strings[0] = engine.app_version
+        # 000341bc: selector 10 returns 1 when MTX_IsStoreAvailable is false.
+        # The offline desktop has no MTX store. This is its unavailable branch,
+        # not a claim that every native iOS device returned a constant.
+        result = {2: 2, 3: 6, 6: 0x7ff5, 9: 1, 10: 1}.get(selector, 0)
+        return complete('query_build', result, selector=selector)
+    if service in (94, 96, 100):
+        # 94/96 target 00033778 through the table; 100 reaches it through the
+        # unsigned >99 branch at 000335cc, without reading any frame words.
+        # This reproduces the supplied CoD 1.3.4 default, including callers
+        # with promotional URLs. It does not implement a later URL launcher.
+        # The completion tail at 00034b74 narrows the internal sentinel to R=0
+        # and pops the frame.
+        # No minigame, score write or random draw occurs in this native build.
+        return complete('native_noop')
+    if service == 99:
+        if len(args) != 1:
+            raise VMError(f'yield 99 at pc {request.pc}: expected 1 arguments, got {len(args)}')
+        # Offline desktop adaptation of the native no-ad completion path.
+        # No ad SDK or network request is made; resume the original continuation.
+        return complete('offline_ad')
+    if service in (9, 91, 95):
+        return EngineAction('unhandled_yield', request, False,
+                            dict(reason='This service is not implemented for Cause of Death'))
+    return None

exp_runtime_cod-0.5.0.dist-info/METADATA

@@ -0,0 +1,47 @@
+Metadata-Version: 2.4
+Name: exp-runtime-cod
+Version: 0.5.0
+Summary: Cause of Death adapter for EXP Runtime
+License: MIT License
+        
+        Copyright (c) 2025 Josh Mcdaniel
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: exp-runtime-engine[fonts]==0.5.0
+Dynamic: license-file
+
+# EXP Runtime — cod
+
+Cause of Death adapter for EXP Runtime. This is a component of the single
+[EXP Runtime project](https://github.com/joshrmcdaniel/exp-runtime), maintained
+and released together with its other wheels. Python imports use the shared
+`exp_runtime` namespace.
+
+Install `exp-runtime[tools]` for file tools, `exp-runtime[engine,shs]` or
+`exp-runtime[engine,cod]` for a headless game, or `exp-runtime[player]` for
+the desktop player with both games. Individual component wheels also support
+selective installs. See the project's `docs/SDK.md` for APIs and examples.
+
+No original game content is included. Users supply their own game files.
+The inherited MIT license and attribution are included in LICENSE; see
+[provenance](https://github.com/joshrmcdaniel/exp-runtime/blob/main/docs/PROVENANCE.md).

exp_runtime_cod-0.5.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+exp_runtime/cod/__init__.py,sha256=H-v3gHEytdACCAVPnnjcKqqoHyE1ELUdsToUafuDSgw,44
+exp_runtime/cod/assets.py,sha256=80Qyv0vKFa9D_TroOmZx1TLBnjsPSJWF3opo2N20-tc,3651
+exp_runtime/cod/audio.py,sha256=K7hax3eKyV8_YzvGNdgGM6ypbUyC8kpwmsAqaNySz4o,168
+exp_runtime/cod/content.py,sha256=sdobY9K59YGFqlSM4XCvtMGEeh3CAy1afCTMqejZ914,281
+exp_runtime/cod/profile.py,sha256=bTiT2PoB41sQqzbButq5dbLZya7HrZZQR9lXozc9qCg,1688
+exp_runtime/cod/services.py,sha256=_qZljJZma8ZcqIskXOirXQ9kJumRZnUHFS413fsdJhE,3126
+exp_runtime_cod-0.5.0.dist-info/licenses/LICENSE,sha256=y2xxdaMMD9iKqLFR2Lp8sM_0b3qZWxU4_vW0zgufh2k,1070
+exp_runtime_cod-0.5.0.dist-info/METADATA,sha256=ClLy41xsEws6HgcFX-0l__QD-l68aNrVq3Ic8Byq9kE,2326
+exp_runtime_cod-0.5.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+exp_runtime_cod-0.5.0.dist-info/top_level.txt,sha256=1uRgkxqLAgYpITLluWh9qs6TpAD83zFoh0E5lbic4RA,12
+exp_runtime_cod-0.5.0.dist-info/RECORD,,

exp_runtime_cod-0.5.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

exp_runtime_cod-0.5.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Josh Mcdaniel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

exp_runtime_cod-0.5.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+exp_runtime