ti4-rules-engine 0.1.0__tar.gz

ti4_rules_engine-0.1.0/.github/workflows/analyze-game.yml

@@ -0,0 +1,33 @@
+name: Analyze TI4 Game
+
+on:
+  workflow_dispatch:
+    inputs:
+      game_number:
+        description: "AsyncTI4 game number (e.g. pbd22295)"
+        required: true
+        type: string
+
+jobs:
+  analyze:
+    name: Fetch and analyze game ${{ inputs.game_number }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+
+      - name: Install dependencies
+        run: pip install .
+
+      - name: Analyze game ${{ inputs.game_number }}
+        run: python scripts/analyze_game.py "${{ inputs.game_number }}"
+        env:
+          PYTHONPATH: ${{ github.workspace }}

ti4_rules_engine-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,50 @@
+name: Publish to PyPI
+
+
+on:
+  workflow_dispatch:
+
+jobs:
+  run-tests:
+    name: Runs Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+
+      - name: Install Dependencies
+        run: pip install ".[dev]"
+
+      - name: Run Unit Tests
+        run: python -m pytest tests
+
+  publish:
+    name: Build and publish to PyPI
+    runs-on: ubuntu-latest
+    needs: run-tests
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

ti4_rules_engine-0.1.0/.gitignore

@@ -0,0 +1,35 @@
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Python cache
+__pycache__/
+*.py[cod]
+*.pyo
+*.pyd
+.Python
+
+# Build / distribution
+dist/
+build/
+*.egg-info/
+*.egg
+
+# pytest / coverage
+.pytest_cache/
+.coverage
+htmlcov/
+coverage.xml
+
+# Editor
+.vscode/
+.idea/
+*.swp
+
+# OS
+.DS_Store
+Thumbs.db
+
+# uv lock (optional, commit if you want reproducible installs)
+# uv.lock

ti4_rules_engine-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Adam B
+
+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.

ti4_rules_engine-0.1.0/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.4
+Name: ti4-rules-engine
+Version: 0.1.0
+Summary: A Pythonic, structured data engine for Twilight Imperium 4th Edition
+License: MIT License
+        
+        Copyright (c) 2026 Adam B
+        
+        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.
+License-File: LICENSE
+Requires-Python: >=3.14
+Requires-Dist: pydantic>=2.0
+Requires-Dist: structlog>=24.0
+Requires-Dist: transitions>=0.9
+Provides-Extra: api
+Requires-Dist: fastapi>=0.110; extra == 'api'
+Requires-Dist: uvicorn[standard]>=0.29; extra == 'api'
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# TI4 Rules Engine
+
+A Pythonic, structured data engine for Twilight Imperium 4th Edition. Tracks
+game state, provides rule references, and calculates player options from a live
+[AsyncTI4](https://github.com/AsyncTI4/TI4_map_generator_bot) Discord bot game.
+
+## Analyse a game in one command
+
+No installation required — just `uvx`:
+
+```bash
+uvx --from ti4-rules-engine ti4-analyze <game_name>
+```
+
+Replace `<game_name>` with the name of your AsyncTI4 game (the identifier shown
+by the bot, e.g. `pbd22295`):
+
+```
+uvx --from ti4-rules-engine ti4-analyze pbd22295
+```
+
+The command fetches the live game snapshot from the AsyncTI4 API and prints:
+
+- Current round, phase, and active player
+- Per-player summary: faction, VP, resources, planets, technologies, and leaders
+- Every legal action available to each player under TI4 rules right now
+- Reachable systems for each fleet (movement + anomaly rules applied)
+
+> **Note:** `uvx --from ti4-rules-engine` requires the package to be published
+> on PyPI.  Until then, clone the repo and use the local install instead:
+>
+> ```bash
+> git clone https://github.com/adam133/ti4-rules-engine
+> cd ti4-rules-engine
+> uv tool install .
+> ti4-analyze pbd22295
+> ```
+
+### What it shows
+
+```
+============================================================
+Game:   pbd22295   Round: 3   Phase: action
+Active: sargun
+============================================================
+
+  sargun [ACTIVE]
+    Faction:  Nekro Virus
+    VP:       5
+    TG:       3  |  Commodities: 0
+    Tokens:   3 tactical / 5 fleet / 2 strategy
+    Planets:  8 controlled, 2 exhausted
+    ...
+    Actions available:
+      • tactical_action
+      • component_action
+      • strategic_action
+```
+
+## Further reading
+
+- **[docs/implementation.md](docs/implementation.md)** — module reference and
+  API examples (game session setup, modifier system, combat simulation, scoring,
+  movement, opponent public info)
+- **[docs/contributing.md](docs/contributing.md)** — local dev setup, running
+  tests, and project roadmap

ti4_rules_engine-0.1.0/README.md

@@ -0,0 +1,66 @@
+# TI4 Rules Engine
+
+A Pythonic, structured data engine for Twilight Imperium 4th Edition. Tracks
+game state, provides rule references, and calculates player options from a live
+[AsyncTI4](https://github.com/AsyncTI4/TI4_map_generator_bot) Discord bot game.
+
+## Analyse a game in one command
+
+No installation required — just `uvx`:
+
+```bash
+uvx --from ti4-rules-engine ti4-analyze <game_name>
+```
+
+Replace `<game_name>` with the name of your AsyncTI4 game (the identifier shown
+by the bot, e.g. `pbd22295`):
+
+```
+uvx --from ti4-rules-engine ti4-analyze pbd22295
+```
+
+The command fetches the live game snapshot from the AsyncTI4 API and prints:
+
+- Current round, phase, and active player
+- Per-player summary: faction, VP, resources, planets, technologies, and leaders
+- Every legal action available to each player under TI4 rules right now
+- Reachable systems for each fleet (movement + anomaly rules applied)
+
+> **Note:** `uvx --from ti4-rules-engine` requires the package to be published
+> on PyPI.  Until then, clone the repo and use the local install instead:
+>
+> ```bash
+> git clone https://github.com/adam133/ti4-rules-engine
+> cd ti4-rules-engine
+> uv tool install .
+> ti4-analyze pbd22295
+> ```
+
+### What it shows
+
+```
+============================================================
+Game:   pbd22295   Round: 3   Phase: action
+Active: sargun
+============================================================
+
+  sargun [ACTIVE]
+    Faction:  Nekro Virus
+    VP:       5
+    TG:       3  |  Commodities: 0
+    Tokens:   3 tactical / 5 fleet / 2 strategy
+    Planets:  8 controlled, 2 exhausted
+    ...
+    Actions available:
+      • tactical_action
+      • component_action
+      • strategic_action
+```
+
+## Further reading
+
+- **[docs/implementation.md](docs/implementation.md)** — module reference and
+  API examples (game session setup, modifier system, combat simulation, scoring,
+  movement, opponent public info)
+- **[docs/contributing.md](docs/contributing.md)** — local dev setup, running
+  tests, and project roadmap

ti4_rules_engine-0.1.0/adapters/__init__.py

@@ -0,0 +1,16 @@
+"""
+TI4 Rules Engine – adapters package.
+
+Provides converters from external game-state formats into the engine's
+native :class:`~models.state.GameState`.
+
+Currently supported formats
+---------------------------
+* **AsyncTI4** – the JSON snapshot produced by the `AsyncTI4 Discord bot
+  <https://github.com/AsyncTI4/TI4_map_generator_bot>`_.
+  See :mod:`adapters.asyncti4` for details.
+"""
+
+from adapters.asyncti4 import AsyncTI4GameData, from_asyncti4
+
+__all__ = ["AsyncTI4GameData", "from_asyncti4"]