(game-module "stdunit"
  (blurb "base module for standard game")
  )

;;; New format version of the standard game.  This file is just types and
;;; tables, is not a complete game (see "standard" for that).

(unit-type infantry (image-name "soldiers")
  (help "marches around and captures things"))
(unit-type armor (image-name "tank")
  (help "faster than infantry, limited to open terrain"))
(unit-type fighter (image-name "fighter")
  (help "interceptor to get those nasty bombers"))
(unit-type bomber (image-name "4e")
  (help "long range aircraft, carries infantry and bombs"))
(unit-type destroyer (image-name "dd")
  (help "fast, cheap, and sinks subs"))
(unit-type submarine (image-name "sub")
  (help "sneaks around and sinks ships"))
(unit-type troop-transport (name "troop transport") (image-name "ap")
  (help "carries infantry and armor across the pond"))
(unit-type carrier (image-name "cv") (char "C")
  (help "carries fighters and bombers around"))
(unit-type battleship (image-name "bb") (char "B")
  (help "the most powerful ship"))
(unit-type nuclear-bomb (name "nuclear bomb") (image-name "bomb") (char "N")
  (help "leveler of cities (and anything else)"))
(unit-type base (image-name "airbase") (char "/")
  (help "airbase plus port"))
(unit-type town (image-name "town20") (char "*")
  (help "smaller than a city"))
(unit-type city (image-name "city20") (char "@")
  (help "capital of a side"))

(define i infantry)
(define a armor)
(define f fighter)
(define b bomber)
(define d destroyer)
(define s submarine)
(define t troop-transport)
(define cv carrier)
(define bb battleship)
(define nuke nuclear-bomb)
(define / base)
(define * town)
(define @ city)

(material-type fuel
  (help "basic supply that all units need"))
(material-type ammo
  (help "generic supply used in combat"))

(include "stdterr")

(define ground (i a))
(define aircraft (f b))
(define ship (d s t cv bb))
(define cities (* @))
(define places (/ * @))
(define movers (i a f b d s t cv bb nuke))

(define water (sea shallows))
(define land (swamp plains forest desert mountains))

;;; Static relationships.

(table vanishes-on
  (ground water true)
  (armor swamp true)
  (places water true)
  (ship land true)
  (ship road true)
  ;; Only aircraft can deal with ice.
  (u* ice true)
  (aircraft ice false)
  )

;; Unit-unit capacities.

;; Note that carriers have room for up to 8 fighters, but only
;; two bombers.

(table unit-capacity-x
  (cv fighter 4)
  )

(add b capacity 1)
(add t capacity 6)
(add cv capacity 4)
(add places capacity (20 40 80))

(table unit-size-as-occupant
  ;; Disable occupancy by default.
  (u* u* 100)
  ;; Bombers can carry one infantry or one nuke.
  ((i nuke) b 1)
  ;; Transports can carry 6 armor or infantry.
  (ground t 1)
  ((f b) cv (1 2))
  ;; Bases can hold 10 of most unit types, but up to 20 fighters.
  (u* / 2)
  (fighter / 1)
  ;; City types have lots of capacity for everything.
  (movers cities 1)
  )

;;; Unit-terrain capacities.

;; Limit units to 16 in one cell, for the sake of playability and
;; and drawability.  Places cover the entire cell, however.
  
(add t* capacity 16)

(table unit-size-in-terrain
  (u* t* 1)
  ;; Allow aircraft to pass over towns instead of landing.
  (aircraft t* 0)
  (places t* 16)
  )

;;; Unit-material capacities.

(table unit-storage-x
  (u* fuel ( 6 10 18 36 100 100 200 400 200  0 200 500 900))
  (u* ammo ( 6  4  3  3  20  10  20  40  40  0 100 200 400))
  )

;;; Vision.

;; Towns and cities always have foreign correspondents, telephones,
;; private citizens coming and going, so their state is always
;; going to be available to any side that knows they exist.

(add cities see-always true)

;; Cities have more powerful radar and sensing systems, and
;; so they can see out further.

(add @ vision-range 3)
;(add bb vision-range 2)  ; an experiment

(table see-chance-adjacent
  ;; Submarines are always hard to see.
  (u* s 10)
  ;; A bomb in a truck is rather small and inconspicuous.
  (u* nuke 10)
  )

