Merge remote-tracking branch 'upstream/master' into kraid-brin-farms

Author: blkerby

helpers.json

@@ -285,6 +285,27 @@
         {
           "name": "h_ShinesparksCostEnergy",
           "requires": []
+        },
+        {
+          "name": "h_equipmentScreenCycleFrames",
+          "requires": [
+            {"cycleFrames": 300}
+          ],
+          "note": [
+            "This represents the amount of time that could be required in the pause menu to equip or unequip items."
+          ],
+          "devNote": [
+            "This is not perfectly precise as the time spent in the pause menu can vary,",
+            "depending on which items are collected and which items are being equipped or unequipped.",
+            "It is intended as a typical value for common actions such as performing a Gravity jump or mid-air Spring Ball jump."
+          ]
+        },
+        {
+          "name": "h_doubleEquipmentScreenCycleFrames",
+          "requires": [
+            "h_equipmentScreenCycleFrames",
+            "h_equipmentScreenCycleFrames"
+          ]
         }
       ]
     },

logicalRequirements.md

@@ -206,13 +206,18 @@ __Example:__
 ```
 
 #### cycleFrames object
-A `cycleFrames` object represents the need for Samus to spend time (measured as an amount of in-game frames) in a room as part of a farming cycle. Including a `cycleFrames` requirement is mandatory in farming strats with a [`farmCycleDrops`](strats.md#farm-cycle-drops) property. The `cycleFrames` can be used to determine how many cycles of a farm a player can reasonably be expected to perform, based on an assumed amount of "patience".
+A `cycleFrames` object represents the need for Samus to spend time (measured as an amount of in-game frames) in a room as part of a farming cycle. Including a `cycleFrames` requirement is mandatory in farming strats with a [`farmCycleDrops`](strats.md#farm-cycle-drops) property. The `cycleFrames` can be used to determine how many cycles of a farm a player can reasonably be expected to perform, based on an assumed amount of "patience". The frame counts listed tend to be somewhat optimized, so it recommended to apply a lenience factor based on difficulty.
 
 __Example:__
 ```json
 {"cycleFrames": 100}
 ```
 
+#### simpleCycleFrames object
+
+A `simpleCycleFrames` object represents the need for Samus to spend time (measured as an amount of in-game frames) in a room as part of a farming cycle. It is identical to `cycleFrames` except that the time spent in `simpleCycleFrames` is intended to be invariant, not affected by leniency. This can be useful in cases that involve doing something simple for a significant amount of time, such as standing in place while farming bugs.
+
+
 #### heatFrames object
 A `heatFrames` object represents the need for Samus to spend time (measured in frames) in a heated room. This is meant to be converted to a flat health value based on item loadout. The vanilla damage for heated rooms is 1 damage every 4 frames, negated by Varia or Gravity Suit. The effect of Gravity suit on heat damage may be modified by randomizers. A `heatFrames` object implicitly includes a requirement `{"or": ["h_heatProof", "canHeatRun"]}`.
 
@@ -223,7 +228,11 @@ __Example:__
 
 __Additional considerations__
 
-Much like the other logical elements that represent environmental frame damage, the heat frame counts listed in this project might not be strictly "perfect" play, but they are very much unforgiving. Their most significant value is to provide relative lengths to different heat runs. It's recommended to apply a leniency factor to those, possibly as an option that can vary by difficulty.
+Much like the other logical elements that represent environmental frame damage, the heat frame counts listed in this project might not be strictly "perfect" play, but they are very much unforgiving. Their most significant value is to provide relative lengths to different heat runs. It's recommended to apply a lenience factor to those, possibly as an option that can vary by difficulty.
+
+#### simpleHeatFrames object
+
+A `simpleHeatFrames` object represents the need for Samus to spend time (measured in frames) in a heated room. It is identical to `heatFrames` except that the time spent in `simpleHeatFrames` is intended to be invariant, not affected by leniency. This can be useful in cases that involve doing something simple for a significant amount of time, such as standing in place or running through a long hallway.
 
 #### heatFramesWithEnergyDrops object
 
@@ -242,6 +251,22 @@ __Example:__
 }}
 ```
 
+#### lavaFramesWithEnergyDrops object
+
+A `lavaFramesWithEnergyDrops` object represents the need for Samus to spend time in lava, but with the possibility of offsetting some of the lava damage using energy drops from enemies. Any lava damage is logically applied before the energy gain, so Samus must be able to survive the heat before picking up the drops. Any energy gain is logically capped to not exceed the heat damage, so this logical requirement cannot result in a net energy gain.
+
+The actual amount of energy gained typically depends on RNG and also on which ammo types are completely full. The drop probabilities for each enemy type is given in the [enemies](enemies/main.json) file. Because of the randomness involved, the logical amount of energy gain is open to various interpretations. For example, the mean, the median, or a lower confidence limit could be used.
+
+__Example:__
+```json
+{"lavaFramesWithEnergyDrops": {
+  "frames": 200,
+  "drops": [
+    {"enemy": "Fune", "count": 1}
+  ]
+}}
+```
+
 #### gravitylessHeatFrames object
 A `gravitylessHeatFrames` object represents Samus in a heated environment with Gravity Suit turned off, even if it is available. The number of frames here needs to be represented as `heatFrames` without the reduction effects given by Gravity Suit.
 

