Skip to main content

A Pythonic, structured data engine for Twilight Imperium 4th Edition

Project description

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 Discord bot game.

Analyse a game in one command

No installation required — just uvx:

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:

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 — module reference and API examples (game session setup, modifier system, combat simulation, scoring, movement, opponent public info)
  • docs/contributing.md — local dev setup, running tests, and project roadmap

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ti4_rules_engine-0.1.1.tar.gz (131.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ti4_rules_engine-0.1.1-py3-none-any.whl (85.5 kB view details)

Uploaded Python 3

File details

Details for the file ti4_rules_engine-0.1.1.tar.gz.

File metadata

  • Download URL: ti4_rules_engine-0.1.1.tar.gz
  • Upload date:
  • Size: 131.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ti4_rules_engine-0.1.1.tar.gz
Algorithm Hash digest
SHA256 778fd2c91bb048c9ef9ca1baf5c8f91c6fffad3584c1949e31697d7363928bc4
MD5 574c3b55e34c7d55f9a4f9fb28c18f57
BLAKE2b-256 101ba492bd529ae5b6805f7351ea5899a1d433788df5c311d8bf089320919bb4

See more details on using hashes here.

Provenance

The following attestation bundles were made for ti4_rules_engine-0.1.1.tar.gz:

Publisher: publish.yml on adam133/ti4-rules-engine

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ti4_rules_engine-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for ti4_rules_engine-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f5c563127adfccb254cc30eb1d931dbde5a67791f8477f84a1161d5e4067282f
MD5 529757efbc7d0aa5928dab7b4c11062a
BLAKE2b-256 d34b8973ffb10283c212c13fc45b9d1f9687ebc9feff99b896c6ee963a8dbaea

See more details on using hashes here.

Provenance

The following attestation bundles were made for ti4_rules_engine-0.1.1-py3-none-any.whl:

Publisher: publish.yml on adam133/ti4-rules-engine

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page