;;; Actions.

(add u* acp-per-turn  (1 2 9 6 3 3 2 4 4 1 0 1 1))

;;; Movement.

(add places speed 0)

;; Don't be too picky about mp usage.

(add u* free-mp 1)

;; Aircraft should always be able to land, and this in conjunction
;; with the entry cost will result in airplanes being able to land at
;; any time during their time, but always having to wait until the
;; next turn to take off again.

(add aircraft free-mp (9 6))

(table mp-to-enter-terrain
  ((cv bb) shallows 2)
  (a (swamp forest mountains) 99)
  ;; No special trouble to get on a road
  ;; (such as when using to cross a river).
  (a road 0)
  (ground water 99)
  (ship land 99)
  ;; Don't let ships use roads.  This might seem unnecessary,
  ;; but consider the case of a ship in a town wanting to leave
  ;; in a direction that has a road.  If the road appears to be
  ;; cheaper and the ship has enough mp, it will take the road
  ;; and then vanish.
  (ship road 99)
  (u* ice 99)
  (aircraft ice 1)
  ;; Armor take an extra ACP to cross a river; everyone else is unaffected
  (u* river 0)
  (a river 1)
  )

(table mp-to-leave-terrain
  ;; This is for accident prevention, in the case of a ground
  ;; unit on a road bridge that doesn't quite reach land.
  (ground water 99)
  ;; Prevent armor crossing impassable terrain from a road
  ;; ending in impassable terrain.
  (a (swamp forest mountains) 99)
  )

(table mp-to-traverse
  (a road 1)
  (ship river 2)
  )

(table material-to-move
  (movers fuel 1)
  (nuke fuel 0)
  )

(table mp-to-enter-unit
  (u* u* 1)
  ; aircraft can't sortie again until next turn
  ;(f u* 9)
  ;(b u* 6)
  ;; Some cost to land, but can still take off again in the same turn.
  (f u* 2)
  (b u* 2)
  (ship u* 0)
  (a cities 0)   ; travel quickly on surrounding roads.
  )

(table consumption-per-move
  (movers fuel 1)
  ;; Nukes are "important", a country would never risk them running out.
  (nuke fuel 0)
  )

;;; Construction.

;; Nuclear weapons must be developed before they can be built.

(add nuke tech-max 60)
(add nuke tech-to-build 60)

;; Only cities can develop nukes.

(table acp-to-develop (@ nuke 1))

(table tech-per-develop (@ nuke 1.00))

;; Limit the amount of gain possible due to a concentrated effort.
;; Note that this will only have an effect in games with many cities.

(add nuke tech-per-turn-max 3)

;; Basically, units take about as many turns to complete as their cp.

(add u* cp (4 7 8 16 10 16 12 30 40 20 5 1 1))

(table acp-to-create
  (i / 1)
  (cities movers 1)
  )

(table cp-on-creation
  (a / 2)
  )

(table acp-to-build
  (i / 1)
  (cities movers 1)
  )

(table cp-per-build
  (a / 2)
  )

(table occupant-can-construct (u* u* false))

;;; Repair.

;; Explicit repair actions accelerate the recovery of lost hp.

(table acp-to-repair
  (cities u* 1)
;  (/ u* 1)
  (cv cv 1)
  (bb bb 1)
  (i places 1)
  )

(table hp-per-repair
  ;; Towns and cities can repair anything.
  (cities u* 1.00)
;  (/ u* 3.00)  ; what is this all about?
  ;; Capital ships are equipped to do major repairs to themselves.
  (cv cv 1.00)
  (bb bb 1.00)
  ;; The army's engineers can do lots of repair work if put to the task.
  (i places (2.00 5.00 5.00))
  )

(table auto-repair
  ;; Capital ships are equipped to do major repairs to themselves.
  (cv cv 0.50)
  (bb bb 0.50)
  (cities movers 0.50)
  )

;; Some types have sufficient people and redundancy to do some repair work
;; without affecting their readiness to act.

(add (cv bb /) hp-recovery 0.50)
(add cities hp-recovery 1.00)

;;; Production.

(table base-production
  (ground fuel 1)
  ;; This is not too realistic, but otherwise keeping tanks fueled
  ;; is a major hassle.  This is supposed to be a game, not an
  ;; exercise in logistics (play "empire.g" if you want that).
  (a fuel 2)
  (places fuel (10 20 50))
  (places ammo (5 10 20))
  )

