add goal field to scenarios (#450)

If there is a goal, immediately pop up a dialog with the goal, then
allow showing it any time afterwards with ^G.

See #356.

Author: byorgey

data/scenarios/03Challenges/00-test.yaml

@@ -1,13 +1,7 @@
 name: Test challenge
 description: A very difficult challenge that will test the utmost limits of your ability to 'move' and 'grab'. This is actually a placeholder challenge and will be replaced with more suitable challenges soon.
-entities:
-  - name: goal
-    display:
-      attr: device
-      char: 'X'
-    description:
-    - Use your grabber to harvest a lambda.
-    properties: [portable]
+goal:
+  - Use your grabber to harvest a lambda.
 win: |
   try {
     as base {has "lambda"}
@@ -23,7 +17,6 @@ robots:
       - logger
       - grabber
     inventory:
-      - [1, goal]
       - [0, lambda]
 world:
   default: [blank, none]

data/scenarios/03Challenges/01-chess_horse.yaml

@@ -1,19 +1,11 @@
 name: Chess Knight
 description: In this quirky challenge, you move as the chess knight piece. Can you capture the enemy king?
+goal:
+  - Robots can use the 'move' command to move.
+    But they only 'turn' in cardinal directions. 
+  - You are special. You are a knight. 
+  - Go forth and capture the King!
 entities:
-  - name: goal
-    display:
-      attr: device
-      char: 'X'
-    description:
-    - |
-      Robots can use the 'move' command to move.
-      But they only 'turn' in cardinal directions. 
-
-      You are special. You are a knight. 
-
-      Go forth and capture the King!
-    properties: [portable]
   - name: knownwater
     display:
       attr: water
@@ -38,8 +30,7 @@ robots:
     devices:
       - treads
       - logger
-    inventory:
-      - [1, goal]
+    inventory: []
     display:
       char: '♘'
   - name: king

data/scenarios/03Challenges/02-drill_test.yaml

@@ -1,5 +1,7 @@
 name: Test drill
 description: This is a developer playground and will be replaced with more suitable challenges soon.
+goal:
+    - Send robots to mine rock, iron and copper.
 win: |
   try {
     i <- as base {has "iron ore"};
@@ -20,7 +22,6 @@ robots:
       - plasma cutter
       - 3D printer
     inventory:
-      - [1, goal]
       - [2, metal drill]
       - [1, drill]
       - [3, logger]
@@ -49,15 +50,7 @@ world:
     │..AAA│                                                                ~~
     │....C│                                                                 ~
     └─────┘                                                                 ~
-entities:
-  - name: goal
-    display:
-      attr: device
-      char: 'X'
-    description:
-    - Send robots to mine rock, iron and copper.
-    properties: [portable]
-  
+entities:  
   ## KNOWN ENTITIES
   - name: knownwater
     display:

data/scenarios/03Challenges/03-teleport.yaml

@@ -1,53 +1,10 @@
 name: Portal room
 description: An impossible challenge - can you magically jump across the water?
-entities:
-  - name: goal
-    display:
-      attr: device
-      char: 'X'
-    description:
-    - Get to the other room and grab the lambda.
-    - Oh wait.
-    - The tunnel is flooded.
-    - Just give up then. It is impossible to get there.
-    properties: [portable]
-  ## KNOWN ENTITIES
-  - name: knownwater
-    display:
-      attr: water
-      char: ' '
-    description:
-    - An infinite ocean of water.
-    properties: [known, portable, growable, liquid]
-    growth: [0,0]
-    yields: water
-  - name: knownwavywater
-    display:
-      attr: water
-      char: '~'
-    description:
-    - An infinite ocean of water.
-    properties: [known, portable, growable, liquid]
-    growth: [0,0]
-    yields: water
-  - name: knowntree
-    display:
-      attr: plant
-      char: 'T'
-    description:
-    - A tree.
-    properties: [portable, growable, known]
-    yields: tree
-    growth: [500, 600]
-  - name: knownflower
-    display:
-      attr: flower
-      char: '*'
-    description:
-    - A flower.
-    yields: flower
-    properties: [known]
-
+goal:
+  - Get to the other room and grab the lambda.
+  - Oh wait.
+  - The tunnel is flooded.
+  - Just give up then. It is impossible to get there.
 win: |
   try {
     as base {has "lambda"}
@@ -63,7 +20,6 @@ robots:
       - logger
       - grabber
     inventory:
-      - [1, goal]
       - [0, lambda]
   - name: portkey1
     system: true
@@ -121,4 +77,41 @@ world:
     │_....._   _..λ.._│  
     └┐.....┌───┐*...T┌┘ ~
     ~└─────┘ ~~└─────┘~  
-    ~~~   ~        ~    ~
+    ~~~   ~        ~    ~
+entities:
+  ## KNOWN ENTITIES
+  - name: knownwater
+    display:
+      attr: water
+      char: ' '
+    description:
+    - An infinite ocean of water.
+    properties: [known, portable, growable, liquid]
+    growth: [0,0]
+    yields: water
+  - name: knownwavywater
+    display:
+      attr: water
+      char: '~'
+    description:
+    - An infinite ocean of water.
+    properties: [known, portable, growable, liquid]
+    growth: [0,0]
+    yields: water
+  - name: knowntree
+    display:
+      attr: plant
+      char: 'T'
+    description:
+    - A tree.
+    properties: [portable, growable, known]
+    yields: tree
+    growth: [500, 600]
+  - name: knownflower
+    display:
+      attr: flower
+      char: '*'
+    description:
+    - A flower.
+    yields: flower
+    properties: [known]

src/Swarm/Game/Entity.hs

@@ -115,7 +115,7 @@ import Swarm.Util.Yaml
 import Swarm.Game.Display
 import Swarm.Language.Capability
 import Swarm.Language.Syntax (toDirection)
-import Swarm.Util (plural, (?))
+import Swarm.Util (plural, reflow, (?))
 
 import Paths_swarm
 
@@ -339,8 +339,6 @@ instance FromJSON Entity where
               <*> v .:? "capabilities" .!= []
               <*> pure empty
           )
-   where
-    reflow = T.unwords . T.words
 
 -- | If we have access to an 'EntityMap', we can parse the name of an
 --   'Entity' as a string and look it up in the map.

src/Swarm/Game/Scenario.hs

@@ -27,6 +27,7 @@ module Swarm.Game.Scenario (
   -- ** Fields
   scenarioName,
   scenarioDescription,
+  scenarioGoal,
   scenarioCreative,
   scenarioSeed,
   scenarioEntities,
@@ -78,13 +79,15 @@ import Swarm.Game.Terrain
 import Swarm.Game.World
 import Swarm.Game.WorldGen (Seed, findGoodOrigin, testWorld2FromArray)
 import Swarm.Language.Pipeline (ProcessedTerm)
+import Swarm.Util (reflow)
 import Swarm.Util.Yaml
 
 -- | A 'Scenario' contains all the information to describe a
 --   scenario.
 data Scenario = Scenario
   { _scenarioName :: Text
   , _scenarioDescription :: Text
+  , _scenarioGoal :: Maybe [Text]
   , _scenarioCreative :: Bool -- Maybe generalize this to a mode enumeration
   , _scenarioSeed :: Maybe Int
   , _scenarioEntities :: EntityMap
@@ -103,6 +106,7 @@ instance FromJSONE EntityMap Scenario where
     Scenario
       <$> liftE (v .: "name")
       <*> liftE (v .:? "description" .!= "")
+      <*> liftE ((fmap . fmap . map) reflow (v .:? "goal"))
       <*> liftE (v .:? "creative" .!= False)
       <*> liftE (v .:? "seed")
       <*> pure em
@@ -115,9 +119,14 @@ instance FromJSONE EntityMap Scenario where
 -- | The name of the scenario.
 scenarioName :: Lens' Scenario Text
 
--- | A description of the scenario.
+-- | A high-level description of the scenario, shown /e.g./ in the
+--   menu.
 scenarioDescription :: Lens' Scenario Text
 
+-- | An explanation of the goal of the scenario (if any), shown to the
+--   player during play.
+scenarioGoal :: Lens' Scenario (Maybe [Text])
+
 -- | Whether the scenario should start in creative mode.
 scenarioCreative :: Lens' Scenario Bool