Skip to content

Rules File Format

Florian Thienel edited this page May 31, 2024 · 4 revisions

Top Level Elements

  • name
  • identifier
  • official_rules
  • upload_url
  • upload_format: cabrillo
  • duration (optional)
  • duration-constraints (optional)
  • breaks (optional)
  • categories (optional)
  • overlays: [classic, tb_wires, rookie, youth] (optional)
  • modes: [all, cw, ssb, fm, rtty, digital] (optional)
  • bands: [all, 160m, 80m, 40m, 20m, 15m, 10m] (optional)
  • band_change_rules (optional)
  • properties (optional)
  • exchange
  • scoring
  • examples (optional)

Duration Constraints and Breaks

  • operator_mode: single|multi
  • overlay: classic|tb_wires|rookie|youth
  • duration
  • constraint_mode: total_time|active_time

Categories

  • name
  • operator_mode: single|multi (optional)
  • tx: one|two|multi|distributed (optional)
  • power: high|low|qrp (optional)
  • band_count: all||single (optional, requires bands)
  • bands: [all, 160m, 80m, 40m, 20m, 15m, 10m] (optional)
  • modes: [all, cw, ssb, fm, rtty, digital] (optional)
  • assisted: true|false (optional)
  • overlay: classic|tb_wires|rookie|youth (optional)
  • score_mode: strict|best (optional)
  • duration (optional)

Band Change Rules

  • operator_mode: single|multi (optional)
  • overlay: classic|tb_wires|rookie|youth (optional)
  • grace_period
  • multiplier_exception: true|false (optional)

Properties

  • name
  • label (optional)
  • values: list of strings (optional, use either values or expresion)
  • expression: regular expression (optional, use either values or expresion)
  • source (optional)

Exchange

  • my_continent (optional)
  • my_country (optional)
  • their_continent (optional)
  • their_country (optional)
  • their_working_condition (optional)
  • additional_weight
  • fields: list of list of property names (optional)

Scoring

  • qsos (optional)
  • qso_band_rule: once|once_per_band|once_per_band_and_mode (optional)
  • multis (optional)
  • multi_operation: multiply|add (optional)

Scoring Rules

  • my_continent (optional)
  • my_country (optional)
  • my_prefix (optional)
  • my_working_condition (optional)
  • their_continent (optional)
  • their_country (optional)
  • their_prefix (optional)
  • their_working_condition (optional)
  • bands: [all, 160m, 80m, 40m, 20m, 15m, 10m] (optional)
  • property (optional)
  • except: list of strings (optional)
  • property_constraints (optional)
  • band_rule: once|once_per_band|once_per_band_and_mode (optional)
  • additional_weight (optional)
  • value (optional)

Property Constraints

  • name
  • min (optional)
  • max (optional)
  • my_value (optional)
  • their_value (optional)
  • their_value_empty: true|false (optional)
  • their_value_not_empty: true|false (optional)
  • same: true|false (optional)
  • other: true|false (optional)

Examples

Example Setup

  • my_call (optional)
  • my_contient: af|as|eu|na|sa|oc (optional)
  • my_country (optional)
  • grid_locator (optional)
  • operators: list of strings (optional)
  • operator_mode: single|multi (optional)
  • overlay: classic|tb_wires|rookie|youth (optional)
  • power: high|low|qrp (optional)
  • bands: [all, 160m, 80m, 40m, 20m, 15m, 10m] (optional)
  • modes: [all, cw, ssb, fm, rtty, digital] (optional)
  • my_exchange: map[property]string

Example QSOs

  • their_call (optional)
  • their_continent (optional)
  • their_country (optional)
  • time (optional)
  • band: 160m|80m|40m|20m|15m|10m (optional)
  • mode: cw|ssb|fm|rtty|digital (optional)
  • their_exchange: list of strings
  • score

Example QSO Score

  • points
  • multis
  • duplicate: true|false (optional)

Example Score

  • qsos
  • points
  • multis
  • total