feat: Documentation update

README.md

@@ -15,29 +15,34 @@ See https://alttpr.com/ for more details on the normal randomizer.
       4. [Door Type Shuffle](#door-type-shuffle)
       5. [Trap Door Removal](#trap-door-removal)
       6. [Key Logic Algorithm](#key-logic-algorithm)
+      7. [Dungeon Items](#dungeon-items)
       7. [Decouple Doors](#decouple-doors)
-      8. [Pottery](#pottery)
+      1. [Allow Self-Looping Spiral Stairs](#allow-self-looping-spiral-stairs)
-      9. [Small Key Shuffle](#small-key-shuffle)
+      8. [Experimental Features](#experimental-features)
-      10. [Shuffle Enemy Key Drops](#shuffle-enemy-key-drops)
+      9. [Crossed Dungeon Specific Settings](#crossed-dungeon-specific-settings)
-      11. [Experimental Features](#experimental-features)
+   2. [Pool Expansions](#pool-expansions)
-      12. [Crossed Dungeon Specific Settings](#crossed-dungeon-specific-settings)
+      1. [Pottery](#pottery)
-   2. [Item Randomization Changes](#item-randomization)
+      2. [Small Key Shuffle](#small-key-shuffle)
+      3. [Shuffle Enemy Drops](#shuffle-enemy-drops) 
+      4. [Take Any Caves](#take-any-caves)
+   3. [Item Randomization Changes](#item-randomization)
       1. [New "Items"](#new-items)
       2. [Shopsanity](#shopsanity)
       3. [Logic Level](#logic-level)
       4. [Goal](#goal)
       5. [Item Sorting](#item-sorting)
       6. [Forbidden Boss Items](#forbidden-boss-items)
-   3. [Customizer](#customizer)
+   4. [Customizer](#customizer)
-   4. [Entrance Randomization](#entrance-randomization)
+   5. [Entrance Randomization](#entrance-randomization)
       1. [Shuffle Links House](#shuffle-links-house)
       2. [Overworld Map](#overworld-map)
-   5. [Enemizer](#enemizer)
+   6. [Enemizer](#enemizer)
-   6. [Retro Changes](#retro-changes)
+   7. [Glitched Logic](#glitched-logic)
-   7. [Standard Changes](#standard-changes)
+   8. [Retro Changes](#retro-changes)
-   8. [Game Options](#game-options)
+   8. [Standard Changes](#standard-changes)
-   9. [Generation Setup & Miscellaneous](#generation-setup--miscellaneous)
+   9. [Game Options](#game-options)
-   10. [Glitched Logic](#glitched-logic)
+   10. [Generation Setup & Miscellaneous](#generation-setup--miscellaneous)
+   
 
 ## Setup and Installation
 
@@ -128,13 +133,6 @@ CLI: `--doorShuffle [vanilla|basic|partitioned|crossed]`
 * Level 2 - Same as Level 1 plus open edges and both types of straight staircases are shuffled.
 * Level 3 -  Same as Level 2 plus Dungeon Lobbies are shuffled
 
-### Key Drop Shuffle (Legacy) (--keydropshuffle)
-
-Adds 33 new locations to the randomization pool. The 32 small keys found under pots and dropped by enemies and the Big
-Key drop location are added to the pool. The keys normally found there are added to the item pool. Retro adds
-32 generic keys to the pool instead. This has been can be controlled more granularly with the [Pottery](#pottery) and 
-[Shuffle Enemy Key Drops](#shuffle-enemy-key-drops)
-
 ### Door Type Shuffle
 
 Four options here, and all of them only take effect if Dungeon Door Shuffle is not vanilla:
@@ -161,11 +159,23 @@ In all cases, that the trap door near the mire cutscene chest (Mire Warping Pool
 
 CLI: `--trap_door_mode [vanilla|optional|boss|oneway]`
 
+### Dungeon Items
+
+#### Small Keys
+
+* In Dungeon: Small keys are restricted to their own dungeon
+* Randomized: Small keys to dungeon can be found anywhere 
+* Universal: Small keys are not specific to their own dungeon, can be found anywhere, and there will be at least one shop that sells keys. Hearkens back to the original Legend of Zelda.
+
+CLI: `--keyshuffle [none|wild|universal]`
+
+All other dungeon items can be restricted to their own dungeon or shuffled in the general pool. This includes maps, compasses and Big Keys.
+
 ### Key Logic Algorithm
 
 Determines how small key door logic works.
 
-* Default: Current key logic. Assumes worse case usage, placement checks, but assumes you can't get to a chest until you have sufficient keys. (May assume items are unreachable)
+* ~~Default: Current key logic. Assumes worse case usage, placement checks, but assumes you can't get to a chest until you have sufficient keys. (May assume items are unreachable)~~ (Not recommended to use this setting)
 * Partial Protection: Assumes you always have full inventory and worse case usage. This should account for dark room and bunny revival glitches.
 * Strict: For those would like to glitch and be protected from yourselves. Small keys door require all small keys to be available to be in logic.
 
@@ -177,60 +187,12 @@ This is similar to insanity mode in ER where door entrances and exits are not pa
 
 CLI: `--decoupledoors`
 
-### Self-Looping Spiral Stairs
+### Allow Self-Looping Spiral Stairs
 
 If enabled, spiral stairs are allowed to lead to themselves.
 
 CLI: `--door_self_loops`
 
-### Pottery
-
-New pottery option that control which pots (and large blocks) are in the locations pool:
-
-* None: No pots are in the pool, like normal randomizer
-* Key Pots: The pots that have keys are in the pool. This is about half of the old keydropshuffle option
-* Cave Pots: The pots that are not found in dungeons are in the pool. (Includes the large block in Spike Cave). Does
-  not include key pots.
-* Cave + Keys Pots: Both non-dungeon pots and pots that used to have keys are in the pool.
-* Reduced Dungeon Pots: Same as Cave+Keys but also roughly a quarter of dungeon pots are added to the location pool picked at random. This is a dynamic mode so pots in the pool will be colored. Pots out of the pool will have vanilla contents.
-* Clustered Dungeon Pots: Like reduced but pots are grouped by logical sets and roughly 50% of pots are chosen from those groups. This is a dynamic mode like the above.
-* Excludes Empty Pots: All pots that had some sort of objects under them are chosen to be in the location pool. This excludes most large blocks and some pots out of dungeons.
-* Dungeon Pots: The pots that are in dungeons are in the pool. (Includes serveral large blocks)
-* Lottery: All pots and large blocks are in the pool.
-
-By default, switches remain in their vanilla location (unless you turn on the legacy option below)
-
-CLI `--pottery <option>` from `none, keys, cave, cavekeys, reduced, clustered, nonempty, dungeon, lottery`
-
-Note for multiworld: due to the design of the pottery lottery, only 256 items for other players can be under pots in your world.
-
-#### Colorize Pots
-
-If the pottery mode is dynamic, this option is forced to be on (clustered and reduced). It is allowed to be on in all other pottery modes. Exceptions include "none" where no pots would be colored, and "lottery" where all pots would be. This option colors the pots differently that have been chosen to be part of the location pool. If not specified, you are expected to remember the pottery setting you chose. Note that Mystery will colorize all pots if lottery is chosen randomly.
-
-CLI `--colorizepots`
-
-#### Pot Shuffle (Legacy)
-
-This continues to works the same by shuffling all pots on a supertile. It works with the lottery option as well to move the switches to any valid pot on the supertile regardless of the pots chosen in the pottery mode. This may increase the number of pot locations slightly depending on the mode.
-
-### Small Key Shuffle
-
-There are three options now available:
-
-* In Dungeon: The small key will be in their own dungeon
-* Randomized: Small keys can be shuffled outside their own dungeon
-* Universal: Retro keys without the other options
-
-CLI: `--keyshuffle [none|wild|universal]`
-
-### Shuffle Enemy Key Drops
-
-Enemies that drop keys can have their drop shuffled into the pool. This is the one part of the keydropshuffle option.
-See the pottery option for more options involving pots.
-
-CLI: `--dropshuffle`
-
 ### Experimental Features
 
 You will start as a bunny if your spawn point is in the dark world. CLI: `--experimental`
@@ -264,6 +226,64 @@ No effect if door shuffle is not on crossed
   Rooms adjacent to sanctuary get their coloring to match the Sanctuary's original palette.
 * Original: Rooms/supertiles keep their original palettes.
 
+## Pool Expansions
+
+### Pottery
+
+New pottery option that control which pots (and large blocks) are in the locations pool:
+
+* None: No pots are in the pool, like normal randomizer
+* Key Pots: The pots that have keys are in the pool. This is about half of the old keydropshuffle option
+* Cave Pots: The pots that are not found in dungeons are in the pool. (Includes the large block in Spike Cave). Does
+  not include key pots.
+* Cave + Keys Pots: Both non-dungeon pots and pots that used to have keys are in the pool.
+* Reduced Dungeon Pots: Same as Cave+Keys but also roughly a quarter of dungeon pots are added to the location pool picked at random. This is a dynamic mode so pots in the pool will be colored. Pots out of the pool will have vanilla contents.
+* Clustered Dungeon Pots: Like reduced but pots are grouped by logical sets and roughly 50% of pots are chosen from those groups. This is a dynamic mode like the above.
+* Excludes Empty Pots: All pots that had some sort of objects under them are chosen to be in the location pool. This excludes most large blocks and some pots out of dungeons.
+* Dungeon Pots: The pots that are in dungeons are in the pool. (Includes serveral large blocks)
+* Lottery: All pots and large blocks are in the pool.
+
+By default, switches remain in their vanilla location (unless you turn on the legacy option below)
+
+CLI `--pottery <option>` from `none, keys, cave, cavekeys, reduced, clustered, nonempty, dungeon, lottery`
+
+Note for multiworld: due to the design of the pottery lottery, only 256 items for other players can be under pots in your world.
+
+#### Colorize Pots
+
+If the pottery mode is dynamic, this option is forced to be on (clustered and reduced). It is allowed to be on in all other pottery modes. Exceptions include "none" where no pots would be colored, and "lottery" where all pots would be. This option colors the pots differently that have been chosen to be part of the location pool. If not specified, you are expected to remember the pottery setting you chose. Note that Mystery will colorize all pots if lottery is chosen randomly.
+
+CLI `--colorizepots`
+
+#### Pot Shuffle (Legacy)
+
+This continues to works the same by shuffling all pots on a supertile. It works with the lottery option as well to move the switches to any valid pot on the supertile regardless of the pots chosen in the pottery mode. This may increase the number of pot locations slightly depending on the mode.
+
+### Shuffle Enemy Drops
+
+Option that controls whether enemies that drop items are randomized or not.
+
+* None: Special enemies drop keys normally
+* Keys: Enemies that drop keys are added to the randomization pool. Includes the Hyrule Castle Big Key. Universal adds
+   generic keys to the pool instead.
+* Underworld: Enemies in the underworld are added to the randomization pool. Vanilla drops from the various drop tables are added to the item pool. In caves and in dungeons while you have the compass, a blue square will indicate if there are any enemies on the supertile that still have an available drop in the dungeon. Certain enemies do have logical requirements. In particular, the Red Bari requires Fire Rod or Bombos to collect it's drop. More information in hte [Enemizer](#enemizer) section.
+
+CLI: `--dropshuffle [none|keys|underworld]`
+
+### Enable Key Drop Shuffle (Legacy)
+
+This sets Pottery to "Key Pots" and Shuffle Enemy Drop to "Keys" unless those option have already been changed.
+
+### Take Any Caves
+
+These are now independent of retro mode and have three options: None, Random, and Fixed. None disables the caves. Random works as take-any caves did before. Fixed means that the take any caves replace specific fairy caves in the pool and will be at those entrances unless ER is turned on (then they can be shuffled wherever). The fixed entrances are:
+
+* Desert Healer Fairy
+* Swamp Healer Fairy (aka Light Hype Cave)
+* Dark Death Mountain Healer Fairy
+* Dark Lake Hylia Ledge Healer Fairy (aka Shopping Mall Bomb)
+* Bonk Fairy (Dark)
+
 ## Item Randomization
 
 ### New "Items"
@@ -400,12 +420,6 @@ Arrow Capacity upgrades are now replaced by Rupees wherever it might end up.
  
 The Ten Arrows and 5 randomly selected Small Hearts or Blue Shields are replaced by the quiver item (represented by the Single Arrow in game.) 5 Red Potion refills are replaced by the Universal small key. It is assured that at least one shop sells Universal Small Keys. The quiver may thus not be found in shops. The quiver and small keys retain their original base price, but may be discounted.
 
-### Logic Level
-
-Overworld Glitches is now supported.
-
-CLI: `--logic owglitches`
-
 ### Goal
 
 New supported goals:
@@ -499,7 +513,9 @@ Please see [Customizer documentation](docs/Customizer.md) on how to create custo
 
 ### New Modes
 
-Lite and Lean ER is now available when Experimental Features are turned on. (todo: bring over documenation of these modes)
+* Lite: Non item entrances are vanilla.
+* Lean
+* Swapped: Entrances are swapped with each other
 
 ### Shuffle Links House
 
@@ -523,16 +539,42 @@ If you do not shuffle the compass or map outside of the dungeon, the non-shuffle
 CLI ```--overworld_map [default|compass|map]```
 
 
-
 ## Enemizer
 
+Enemizer has been incorporated into the generator adn no longer requires an external program. However, there are differences.
+
+A document hightlighting the major changes: [Enemizer in DR](https://docs.google.com/document/d/1iwY7Gy50DR3SsdXVaLFIbx4xRBqo9a-e1_jAl5LMCX8/edit?usp=sharing)
+
+### Enemy Shuffle
+
+Shuffling enemies is different as there are places that certain enemies are not allowed to go. This is known as the enemy ban list, and is updated regularly as report of poor enemy placement occurs. Poor enemy placement included Bumpers, Statues, Beamos or other enemies that block your path with or without certain items. Other disallowed placements include unavoidable damage and glitches. Thieves are unkillable, but restricted to the overworld and even then, are banned from narrow locations.
+
+### Enemy Damage
+
+The shuffled setting actually shuffled the damage table unlike the process from the enemizer that simply randomizes values and lowers damage for armor upgrades.
+
 ### Boss Shuffle: Unique
 
-At least one boss each of the prize bosses will be present guarding the prizes. GT bosses can be anything.
+Same as before, with some exceptions: 
 
-### Blind Note
+* Trinexx is not allowed on the GT basement when DR is enabled to avoid certain low percentage kills. Future work on health logic should make this reasonable.
+* In general, some of the harder bosses in the GT basement now have some concessions in the logic to make low precentage requirements less likely and onerous.
 
-If bosses are shuffled and Blind is chosen to be the boss of Thieves Town, then bombing the attic and delivering the maiden is still required.
+New variant Unique: At least one boss each of the prize bosses will be present guarding the prizes. GT bosses can be anything.
+
+Blind Note: If bosses are shuffled and Blind is chosen to be the boss of Thieves Town, then bombing the attic and delivering the maiden is still required.
+
+### Enemy Health
+
+Same as beofre but health is taken into account for challenge rooms if magic or ammo is required
+
+### Enemy Logic
+
+This version of the enemizer can account for logical access to both challenge room and item or key drops when enemies are shuffled. (See [Enemy Drop Shuffle](#shuffle-enemy-drops)). The enemies with particularly special logic are: Red Mimics, Red Eyegores, Terrorpins, Deadrocks, & Lynels. When bombbag is enabled Stalfos Knights, and Buzzblobs have advanced logic. For enemy drops, in particular, Red Baris must be killed with either the Fire Rod or Bombos to acquire the drop. These are in effect unless a different option is chosen:
+
+* Forbid special enemies: These special enemies are disallowed from drops and challenge rooms.
+* Item drops may have special enemies: Challenge rooms will not have these special enemies, but item drops may.
+* Allow special enemies anywhere: Both challenge rooms and enemy drops can have these special requirements occur.
 
 ## Standard Changes
 
@@ -540,19 +582,42 @@ When dungeon door shuffle is on, the Sanctuary is guaranteed to be behind the Th
 
 ## Retro Changes
 
-Retro can be partially enabled: see Small Key Shuffle and Bow Mode. Retro checkbox or Retro mode still enable all 3 options.
+Retro can be partially enabled: see Small Key Shuffle, Bow Mode, and Take Any Caves. Enable Retro button enables all 3 options.
 
-New supported option:
+## Glitched Logic
 
-### Take Any Caves
+Overworld glitches, Hybrid Major Glitches (HMG) and No Logic are currently supported.
 
-These are now independent of retro mode and have three options: None, Random, and Fixed. None disables the caves. Random works as take-any caves did before. Fixed means that the take any caves replace specific fairy caves in the pool and will be at those entrances unless ER is turned on (then they can be shuffled wherever). The fixed entrances are:
+CLI: `--logic [noglitches|owglitches|hybridglitches|nologic]`
+
+### Overworld Glitches
+_Support added by qadan and compiling_
+
+Overworld Glitches logic includes (but is not limited to) the following:
+* Overworld teleports and clips to reach various items/entrances
+* Use of superbunny to obtain items and/or bonk open entrances
+* Use of mirror to access Desert Palace East Entrance
+* Use of bunny pocket to access the Back of Skull Woods and VOO Hammer house entrances
+
+
+### Hybrid Major Glitches
+_Support added by Muffins (ported from work by Espeon)_.
+
+**Not currently compatible with Door Shuffle**
+
+Hybrid Major Glitches logic includes the following:
+* All Overworld Glitches logic
+* Kikiskip to access PoD wihtout MP or DW access
+* IP Lobby clip to skip fire requirement
+* Traversal between TT -> Desert
+* Traversal between Spec rock upper -> Spec rock mid
+* Traversal between Paradox lower -> Paradox mid + upper
+* Traversal between Mire -> Hera -> Swamp
+* Stealing SK from Mire to open SP
+* Using the Mire big key to open Hera doors and big chest
+
+All traversals mentioned are considered connectors in entrance shuffle
 
-* Desert Healer Fairy
-* Swamp Healer Fairy (aka Light Hype Cave)
-* Dark Death Mountain Healer Fairy
-* Dark Lake Hylia Ledge Healer Fairy (aka Shopping Mall Bomb)
-* Bonk Fairy (Dark)
 
 ## Game Options
 
@@ -598,34 +663,3 @@ Can be used to set a seed number to generate. Using the same seed with same sett
 Use to batch generate multiple seeds with same settings. If a seed number is provided, it will be used for the first seed, then used to derive the next seed (i.e. generating 10 seeds with the same seed number given will produce the same 10 (different) roms each time).
 
 
-## Glitched Logic
-
-Overworld glitches, Hybrid Major Glitches (HMG) and No Logic are currently supported.
-
-### Overworld Glitches
-_Support added by qadan and compiling_
-
-Overworld Glitches logic includes (but is not limited to) the following:
-* Overworld teleports and clips to reach various items/entrances
-* Use of superbunny to obtain items and/or bonk open entrances
-* Use of mirror to access Desert Palace East Entrance
-* Use of bunny pocket to access the Back of Skull Woods and VOO Hammer house entrances
-
-
-### Hybrid Major Glitches
-_Support added by Muffins (ported from work by Espeon)_.
-
-**Not currently compatible with Door Shuffle**
-
-Hybrid Major Glitches logic includes the following:
-* All Overworld Glitches logic
-* Kikiskip to access PoD wihtout MP or DW access
-* IP Lobby clip to skip fire requirement
-* Traversal between TT -> Desert
-* Traversal between Spec rock upper -> Spec rock mid
-* Traversal between Paradox lower -> Paradox mid + upper
-* Traversal between Mire -> Hera -> Swamp
-* Stealing SK from Mire to open SP
-* Using the Mire big key to open Hera doors and big chest
-
-All traversals mentioned are considered connectors in entrance shuffle