(table productivity
  ;; Plains are assumed to be settled and have fuel stocks.
  (i (swamp desert mountains) 0)
  ;; It *is* worthwhile to make players think about logistics
  ;; when operating in the desert.
  (a desert 0)
  (/ land (0 100 50 20 20))
  (* land (0 100 50 20 20))
  (@ land (0 100 50 20 20))
  )

(table base-consumption
  ;; Note that armor does *not* have a base consumption;
  ;; tanks that don't move don't need fuel.  (Infantry
  ;; still needs fuel, because an infantry unit in real life
  ;; has a large number of personnel, and fuel represents
  ;; their general energy and food consumption.)
  ((i f b) fuel (1 3 2))
  (ship fuel 1)
  )

(table hp-per-starve
  ((i f b) fuel 1.00)
  ;; Immobilized tanks eventually rust...
  (armor fuel 0.05)
  (ship fuel 0.10)
  (places fuel 0.05)
  )

(table consumption-as-occupant
  ;; Aircraft on the ground or in a carrier just sit there.
  ((f b) fuel 0)
  )

;;; Combat.

(add u* hp-max (1 1 1 2 3 2 3 4 8 1 10 20 40))

;; Units are generally crippled, moving at half speed,
;; at about 1/2 of hp-max, sometimes rounding up, sometimes down.

(add b  speed-damage-effect ((1 50) (2 100)))
(add d  speed-damage-effect ((1 50) (2 100) (3 100)))
(add s  speed-damage-effect ((1 50) (2 100)))
(add t  speed-damage-effect ((1 50) (2  50) (3 100)))
(add cv speed-damage-effect ((1 50) (2  50) (3 100) (4 100)))
(add bb speed-damage-effect ((1 50) (4  50) (5 100) (8 100)))

(table acp-to-attack
  ;; Places can defend, but not attack.
  (places u* 0)
  )

;;; The main hit table.

(table hit-chance
  (i u* ( 50  40  20  15  20  20  30  20   9  40  80  60  40))
  (a u* ( 60  50  30  30  30  20  30  20  20  50  90  70  50))
  (f u* ( 15  25  60  70  20  30  20  50  40  80 100 100 100))
  (b u* ( 20  20  10   9  30  50  50  70  60  50  90  95  99))
  (d u* (  5   5  10   5  60  70  60  40  20   0  99  90  80))
  (s u* (  0   0  10   5  40  10  60  40  50   0   0   0   0))
  (t u* ( 20   5  10   5  40  40  40  30   9   0   0   0   0))
 (cv u* ( 30  20  40  10  30  30  40  20  20   0   0   0   0))
 (bb u* ( 50  50  50  20  70  50  90  50  90   0 100 100 100))
;  (nuke u* 100) ; doesn't really matter
  (/ u* ( 10  10  20  20  20  20  30  20  20   0   0   0   0))
  (* u* ( 30  20  50  40  40   0  30  20  20   0   0   0   0))
  (@ u* ( 50  40  70  60  50   0  30  20  50   0   0   0   0))
  )

(table damage
  (u* u* 1)
  (a places 2)
  (b ship 2)
  (b s 1)
  (b places (2 2 3))
  (d s 2)
  (s ship 3)
  (s bb 4)
  (bb u* 2)
  (bb cities (3 4))
  )

(table capture-chance
  (i places (70 50 30))
  (a places (90 70 50))
  )

(table independent-capture-chance
  (i places (100 80 50))
  (a places (100 95 70))
  )

;; Intelligent and/or valuable units will work to preserve themselves.

(table retreat-chance
  (a i 10)
  (a a 20)
  (f f 20)
  (f b 50)
  (ship cv 50)
  )

;; infantry can capture cities even on water.

(table bridge (i places true))

(table protection ; actually ablation?
  ;; places offer some protection to occupants
  (places movers 50)
  ;; but bases make aircraft sitting ducks, so no protection there.
  (base aircraft 100)
  ;; inf and armor protect the places housing them.
  ;; can't make this too large or city can be
  ;; invulnerable.
  (i places 80)
  (a places 60)
  ; bases benefit more from protection.
  (ground / (50 40))
  )

