TableFlux logo
TableFlux
Store, library, campaigns
Back to docs

Adding or Updating Game Rules

Requirements-first process for evolving rules behavior safely with tests and docs.

Rules AuthorsEvolvingRules

Adding or Updating Game Rules

Game rule changes should remain testable, documented, and consistent with package-based loading.

#1. Update Rule Source Documents

For TableFlux ruleset behavior, treat Markdown/tableflux/rules.md as the behavioral source of truth.

  • Add or revise the expected rule behavior there first.
  • Keep terminology and edge-case handling explicit.

#2. Add Regression Tests

Create or update tests that cover:

  • Primary happy-path resolution.
  • Rule conflicts and override priority.
  • Multiplayer synchronization effects when applicable.
  • UI-visible outcomes driven by the rule engine.

#3. Implement Runtime Changes

Apply code updates after requirements and tests are in place.

  • Keep package and plugin boundaries intact.
  • Avoid embedding rule-specific logic into unrelated systems.

#4. Validate End-to-End

Run focused tests first, then broader suites for impacted systems.

#5. Publish Documentation

Update this documentation folder and run the sync batch script so the website docs remain current.