README

   1 # Intricacy
   2 A game of competitive puzzle-design.
   3
   4 https://mbays.sdf.org/intricacy/
   5
   6 ## Configuration
   7 You can change keybindings in SDL mode by right-clicking on the corresponding
   8 button and pressing a key.
   9
  10 Config files are saved in `~/.intricacy/` on unixoids, or something like
  11 `...\Application Data\intricacy\` on windows. In particular, the locks you
  12 create in the lock editor are saved in there (and you can organise them into
  13 directories by including (back)slashs in the lock name). You can edit them in
  14 a text editor if you want - see AsciiLock.hs for what the characters mean.
  15
  16 If you want to cheat your way past initiation, change "False" to "True" in
  17 `metagame.conf`.
  18
  19
  20 ## Rough description of the game mechanics
  21 * Locks consist of blocks, pivots and balls. Blocks can be connected to other
  22     blocks by springs. Pivots have arms. When picking a lock, you control two
  23     tools - a hook, which acts as a mobile one-armed pivot, and a wrench,
  24     which acts as a mobile block with momentum.
  25 * To open a lock, the "bolthole" (the area in the top-right) must be empty.
  26 * Each turn, the tools push and rotate according to the player's commands, and
  27     then each spring which is compressed or extended beyond its natural length
  28     pushes/pulls on the block at its end.
  29 * If two forces try to move a piece in two different directions, or try to
  30     move two pieces into the same hex, one or both is blocked.
  31 * If a pivot/hook is trying to turn and there's a piece in the way of one of
  32     its arms, it will at first try to push the piece away - but if that force
  33     is blocked, it will try instead to pull the piece round with the arm as it
  34     turns.
  35 * If two springs are trying to push two blocks into the same hex, they will
  36     generally both be blocked. However, if one of the forces is also pushing
  37     against a fixed piece such as a tool, it won't block the other force.
  38
  39
  40 ## Full details of the metagame mechanics
  41 (Where by the 'game' I mean the lock-picking bit, and by the 'metagame' I mean
  42 the bit with the 3-letter codenames and the three lock slots and notes and so
  43 on. If you haven't seen anything of the kind... keep solving those locks!)
  44
  45 Scoring is always relative - each player has a score relative to each other
  46 player. That score is the number of the second player's lock slots to which
  47 the first player has access, minus the number of the first player's lock slots
  48 to which the second player has access.
  49
  50 A player accesses a lock slot when one of the following holds
  51     * the player has solved the lock in the slot, and declared the solution;
  52     * the player has read three notes on the lock in the slot;
  53     * there's no lock in the slot, and the player has accessed all the slots
  54         which do have locks in them.
  55
  56 A player reads every note in every lock the player accesses. When a lock is
  57 replaced ('retired'), each note secured by the lock becomes 'public', and is
  58 read by every player.
  59
  60 Note this means that once three notes on a lock become public, every player
  61 accesses the lock. The lock is then 'public' (and its owner should replace
  62 it!).
  63
  64 To declare a solution, you must secure a note on it behind a non-public lock
  65 in one of your three lock slots. Once the note is placed, it can't be moved.
  66
  67
  68 ## Full details of the game mechanics
  69 Springs are directed; one of the blocks it is connected to is the 'root', the
  70 other the 'end'. A block is stationary if it is not the end of any spring. The
  71 directed graph whose nodes are the blocks and whose edges are the springs is
  72 required to be acyclic. A spring may also be rooted in a pivot.
  73
  74 I will now attempt to describe in full excruciating detail the game physics,
  75 i.e. the algorithm used to determine what happens on a turn. You shouldn't
  76 need to read this to play the game! Experimenting and turning on blockage
  77 annotations should be enough.
  78
  79 The following description corresponds to the code in Physics.hs. The algorithm
  80 is the result of an extended process of experiment and iterated
  81 simplification; see notes/game in the source distribution if you're perverse
  82 enough to want to read a scattered stream-of-consciousness account of the
  83 process.
  84
  85 Each turn is separated into two phases. In the first phase, the forces arising
  86 from the player's move are 'resolved', possibly resulting in some movement. In
  87 the second phase, forces arising from stretched or compressed springs are
  88 resolved, possibly resulting in some movement.
  89
  90 Here we abuse physics terminology, and use the term 'force' to refer to either
  91 a directional force in the usual sense, which we call a 'push', or a
  92 rotational force, which we call a 'torque'. A force is always on a piece, in
  93 some direction. Only the obvious six hex directions and the two obvious
  94 rotational directions occur; the magnitude is always 1.
  95
  96 Player moves result in forces on the tools in the obvious way. A wrench which
  97 is moving gets a push in that direction each turn (sorry, Newton!). A spring
  98 which is not at its relaxed length results in a push on the end piece.
  99
 100 To _resolve_ these initial forces:
 101     * each initial force is 'propagated to a force group'
 102     * if a group is 'inconsistent' with another group: if one of the group is
 103         'dominated' by the other, it is 'blocked'; else both are blocked
 104     * each force in each unblocked force group is 'applied'
 105
 106 To _apply_ a push: move the piece in the given direction.
 107 To _apply_ a torque: rotate the piece in the given direction.
 108
 109 To _propagate_ a force:
 110     * If applying the force would result in an overlap with another piece,
 111         push that piece - but if it's an arm, twist the pivot instead when
 112         that makes sense.
 113     * If the force is a torque and an arm is pushing on another piece, we have
 114         a special rule: if the obvious push ends up propagating to a resisted
 115         force (see below), then it is replaced with a 'clawing' push. e.g. in
 116         the following situation:
 117             \ O #
 118              o
 119         if the pivot is twisted clockwise, the ball will first be pushed east,
 120         but when that force propagates to a push on the stationary block to
 121         its east which is resisted, processing will back up and a push on the
 122         ball southeast will be tried instead.
 123     * A spring connecting two blocks transmits a push on one block to the
 124         other unless the direction is such that the push is tending to
 125         compress resp. extend the spring and the spring is currently extended
 126         resp. compressed, or the force is a player force and the spring isn't
 127         already fully compressed resp. extended.
 128
 129 A force is _resisted_ if it is a push on a pivot or on a block which isn't the
 130     end of a spring, or it's a torque on a block, or it's a force on a hook
 131     which isn't already getting that force this phase as the result of a
 132     player move, or it's a force on a wrench which isn't a push in the
 133     direction it's already moving.
 134
 135 To _propagate an initial force to a force group_:
 136     * Propagate the force as above, then recursively propagate the resulting
 137         forces, checking for resistance as we go. The force group consists of
 138         all the resulting propagated forces.
 139     * On resistance: back up to try clawing as described above if appropriate,
 140         else consider the whole force group resisted - so the resulting force
 141         group is empty.
 142
 143 Two forces are _inconsistent_ when
 144     * they act on the same piece in different directions, or
 145     * applying both at once results in overlapping pieces, or
 146     * applying both at once results in an overextended/overcompressed spring.
 147
 148 Two force groups are _inconsistent_ iff there is some force from the first
 149     which is inconsistent with some force from the second.
 150
 151 A force group _dominates_ another iff their initial forces are spring forces,
 152     and the root of the first spring is an ancestor of the root of the second
 153     spring, where an ancestor of a block B is recursively defined to be a block
 154     which is the root of a spring which ends at B, or an ancestor of such a
 155     block.
 156
 157 -- mbays@sdf.org 2013