;; Combat requires ammo, and uses it up.

(table consumption-per-attack (u* ammo 1))

(table hit-by (u* ammo 1))

;;; Detonation.

;; Nukes work by detonation rather than by conventional attack actions.

(add nuke acp-to-detonate 1)

(add nuke hp-per-detonation 1)

(table detonation-damage-at (nuke u* 60))

(table detonation-damage-adjacent (nuke u* 1))

(table detonation-terrain-damage-chance
  (nuke (plains forest) 100)
  )

(table terrain-damaged-type
  (plains desert 1)
  (forest desert 1)
  )

;;; Disbanding.

;; This does movers in one shot except battleships, which historically
;; are usually difficult to scuttle.

(add movers acp-to-disband 1)
(add bb acp-to-disband 2)

(add movers hp-per-disband 4)

;; Takes a while to dismantle a base.

(add / hp-per-disband 2)

;;; Changing sides.

(add u* acp-to-change-side 1)
(add i acp-to-change-side 0)

(add i possible-sides '(not "independent"))

;;; Automatic things.

;; Economy.

(table out-length
  ;; Net consumers of supply should never give any up automatically.
  ((i a b f nuke) m* -1)
  ;; Cities and towns can share things around.
  (/ m* 6)
  (cities m* 12)
  )

(table in-length
  ;; Supply to ground units can go a couple hexes away.
  (ground m* 3)
  ;; Cities and bases can get their supplies from some distance away.
  (/ m* 6)
  (cities m* 12)
  )

;; Fate of units when a side loses.

;; Towns and cities are forever.
(add / lost-vanish-chance 1000)
(add cities lost-vanish-chance 0)

(table lost-surrender-chance (u* u* 5000))

(add / lost-revolt-chance 10000)
(add cities lost-revolt-chance 10000)

;;; Scoring.

;; Most units aren't worth much, but ground units can capture
;; cities, carriers and battleships are powerful, and nukes are
;; devastating, especially when stockpiled.

(add u* point-value 0)
(add (i a) point-value 1)
(add (cv bb) point-value 1)
(add nuke point-value 5)
(add cities point-value (5 25))

;;; Texts.

(set action-notices '(
  ((disband infantry self done) (actor " goes home"))
  ((disband u* bomb done) (actor " dismantles " actee))
  ((disband u* u* done) (actee " disbands"))
  ((destroy u* ground) (actor " defeats " actee "!"))
  ((destroy u* aircraft) (actor " shoots down " actee "!"))
  ((destroy u* ship) (actor " sinks " actee "!"))
  ((destroy u* places) (actor " flattens " actee "!"))
  ))

(set event-notices '(
  ((unit-starved fighter) (0 " runs out of fuel and crashes!"))
  ((unit-starved bomber) (0 " runs out of fuel and crashes!"))
  ))

(set event-narratives '(
  ((unit-starved fighter) (0 " ran out of fuel and crashed"))
  ((unit-starved bomber) (0 " ran out of fuel and crashed"))
  ))

;;; Initial setup.

(add cities start-with (5 1))
(set country-radius-min 3)
(set country-separation-min 16)
(set country-separation-max 48)
;; Try to get countries to be on the coast.
(add (sea plains) country-terrain-min (1 4))

(table favored-terrain
  (u* t* 0)
  (@ plains 100)
  (* land 20)
  (* plains 40)
  )

(table independent-density
  ;; Most additional towns are in favorable terrain.
  (town plains 600)
  (town (desert forest mountains) 100)
  )

(add land country-people-chance 90)
(add plains country-people-chance 100)

(add land independent-people-chance 50)

(table road-chance
  (city (town city) (80 100))
  (town (town city) ( 2   5))
  )

(add (town city) road-to-edge-chance 100)

(set edge-road-density 100)

;; Nearly all towns should be connected by road to
;; somewhere else.

(add town spur-chance 90)
(add town spur-range 2)

;; A game's starting units will be full by default.

(table unit-initial-supply (u* m* 9999))

;; Default doctrine.

(doctrine default-doctrine
  (construction-run (u* 1))
  (rearm-percent 40)
  )

(doctrine place-doctrine
  (construction-run (u* 99) ((carrier battleship) 3) (nuke 1)))

(side-defaults
  (default-doctrine default-doctrine)
  (doctrines (places place-doctrine))
  )