region/brinstar/blue/Blue Brinstar Energy Tank Room.json

@@ -888,6 +888,7 @@
       "note": "Falling down the shaft and breaking the crumble block does not require Morph."
     },
     {
+      "id": 69,
       "link": [2, 2],
       "name": "Geemer, Skree, and Reo Farm",
       "requires": [
@@ -1446,6 +1447,6 @@
       ]
     }
   ],
-  "nextStratId": 69,
+  "nextStratId": 70,
   "nextNotableId": 8
 }

region/brinstar/blue/Morph Ball Room.json

@@ -364,12 +364,15 @@
       }
     },
     {
+      "id": 73,
       "link": [1, 1],
       "name": "Sidehopper Farm",
       "requires": [
         "h_ZebesIsAwake",
         "canPrepareForNextRoom",
-        {"resetRoom": {"nodes": [1]}},
+        {"resetRoom": {
+          "nodes": [1]
+        }},
         {"or": [
           {"and": [
             "Plasma",
@@ -426,9 +429,7 @@
       ],
       "resetsObstacles": ["A", "B", "D"],
       "clearsObstacles": ["C"],
-      "farmCycleDrops": [
-        {"enemy": "Sidehopper", "count": 3}
-      ]
+      "farmCycleDrops": [{"enemy": "Sidehopper", "count": 3}]
     },
     {
       "id": 10,
@@ -1401,6 +1402,6 @@
     }
   ],
   "notables": [],
-  "nextStratId": 73,
+  "nextStratId": 74,
   "nextNotableId": 1
 }

region/brinstar/green/Brinstar Pre-Map Room.json

@@ -127,6 +127,19 @@
       },
       "flashSuitChecked": true
     },
+    {
+      "id": 27,
+      "link": [1, 1],
+      "name": "Zeela Farm",
+      "requires": [
+        {"resetRoom": {
+          "nodes": [1]
+        }},
+        {"cycleFrames": 120}
+      ],
+      "farmCycleDrops": [{"enemy": "Zeela", "count": 1}],
+      "resetsObstacles": ["A"]
+    },
     {
       "id": 2,
       "link": [1, 1],
@@ -433,12 +446,30 @@
         {"resetRoom": {
           "nodes": [2]
         }},
-        {"partialRefill": {"type": "Energy", "limit": 240}},
-        {"partialRefill": {"type": "Missile", "limit": 20}},
-        {"partialRefill": {"type": "Super", "limit": 4}}
+        {"cycleFrames": 320},
+        {"or": [
+          "canDodgeWhileShooting",
+          "Plasma",
+          {"and": [
+            "Wave",
+            "Spazer"
+          ]},
+          {"and": [
+            "Ice",
+            "Wave"
+          ]},
+          {"and": [
+            "Ice",
+            "Spazer"
+          ]}
+        ]}
       ],
       "resetsObstacles": ["A"],
-      "flashSuitChecked": true
+      "flashSuitChecked": true,
+      "farmCycleDrops": [
+        {"enemy": "Zeela", "count": 2},
+        {"enemy": "Sm. Sidehopper", "count": 1}
+      ]
     },
     {
       "id": 24,
@@ -472,6 +503,6 @@
     }
   ],
   "notables": [],
-  "nextStratId": 27,
+  "nextStratId": 28,
   "nextNotableId": 1
 }

region/brinstar/green/Early Supers Room.json

@@ -272,8 +272,9 @@
       "link": [1, 1],
       "name": "Zeb Farm",
       "requires": [
-        {"refill": ["Energy", "Missile", "Super"]}
+        {"cycleFrames": 105}
       ],
+      "farmCycleDrops": [{"enemy": "Zeb", "count": 1}],
       "flashSuitChecked": true
     },
     {
@@ -802,6 +803,48 @@
         "leaveWithTemporaryBlue": {}
       }
     },
+    {
+      "id": 47,
+      "link": [2, 2],
+      "name": "Waver and Sidehopper Farm",
+      "requires": [
+        {"resetRoom": {
+          "nodes": [2]
+        }},
+        {"or": [
+          "canWalljump",
+          "canCrouchJump"
+        ]},
+        {"or": [
+          {"and": [
+            "Plasma",
+            {"cycleFrames": 600}
+          ]},
+          {"and": [
+            "ScrewAttack",
+            {"cycleFrames": 700}
+          ]},
+          {"and": [
+            {"or": [
+              "Wave",
+              "Spazer"
+            ]},
+            {"cycleFrames": 750}
+          ]},
+          {"and": [
+            "canDodgeWhileShooting",
+            {"cycleFrames": 1050}
+          ]}
+        ]}
+      ],
+      "farmCycleDrops": [
+        {"enemy": "Waver", "count": 4},
+        {"enemy": "Sm. Sidehopper", "count": 3}
+      ],
+      "clearsObstacles": ["A"],
+      "resetsObstacles": ["B"],
+      "flashSuitChecked": true
+    },
     {
       "id": 30,
       "link": [2, 2],
@@ -922,6 +965,6 @@
       ]
     }
   ],
-  "nextStratId": 47,
+  "nextStratId": 48,
   "nextNotableId": 4
 }