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.0.tar.gz (130.5 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.0-py3-none-any.whl (62.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ti4_rules_engine-0.1.0.tar.gz
  • Upload date:
  • Size: 130.5 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.0.tar.gz
Algorithm Hash digest
SHA256 6ef664e0650eea6d6896e9d1c90ab2809643f8b34cb38732f97d70c2c43e5c76
MD5 2c2d92a590ccc47bb1862053387af6b4
BLAKE2b-256 cad9b08079e0a493bcca1f528638b42a78915feb1a8f63d2a61bb0b5bc9495b4

See more details on using hashes here.

Provenance

The following attestation bundles were made for ti4_rules_engine-0.1.0.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.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ti4_rules_engine-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 24ef11fb3d42c86113935f77ca567499c1c38e51f79cd612be2d1add81c0644b
MD5 ac012bc72e325b717a7d434b333f4fe0
BLAKE2b-256 2b6fa891e24b0957fa9106626b54f6b012ec41385bfb57a5fcdd07918ae1ec1d

See more details on using hashes here.

Provenance

The following attestation bundles were made for ti4_rules_engine-0.1.0-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