(game-module (notes (
  "This game is the most commonly played one in Xconq.  It"
  "represents units of about 1945, from infantry to atomic bombs."
  ""
  "Opinions differ about optimal strategy for this game.  In general,"
  "blitzkrieg works, and can win the game in a hurry.  The problem is to"
  "muster enough force before striking.  One full troop transport is not"
  "enough; the invasion will melt away like ice cream on a hot sidewalk,"
  "unless"
  "reinforcements (either air or land) show up quickly.  Air cover is very"
  "important.  While building up an invasion force, airborne assaults using"
  "bombers and infantry can provide useful diversions, although it can be"
  "wasteful of bombers.  Human vs human games on a 60x30 world generally"
  "last about 100 turns, usually not enough time or units to build atomic"
  "bombs or battleships, and not a big enough world to really need carriers,"
  "although bases for staging are quite useful."
  )))

(add i notes '(
  "The infantry army is the slowest of units, but it can go almost"
  "anywhere.  It is also quick to produce.  Infantry is the staple of"
  "campaigns - no special features, but essential to success."
  ))
(add a notes '(
  "The armor army is highly mobile and hits hard.  Unfortunately,"
  "it is limited to operating in open terrain - plains and desert.  It also"
  "takes longer to produce.  Armor can last twice as long in the  "
  "desert as infantry.  Both armor and infantry can"
  "assault and capture cities; they are the only units that can do so."
  ))
(add f notes '(
  "A fighter is a squadron or wing of high-speed armed aircraft."
  "Their fuel supply can be gotten only at cities/towns, bases,"
  "and carriers, so they must continually be taking off and landing."
  "Fighters are not too effective"
  "against ground units or ships, but they eat bombers for lunch.  Fighters"
  "are very good for reconnaisance - important when you can't always"
  "see the enemy moving!"
  ))
(add b notes '(
  "Bombers are very powerful, since they can seriously damage"
  "or even flatten cities.  Loss rate in such activities is high,"
  "so they're not a shortcut to victory!"
  "Bombers can carry one infantry, which is very useful for raids."
  ))
(add d notes '(
  "Destroyers are fast small ships for both exploration and"
  "anti-submarine activities."
  ))
(add s notes '(
  "The favorite food of a submarine is a troop transport, which it can"
  "sink with one blow."
  "Subs are also hard to spot, but vulnerable to destroyers and aircraft."
  ))
(add t notes '(
  "This is how ground units get across the sea.  Transports can"
  "defend themselves against ships and aircraft, but are basically vulnerable."
  "They're not very fast either."
  ))
(add cv notes '(
  "Compensates for the limited range of fighters and bombers by providing"
  "a portable airport.  Carriers themselves are sitting ducks, particularly"
  "with respect to aircraft.  Fighter patrols are mandatory."
  ))
(add bb notes '(
  "The aptly named `Dread Naught' has little to fear from other"
  "units of this period.  Subs may sink them with enough effort, and a group"
  "of bombers and fighters are also deadly,"
  "but with eight hit points to start,"
  "a battleship can usually survive long enough to escape."
  "Battleships are very effective against cities and armies,"
  "at least the ones on the coast."
  ))
(add nuke notes '(
  "Atomic bombs.  The Final Solution; but they are not easy to use.  A bomb"
  "takes a long time to produce, moves very slowly by itself, and is easily"
  "destroyed by other units. The plus side is instant destruction for any unit"
  "of any size!  Bombs are imagined to be transported by a team of scientists,"
  "and can go on any sort of terrain without running out of supplies."
  ))
(add / notes '(
  "A base serves as a combination camp, airbase, and port."
  "Bases cannot build units, although they can repair some damage."
  ))
(add * notes '(
  "Towns are the staple of territory.  They can build, repair, produce"
  "fuel and ammo, and serve as a safe haven for quite a few units."
  ))
(add @ notes '(
  "Cities are very large, powerful, and well defended.  They are"
  "basically capital cities, or something in a comparable range.  (New York"
  "and San Francisco are cities, Salt Lake City and San Antonio are towns."
  "Yeah, San Antonio has a lot of people, but it's still insignificant,"
  "nyah nyah.)  A city is worth five towns, point-wise."
  ))

;(set unseen-color "orange")
;(set grid-color "black")
