diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml new file mode 100644 index 00000000..23a1ada4 --- /dev/null +++ b/.github/workflows/deploy-pages.yml @@ -0,0 +1,81 @@ +# GitHub Pages Deployment Workflow +name: πŸ“„ Deploy GitHub Pages + +# Deploy on push to DoorDevUnstable branch +on: + push: + branches: + - DoorDevUnstable + # Allow manual trigger + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment +concurrency: + group: "pages" + cancel-in-progress: true + +jobs: + # Build job + build: + name: πŸ”¨ Build Site + runs-on: ubuntu-latest + steps: + - name: βœ”οΈ Checkout + uses: actions/checkout@v4 + + - name: πŸ’Ž Setup Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: '3.1' + bundler-cache: false + + - name: πŸ’Ώ Install dependencies + run: | + gem install bundler + bundle config set --local path 'vendor/bundle' + # Create Gemfile if it doesn't exist + if [ ! -f Gemfile ]; then + cat > Gemfile << 'EOF' + source 'https://rubygems.org' + gem 'github-pages', group: :jekyll_plugins + gem 'jekyll-feed' + gem 'jekyll-seo-tag' + gem 'jekyll-sitemap' + gem 'just-the-docs' + EOF + fi + bundle install + + - name: πŸ”¨ Build with Jekyll + run: bundle exec jekyll build --baseurl "/ALttPDoorRandomizer" + env: + JEKYLL_ENV: production + + - name: πŸ“€ Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: ./_site + + # Deployment job + deploy: + name: πŸš€ Deploy to GitHub Pages + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: πŸš€ Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 + + - name: βœ… Deployment complete + run: | + echo "πŸŽ‰ GitHub Pages deployed successfully!" + echo "πŸ“„ Site URL: ${{ steps.deployment.outputs.page_url }}" diff --git a/BaseClasses.py b/BaseClasses.py index bf5e35ae..ce4d9ad0 100644 --- a/BaseClasses.py +++ b/BaseClasses.py @@ -329,6 +329,16 @@ class World(object): def is_tile_lw_like(self, owid, player): return (owid >= 0x40 and owid < 0x80) == self.is_tile_swapped(owid, player) + def get_portal_unsafe(self, portal_name, player): + if (portal_name, player) in self._portal_cache: + return self._portal_cache[(portal_name, player)] + else: + for portal in self.dungeon_portals[player]: + if portal.name == portal_name and portal.player == player: + self._portal_cache[(portal_name, player)] = portal + return portal + return None + def is_atgt_swapped(self, player): return self.is_tile_swapped(0x03, player) and self.is_tile_swapped(0x1b, player) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5fe8b5e9..e30bdb7f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,17 @@ # Changelog +# 0.7.0.3 +- Further updates and new yamls for Grid OW Shuffle +- Further customizer options for Grid OW Shuffle like defining screens that should stay together +- Fix buffer sword slash when dashing into water +- Fixed bug with MSU-1 GT2 track not falling back to GT track +- Fix for Kiki unfollowing after certain entrance transition conditions +- Fixed bug/oversight with vanilla_fill and prize_shuffle +- Changed big bomb shop vendor text to be follower agnostic +- Updated crosskeys winners (thanks clearmouse) +- Fixed bug with potential locale determination (thanks Esme) +- \~Merged in DR v1.5.6~ + # 0.7.0.2 - Fixed money error for bombbag/take-anys - Fixed palette issue for map check/flute menu diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 00000000..a67098ad --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,257 @@ +# CLAUDE.md + +This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. + +## Project Overview + +**ALttPDoorRandomizer** is a sophisticated dungeon and door randomizer for *The Legend of Zelda: A Link to the Past* (SNES). It extends the standard ALTTP Entrance Randomizer with advanced dungeon shuffling capabilities that can rearrange dungeon interiors at the door and sector level. + +- **Repository**: https://github.com/aerinon/ALttPDoorRandomizer +- **Python Version**: 3.10+ +- **Current Branch**: DoorDevUnstable (dev branch: NewGeneration) +- **Discord**: #door-rando and #bug-reports channels at ALTTP Randomizer discord + +## Development Commands + +### Running the Randomizer +```bash +# CLI interface +python DungeonRandomizer.py + +# GUI interface +python Gui.py + +``` + +### Dependencies +```bash +# Install platform-specific dependencies +python resources/ci/common/local_install.py + +# For multiworld server/client +# Run the same command to install multiworld dependencies +``` + +### Testing +```bash +# Run test suite +python TestSuite.py + +# Run test suite with specific door shuffle mode +python TestSuite.py --dr basic --count 10 --tense 2 + +# Individual test files (unittest-based) +python -m pytest test/ +python -m pytest test/dungeons/TestDarkPalace.py +``` + +### ROM Generation +```bash +# Basic door shuffle seed +python DungeonRandomizer.py --doorShuffle crossed --intensity 2 + +# Suppress ROM output (for testing) +python DungeonRandomizer.py --suppress_rom --spoiler none + +# Create BPS patch +python DungeonRandomizer.py --bps +``` + +## Architecture Overview + +### Generation Pipeline + +The randomizer follows this high-level flow (orchestrated in `Main.py`): + +1. **World Setup** β†’ Initialize World object, parse settings, set seed +2. **Region Creation** β†’ Build game regions, locations, entrances (`Regions.py`) +3. **Dungeon Structure** β†’ Create dungeon objects and rooms (`Dungeons.py`, `RoomData.py`) +4. **Door/Entrance Shuffling** β†’ Shuffle dungeon interiors and/or overworld entrances +5. **Logic Rules** β†’ Set access requirements for all locations (`Rules.py`) +6**Item Placement** β†’ Generate item pool and place items with logic constraints (`Fill.py`) +7. **ROM Patching** β†’ Apply changes to base ROM (`Rom.py`) +8. **Output** β†’ Generate ROM file, spoiler log, and/or multiworld data + +### Core Data Structures (BaseClasses.py) + +- **World**: Container for all game state, regions, dungeons, items, and settings +- **Region**: Geographic area with locations and exits +- **Location**: Item placement spot with access rules +- **Item**: Game items with advancement/priority flags +- **Entrance**: Connections between regions with conditional access +- **CollectionState**: Tracks player's collected items for logic evaluation + +### Dungeon Generation System + +The dungeon shuffling system uses a three-stage algorithm: + +#### 1. DungeonGenLocalSearch (source/dungeon/DungeonGenLocalSearch.py) +**Purpose**: Assigns dungeon sectors to dungeons using constraint satisfaction + +**Balancing Constraints**: +- **Polarity**: North/South and East/West door balance +- **Crystal Balance**: Blue/orange barriers must have matching switches +- **Portal Balance**: Entrance distribution +- **Location Balance**: Ensures dungeons have accessible non-big-key locations +- **Branching**: Dead ends vs branches ratio (insufficient branches = unreachable areas) +- **Transitivity**: Validates that doors can actually connect + +**Algorithm**: Local search with greedy constraint satisfaction, prioritizing crystal switches β†’ portals β†’ locations β†’ branching β†’ polarity β†’ transitivity + +#### 2. DungeonGenTransitivity (source/dungeon/DungeonGenTransitivity.py) +**Purpose**: Validates that door connections are possible for a given sector assignment + +**Key Features**: +- Verifies all doors can be validly connected (e.g., North↔South, East↔West, Stairs↔Stairs) +- Propagates crystal switch states through connections +- Detects forced connections and impossible layouts +- Uses depth-first search with constraint propagation +- Handles special mechanics (portals, crystal barriers, special rooms) + +#### 3. DungeonStitcherV2 (source/dungeon/DungeonStitcherV2.py) +**Purpose**: Realizes actual door connections from validated sector assignments + +**Key Features**: +- Generates random valid door pairings +- Assigns portal connections (dungeon entrances) +- Simulates player traversal to verify connectivity +- Manages crystal barrier state propagation + +### Key Logic Components + +**Rules.py** (~7000 lines): Sets logical requirements for accessing locations +- Supports multiple logic modes: noglitches, owglitches, hybridglitches, nologic +- Handles multiple key logic algorithms: partial, strict, dangerous, experimental +- Manages dungeon-specific access rules and boss requirements + +**Fill.py** (~2000 lines): Item placement algorithms +- **Balanced**: Random distribution +- **Vanilla Fill**: Attempts vanilla item locations when possible +- **Major Location Restriction**: Major items β†’ major locations +- **Dungeon Restriction**: Major items β†’ dungeons +- **District Restriction**: Items distributed by geographic region + +**KeyPlacement.py** / **NewKeyLogic.py**: Advanced key door logic +- Handles small key placement with multiple satisfiability algorithms +- Prevents self-locking situations +- Manages big key placement rules +- Validates minimum key requirements for dungeon completion + +### Source Module Organization + +``` +source/ +β”œβ”€β”€ dungeon/ # Dungeon generation algorithms and key logic +β”œβ”€β”€ overworld/ # Entrance shuffling (EntranceShuffle2.py) +β”œβ”€β”€ item/ # Item placement utilities (FillUtil.py, District.py) +β”œβ”€β”€ enemizer/ # Enemy randomization system +β”œβ”€β”€ gui/ # GUI components (tkinter-based) +β”œβ”€β”€ rom/ # ROM patching utilities +β”œβ”€β”€ classes/ # Utility classes (BabelFish, CustomSettings) +β”œβ”€β”€ meta/ # Metadata and build tools +└── limited/ # Limited run coordination +``` + +### Important Files by Size/Complexity + +- **DoorShuffle.py** (~8500 lines): Door shuffling orchestration +- **Rules.py** (~7000 lines): Location access logic +- **EnemyList.py** (~6000 lines): Enemy definitions +- **Doors.py** (~5500 lines): Door object definitions +- **Rom.py** (~5500 lines): ROM patching +- **Regions.py** (~5000 lines): World region creation +- **DungeonGenerator.py** (~5000 lines): Legacy dungeon generation +- **EntranceShuffle2.py** (~5000 lines): Entrance shuffling logic +- **BaseClasses.py** (~4000 lines): Core data structures +- **KeyDoorShuffle.py** (~3500 lines): Key door logic +- **PotShuffle.py** (~3500 lines): Pot randomization + +## Key Concepts + +### Door Shuffle Modes +- **Vanilla**: No shuffling +- **Basic**: Shuffle within each dungeon +- **Partitioned**: Shuffle in pools (Light World, Early Dark World, Late Dark World) +- **Crossed**: Full shuffle between all dungeons + +### Intensity Levels +- **Level 1**: Normal doors and spiral staircases +- **Level 2**: + open edges and straight staircases +- **Level 3**: + dungeon lobbies + +### Key Shuffle Modes +- **In Dungeon** (keyshuffle=none): Keys restricted to their dungeon +- **Randomized** (keyshuffle=wild): Keys can be anywhere +- **Universal** (keyshuffle=universal): Keys work in any dungeon + +### Fill Algorithms (--algorithm) +See Fill.py for implementation details. The algorithm affect where item may be placed. + +### Logic Modes +- **noglitches**: Standard logic +- **owglitches**: Overworld glitches (OOB, clips, superbunny) +- **hybridglitches**: + major underworld glitches (not compatible with door shuffle) +- **nologic**: No logical constraints + +## Testing Strategy + +Tests verify location accessibility with various item combinations: +- **test/dungeons/**: Per-dungeon location access tests +- **test/vanilla/**: Vanilla world logic tests +- **test/owg/**: Overworld glitch logic tests +- **test/inverted/**: Inverted mode tests +- **TestBase.py**: Base test class with utility methods + +Use `TestSuite.py` for batch generation testing across modes (Open/Standard/Inverted) and settings. + +## Important Development Notes + +### Starting Items & Special Items +- **Mirror Scroll**: Dungeon-only mirror (starting item in door shuffle) +- **Bomb Bag**: Optional item that gates bomb usage +- **Pseudo Boots**: Allows dashing but gates certain sequence breaks + +### Branch Structure +- **DoorDev**: Main development branch (use for PRs) +- **DoorDevUnstable**: Current working branch +- **Dev/Master**: Do NOT use for PRs + +### Git Workflow +Recent commits show work on: +- Limited run coordination +- Custom rooms support +- Key logic improvements (transitivity, portal checks, placement rules) +- Isolated region detection fixes +- Big key placement satisfiability + +### Documentation Resources +- **Algorithm.md**: Detailed dungeon generation algorithm documentation +- **docs/ai_context/**: Comprehensive architectural documentation by topic +- **docs/Customizer.md**: Custom seed configuration guide +- **docs/DR_hint_reference.md**: Hint system documentation +- **docs/BUILDING.md**: Build and installation instructions +- **README.md**: User-facing feature documentation + +## Common Gotchas + +1. **Transitivity Checks**: Most expensive constraint check - always run last +2. **Self-Locking Keys**: Key logic must prevent situations where players cannot access the rest of the dungeon +3. **Crystal Barriers**: Blue/orange barriers require matching switches in dungeon +4. **Portal Distribution**: Each dungeon needs at least one entrance +5. **Branching Balance**: Too many dead ends without branches = unreachable areas +6**Polarity Balance**: N/S and E/W door counts must allow valid connections + +## CLI Argument Reference + +Key arguments from `resources/app/cli/args.json`: +- `--doorShuffle [vanilla|basic|partitioned|crossed]` +- `--intensity [1|2|3]` +- `--keyshuffle [none|wild|universal]` +- `--key_logic [partial|strict|dangerous|experimental]` +- `--algorithm [balanced|vanilla_fill|major_only|dungeon_only|district]` +- `--logic [noglitches|owglitches|hybridglitches|nologic]` +- `--mode [open|standard|inverted]` +- `--shuffle`: Entrance randomizer options (vanilla, simple, restricted, full, crossed, insanity, etc.) +- `--pottery`: Pot shuffling modes +- `--shopsanity`: Enable shop item randomization +- `--enemizer`: Enemy randomization options diff --git a/DoorShuffle.py b/DoorShuffle.py index 3ba2584f..e7395566 100644 --- a/DoorShuffle.py +++ b/DoorShuffle.py @@ -105,6 +105,9 @@ def link_doors_prep(world, player): world.get_portal('Turtle Rock Eye Bridge', player).destination = True else: analyze_portals(world, player) + if world.doorShuffle[player] == 'vanilla': # these are always not destinations + world.get_portal('Desert Back', player).destination = False + world.get_portal('Skull 3', player).destination = False for portal in world.dungeon_portals[player]: connect_portal(portal, world, player) @@ -234,11 +237,21 @@ def vanilla_key_logic(world, player): enabled_entrances = world.enabled_entrances[player] = {} builder_queue = deque(builders) last_key, loops = None, 0 + + # --- Precompute all potential portals for each builder using dungeon_portals --- + from DungeonGenerator import dungeon_portals + all_potential_portals_map = {} + for builder in builders: + portal_names = list(dungeon_portals.get(builder.name, [])) + all_potential_portals_map[builder.name] = set(world.get_portal(portal_name, player).door.entrance.parent_region.name for portal_name in portal_names) + while len(builder_queue) > 0: builder = builder_queue.popleft() origin_list = entrances_map[builder.name] find_enabled_origins(builder.sectors, enabled_entrances, origin_list, entrances_map, builder.name) - if len(origin_list) <= 0: + all_potential_origins = all_potential_portals_map[builder.name] + enabled = entrances_map[builder.name] + if len(origin_list) <= 0 or should_delay_processing(enabled, all_potential_origins, potentials, connections, world, player): if last_key == builder.name or loops > 1000: origin_name = (world.get_region(origin_list[0], player).entrances[0].parent_region.name if len(origin_list) > 0 else 'no origin') @@ -311,6 +324,33 @@ def validate_vanilla_reservation(dungeon, world, player): return validate_key_layout(world.key_layout[player][dungeon.name], world, player) +def should_delay_processing(enabled_origins, potential_origins, potentials, connections, world, player): + disabled_origins = potential_origins.difference(set(enabled_origins)) + main_targets = [] + for do in disabled_origins: + region = world.get_region(do, player) + portal = _find_portal_for_region(region, world, player) + if portal and not portal.destination: + main_targets.append(region) + if not main_targets: + return False # No non-destination disabled origins found + enabling_regions = {connections[r.name] for r in main_targets} + for enabling_region in enabling_regions: + dungeon_names = { + portal.door.entrance.parent_region.dungeon.name + for dungeon_r in potentials[enabling_region] + if (portal := _find_portal_for_region(world.get_region(dungeon_r, player), world, player)) + } + if len(dungeon_names) > 1: + return True + return False + + +def _find_portal_for_region(region, world, player): + return next((p for ent in region.entrances + if (p := world.get_portal_unsafe(ent.parent_region.name.rstrip(' Portal'), player))), None) + + # some useful functions oppositemap = { Direction.South: Direction.North, @@ -3686,7 +3726,7 @@ logical_connections = [ ('PoD Pit Room Block Path S', 'PoD Pit Room'), ('PoD Arena Landing Bonk Path', 'PoD Arena Bridge'), ('PoD Arena North Drop Down', 'PoD Arena Main'), - ('PoD Arena Bridge Drop Down', 'PoD Arena Main'), + ('PoD Arena Bridge Drop Down', 'PoD Arena Landing'), ('PoD Arena North to Landing Barrier - Orange', 'PoD Arena Landing'), ('PoD Arena Main to Ranged Crystal', 'PoD Arena Main - Ranged Crystal'), ('PoD Arena Main to Landing Barrier - Blue', 'PoD Arena Landing'), diff --git a/Fill.py b/Fill.py index 0dd28574..04ab18ee 100644 --- a/Fill.py +++ b/Fill.py @@ -111,7 +111,7 @@ def fill_dungeons_restrictive(world, shuffled_locations): for attempt in range(15): try: for player in range(1, world.players + 1): - if world.prizeshuffle[player] == 'nearby': + if world.prizeshuffle[player] == 'nearby' and world.algorithm != 'vanilla_fill': dungeon_pool = [] for dungeon in world.dungeons: from Dungeons import dungeon_table @@ -143,6 +143,14 @@ def fill_dungeons_restrictive(world, shuffled_locations): else: raise FillError(f'Unable to place dungeon prizes: {", ".join(list(map(lambda d: d.name, prizes)))}') + if world.algorithm == 'vanilla_fill': + for prize in prizes_copy: + if prize.is_near_dungeon_item(world): + if prize.location and prize.location.parent_region.dungeon: + dungeon = prize.location.parent_region.dungeon + dungeon.prize = prize + prize.dungeon_object = dungeon + random.shuffle(shuffled_locations) fill(all_state_base, others, shuffled_locations) @@ -234,7 +242,8 @@ def verify_spot_to_fill(location, item_to_place, max_exp_state, single_player_pl test_state.sweep_for_events() if location.can_fill(test_state, item_to_place, perform_access_check): if valid_key_placement(item_to_place, location, key_pool, test_state, world): - if (item_to_place.prize and world.prizeshuffle[item_to_place.player] == 'none') \ + if (item_to_place.prize and (world.prizeshuffle[item_to_place.player] == 'none' \ + or (world.algorithm == 'vanilla_fill' and item_to_place.is_near_dungeon_item(world)))) \ or valid_dungeon_placement(item_to_place, location, world): return location if item_to_place.smallkey or item_to_place.bigkey or item_to_place.prize: @@ -330,6 +339,10 @@ def track_dungeon_items(item, location, world): if item.prize: location.parent_region.dungeon.prize = item item.dungeon_object = location.parent_region.dungeon + elif world.algorithm == 'vanilla_fill' and item.prize and location.parent_region.dungeon: + dungeon = location.parent_region.dungeon + dungeon.prize = item + item.dungeon_object = dungeon def is_dungeon_item(item, world): @@ -722,8 +735,13 @@ def fast_fill_pot_for_multiworld(world, item_pool, fill_locations): flex = 256 - world.data_tables[player].pot_secret_table.multiworld_count fill_count = len(pot_fill_locations[player]) - flex if fill_count > 0: - fill_spots = random.sample(pot_fill_locations[player], fill_count) - fill_items = random.sample(pot_item_pool[player], fill_count) + first_count = min(fill_count, len(pot_item_pool[player])) + fill_items = random.sample(pot_item_pool[player], first_count) + remaining = fill_count - first_count + if remaining > 0: + other_items = [i for i in item_pool if i.player == player and i not in pot_item_pool[player]] + fill_items += random.sample(other_items, min(remaining, len(other_items))) + fill_spots = random.sample(pot_fill_locations[player], len(fill_items)) for x in fill_items: item_pool.remove(x) for x in fill_spots: diff --git a/ItemList.py b/ItemList.py index a95604c7..f70aca19 100644 --- a/ItemList.py +++ b/ItemList.py @@ -302,6 +302,42 @@ def generate_itempool(world, player): for _ in range(0, amt): pool.append('Rupees (20)') + if world.shopsanity[player] and not skip_pool_adjustments: + for shop in world.shops[player]: + if shop.region.name in shop_to_location_table: + for index, slot in enumerate(shop.inventory): + if slot: + item = slot['item'] + if shop.region.name == 'Capacity Upgrade' and world.difficulty[player] != 'normal': + pool.append('Rupees (20)') + else: + pool.append(item) + + if (world.customizer and world.customizer.get_item_pool_adjust() + and player in world.customizer.get_item_pool_adjust()): + diff = difficulties[world.difficulty[player]] + for item_name, delta in world.customizer.get_item_pool_adjust()[player].items(): + if not isinstance(delta, int): + continue + if delta > 0: + if item_name == 'Bottle (Random)': + for _ in range(delta): + pool.append(random.choice(diff.bottles)) + else: + pool.extend([item_name] * delta) + elif delta < 0: + remove_count = abs(delta) + if item_name == 'Bottle (Random)': + bottle_names = set(diff.bottles) + for _ in range(remove_count): + bottle = next((x for x in pool if x in bottle_names), None) + if bottle: + pool.remove(bottle) + else: + for _ in range(remove_count): + if item_name in pool: + pool.remove(item_name) + if world.logic[player] == 'hybridglitches' and world.pottery[player] not in ['none', 'cave'] \ and world.keyshuffle[player] not in ['none', 'nearby']: # In HMG force swamp smalls in pots to allow getting out of swamp palace @@ -346,17 +382,6 @@ def generate_itempool(world, player): loc.event = True loc.locked = True - if world.shopsanity[player] and not skip_pool_adjustments: - for shop in world.shops[player]: - if shop.region.name in shop_to_location_table: - for index, slot in enumerate(shop.inventory): - if slot: - item = slot['item'] - if shop.region.name == 'Capacity Upgrade' and world.difficulty[player] != 'normal': - pool.append('Rupees (20)') - else: - pool.append(item) - items = ItemFactory(pool, player) if world.shopsanity[player]: for potion in ['Green Potion', 'Blue Potion', 'Red Potion']: diff --git a/Main.py b/Main.py index eab4a3e5..a7c52f7d 100644 --- a/Main.py +++ b/Main.py @@ -41,7 +41,7 @@ from source.enemizer.DamageTables import DamageTable from source.enemizer.Enemizer import randomize_enemies from source.rom.DataTables import init_data_tables -version_number = '1.5.2' +version_number = '1.5.6' version_branch = '-u' __version__ = f'{version_number}{version_branch}' diff --git a/OverworldShuffle.py b/OverworldShuffle.py index 7499eed8..e732547b 100644 --- a/OverworldShuffle.py +++ b/OverworldShuffle.py @@ -9,7 +9,7 @@ from OWEdges import OWTileRegions, OWEdgeGroups, OWEdgeGroupsTerrain, OWExitType from OverworldGlitchRules import create_owg_connections from Utils import bidict -version_number = '0.7.0.2' +version_number = '0.7.0.3' # branch indicator is intentionally different across branches version_branch = '' @@ -567,7 +567,7 @@ def link_overworld(world, player): remove_connected(forward_edge_sets, back_edge_sets) assert len(connected_edges) == len(default_connections) * 2, connected_edges - valid_layout = validate_layout(world, player) + valid_layout = world.accessibility[player] == 'none' or validate_layout(world, player) tries -= 1 assert valid_layout, 'Could not find a valid OW layout' @@ -1369,9 +1369,6 @@ def build_accessible_region_list(world, start_region, player, build_copy_world=F return explored_regions def validate_layout(world, player): - if world.accessibility[player] == 'none': - return True - entrance_connectors = { 'East Death Mountain (Bottom)': ['East Death Mountain (Top East)'], 'Kakariko Suburb Area': ['Maze Race Ledge'], @@ -1458,7 +1455,7 @@ def validate_layout(world, player): while unreachable_count != len(unreachable_regions): # find unreachable regions unreachable_regions = {} - for region_name in list(OWTileRegions.copy().keys()): + for region_name in list(OWTileRegions.keys()): if region_name not in explored_regions and region_name not in isolated_regions: region = world.get_region(region_name, player) unreachable_regions[region_name] = region @@ -1501,9 +1498,55 @@ def validate_layout(world, player): if len(unreachable_regions): return False - + return True - + +def get_separate_ow_areas(world, player): + """ + Returns a list of separated areas in the overworld layout. + It looks at the distinct connected components when only considering + OW edge and whirlpool connections (no entrances, portals, mirror, or flute). + Uses Union-Find to handle directed edges properly (treats them as undirected). + """ + parent = {} + + def find(x): + if x not in parent: + parent[x] = x + if parent[x] != x: + parent[x] = find(parent[x]) # Path compression + return parent[x] + + def union(x, y): + root_x = find(x) + root_y = find(y) + if root_x != root_y: + parent[root_y] = root_x + + all_regions = set(OWTileRegions.keys()) - set(isolated_regions) + considered_exit_spot_types = set(['OpenTerrain', 'OWTerrain', 'Ledge', 'OWEdge', 'Whirlpool']) + + # Initialize all regions in Union-Find + for region_name in all_regions: + find(region_name) + + # Build connections by examining all edges (treating directed as undirected) + for region_name in all_regions: + region = world.get_region(region_name, player) + for exit in region.exits: + if exit.spot_type in considered_exit_spot_types and exit.connected_region is not None and exit.connected_region.name in all_regions: + union(region_name, exit.connected_region.name) + + # Group regions by their root + areas = {} + for region_name in all_regions: + root = find(region_name) + if root not in areas: + areas[root] = [] + areas[root].append(region_name) + + return list(areas.values()) + test_connections = [ #('Links House ES', 'Octoballoon WS'), #('Links House NE', 'Lost Woods Pass SW') diff --git a/PastReleaseNotes.md b/PastReleaseNotes.md index dbdc2f12..d7984bec 100644 --- a/PastReleaseNotes.md +++ b/PastReleaseNotes.md @@ -1,10 +1,42 @@ # Past Feature Notes -1.4.3: File Select/End Game screen: Mirror Scroll and Pseudoboots added (Thanks Hiimcody!) +1.5.0 +* Enemy Drop: Added "spies" and shadows for hidden enemies when enemy drop shuffled is enabled +* Pottery: Pots will uncolor when the item inside is collected next time the room is loaded + +1.4.3 +* File Select/End Game screen: Mirror Scroll and Pseudoboots added (Thanks Hiimcody!) # Patch Notes Changelog archive +* 1.5.5 + * Logic: Fixed an issue where PoD Bridge lead to Arena Main instead of Arena Landing Area. (Potentially unnecessarily requiring bombs or Somaria to progress) + * HUD: Key counters are correct even when door shuffle is off +* 1.5.4 + * Documentation: New AI-assisted documentation [Site](https://aerinon.github.io/ALttPDoorRandomizer) + * Generation Error: Fixed Issue with Shop Code and Take Any Caves (thanks Codemann for assistance) +* 1.5.3 + * Logic: Key logic fix for part of a dungeon located at Skull 3 (or other similar restricted entrancs). Appropriate key logic was not being applied, causing progression issues. This mostly affect crosskey style seeds. + * Standard: Rupee balancing algorithm can no longer switch out the weapon on uncle for money. + * Dungeon Counters: Some fixes for inconsistent tracking and display of dungeon counters on the keysanity menu. + * Text: Updated main tournament winner (Thanks clearmouse!) +* 1.5.1 + * Bugfix: Fixed an issue with keys not counting correctly +* 1.5.0 + * Logic: Fixed vanilla key logic for GT basement + * Logic (Playthrough): Fixed an issue where enemy kill rules were not applied during playthrough calculation. (Thanks Catobat for the catch) + * Keysanity/Keydrop Menu for DR: + * Map key information is now controlled by the Dungeon Chest Counts setting. If set to always on, this information will be available right away in the menu and will be on the HUD even when the map is not obtained. + * The key counter on the HUD for the current dungeon now accounts for keys from enemies or pots that are from vanilla key locations. + * The first number on the HUD represents all keys collected either in that dungeon or elsewhere. + * The second number on the HUD is the total keys that can be collected either in that dungeon or elsewhere. + * The key counter on inside the Menu is unchanged. (At the bottom near A button items) + * The first number in the Menu is the current number of keys in your inventory + * The second number is how many keys left to find in chests (not those from pots/enemies unless those item pools are enabled) + * Customizer: free_lamp_cone option added. The logic will account for this, and place the lamp without regard to dark rooms. + * Customizer: force_enemy option added that makes all enemies the specified type if possible. There are known gfx glitches in the overworld. + * Optimization: Improved generation performance (Thanks Catobat!) * 1.4.11 * Rom fixes (all thanks to Codemann, I believe) * Pot bug when at sprite limit diff --git a/RELEASENOTES.md b/RELEASENOTES.md index b43278d1..12904fb5 100644 --- a/RELEASENOTES.md +++ b/RELEASENOTES.md @@ -141,19 +141,10 @@ These are now independent of retro mode and have three options: None, Random, an # Patch Notes -* 1.5.0 - * Logic: Fixed vanilla key logic for GT basement - * Logic (Playthrough): Fixed an issue where enemy kill rules were not applied during playthrough calculation. (Thanks Catobat for the catch) - * Enemy Drop: Added "spies" and shadows for hidden enemies when enemy drop shuffled is enabled - * Pottery: Pots will uncolor when the item inside is collected next time the room is loaded - * Keysanity/Keydrop Menu for DR: - * Map key information is now controlled by the Dungeon Chest Counts setting. If set to always on, this information will be available right away in the menu and will be on the HUD even when the map is not obtained. - * The key counter on the HUD for the current dungeon now accounts for keys from enemies or pots that are from vanilla key locations. - * The first number on the HUD represents all keys collected either in that dungeon or elsewhere. - * The second number on the HUD is the total keys that can be collected either in that dungeon or elsewhere. - * The key counter on inside the Menu is unchanged. (At the bottom near A button items) - * The first number in the Menu is the current number of keys in your inventory - * The second number is how many keys left to find in chests (not those from pots/enemies unless those item pools are enabled) - * Customizer: free_lamp_cone option added. The logic will account for this, and place the lamp without regard to dark rooms. - * Customizer: force_enemy option added that makes all enemies the specified type if possible. There are known gfx glitches in the overworld. - * Optimization: Improved generation performance (Thanks Catobat!) +* 1.5.6 + * Enemy Drops: Pikit are no longer eligible for dropped items due to a vanilla bug where a failed steal can overwrite the assigned drop. + * Standard Mode: Reworked spawn refills to be more generous for enemy drop modes. + * Customizer: Added `item_pool_adjust` section to apply additive/subtractive deltas to the base item pool rather than replacing it entirely. + * Multiworld: Fixed a generation crash when beemizer is active and pottery is enabled. Pot locations are now properly filled with same-player items when the MW limit is hit even when beemizer has replaced native pot items. + + diff --git a/Rom.py b/Rom.py index 74063ec2..bb4ce2ff 100644 --- a/Rom.py +++ b/Rom.py @@ -43,7 +43,7 @@ from source.enemizer.Enemizer import write_enemy_shuffle_settings JAP10HASH = '03a63945398191337e896e5771f77173' -RANDOMIZERBASEHASH = 'da081467317d8f6902eb1cf57304dbff' +RANDOMIZERBASEHASH = '767da6cf86c6e7163ae59b2cd8a7305d' class JsonRom(object): @@ -719,15 +719,15 @@ def patch_rom(world, rom, player, team, is_mystery=False, rom_header=None): if world.mirrorscroll[player] or world.doorShuffle[player] != 'vanilla': dr_flags |= DROptions.Town_Portal if world.doorShuffle[player] == 'vanilla': - dr_flags |= DROptions.Eternal_Mini_Bosses + dr_flags |= DROptions.Eternal_Mini_Bosses if world.doorShuffle[player] not in ['vanilla', 'basic']: dr_flags |= DROptions.Map_Info if ((world.collection_rate[player] or world.goal[player] == 'completionist') - and world.goal[player] not in ['triforcehunt', 'trinity', 'ganonhunt']): + and world.goal[player] not in ['triforcehunt', 'trinity', 'ganonhunt']): dr_flags |= DROptions.Debug rom.write_byte(snes_to_pc(0x308039), 1) - if world.doorShuffle[player] not in ['vanilla', 'basic'] and world.logic[player] != 'nologic'\ - and world.mixed_travel[player] == 'prevent': + if world.doorShuffle[player] not in ['vanilla', 'basic'] and world.logic[player] != 'nologic' \ + and world.mixed_travel[player] == 'prevent': # PoD Falling Bridge or Hammjump # 1FA607: db $2D, $79, $69 ; 0x0069: Vertical Rail ↕ | { 0B, 1E } | Size: 05 # 1FA60A: db $14, $99, $5D ; 0x005D: Large Horizontal Rail ↔ | { 05, 26 } | Size: 01 @@ -825,9 +825,9 @@ def patch_rom(world, rom, player, team, is_mystery=False, rom_header=None): if world.doorShuffle[player] == 'basic': rom.write_byte(0x138002, 1) for door in world.doors: - if door.dest is not None and isinstance(door.dest, Door) and\ - door.player == player and door.type in [DoorType.Normal, DoorType.SpiralStairs, - DoorType.Open, DoorType.StraightStairs, DoorType.Ladder]: + if door.dest is not None and isinstance(door.dest, Door) and \ + door.player == player and door.type in [DoorType.Normal, DoorType.SpiralStairs, + DoorType.Open, DoorType.StraightStairs, DoorType.Ladder]: rom.write_bytes(door.getAddress(), door.dest.getTarget(door)) for paired_door in world.paired_doors[player]: rom.write_bytes(paired_door.address_a(world, player), paired_door.rom_data_a(world, player)) @@ -1215,7 +1215,7 @@ def patch_rom(world, rom, player, team, is_mystery=False, rom_header=None): gametype = 0x04 # item if (world.shuffle[player] != 'vanilla' or world.doorShuffle[player] != 'vanilla' - or world.dropshuffle[player] != 'none' or world.pottery[player] != 'none'): + or world.dropshuffle[player] != 'none' or world.pottery[player] != 'none'): gametype |= 0x02 # entrance/door rom.write_byte(0x180211, gametype) # Game type @@ -1639,38 +1639,38 @@ def patch_rom(world, rom, player, team, is_mystery=False, rom_header=None): rom.write_bytes(0x180188, [0, 0, 0]) # Zelda respawn refills (magic, bombs, arrows) rom.write_bytes(0x18018B, [0, 0, 0]) # Mantle respawn refills (magic, bombs, arrows) bow_max, bomb_max, magic_max = 0, 0, 0 - bow_small, magic_small = 0, 0 + bow_small, bomb_small, magic_small = 10, 3, 0x20 if world.mode[player] == 'standard': if uncle_location.item is not None and uncle_location.item.name in ['Bow', 'Progressive Bow']: rom.write_byte(0x18004E, 1) # Escape Fill (arrows) write_int16(rom, 0x180183, 300) # Escape fill rupee bow rom.write_bytes(0x180185, [0, 0, 70]) # Uncle respawn refills (magic, bombs, arrows) - rom.write_bytes(0x180188, [0, 0, 10]) # Zelda respawn refills (magic, bombs, arrows) - rom.write_bytes(0x18018B, [0, 0, 10]) # Mantle respawn refills (magic, bombs, arrows) - bow_max, bow_small = 70, 10 + rom.write_bytes(0x180188, [0, 0, 70]) # Zelda respawn refills (magic, bombs, arrows) + rom.write_bytes(0x18018B, [0, 0, 70]) # Mantle respawn refills (magic, bombs, arrows) + bow_max = 70 elif uncle_location.item is not None and uncle_location.item.name in ['Bomb Upgrade (+10)' if world.bombbag[player] else 'Bombs (10)']: rom.write_byte(0x18004E, 2) # Escape Fill (bombs) rom.write_bytes(0x180185, [0, 50, 0]) # Uncle respawn refills (magic, bombs, arrows) - rom.write_bytes(0x180188, [0, 3, 0]) # Zelda respawn refills (magic, bombs, arrows) - rom.write_bytes(0x18018B, [0, 3, 0]) # Mantle respawn refills (magic, bombs, arrows) + rom.write_bytes(0x180188, [0, 50, 0]) # Zelda respawn refills (magic, bombs, arrows) + rom.write_bytes(0x18018B, [0, 50, 0]) # Mantle respawn refills (magic, bombs, arrows) bomb_max = 50 elif uncle_location.item is not None and uncle_location.item.name in ['Cane of Somaria', 'Cane of Byrna', 'Fire Rod']: rom.write_byte(0x18004E, 4) # Escape Fill (magic) rom.write_bytes(0x180185, [0x80, 0, 0]) # Uncle respawn refills (magic, bombs, arrows) - rom.write_bytes(0x180188, [0x20, 0, 0]) # Zelda respawn refills (magic, bombs, arrows) - rom.write_bytes(0x18018B, [0x20, 0, 0]) # Mantle respawn refills (magic, bombs, arrows) - magic_max, magic_small = 0x80, 0x20 + rom.write_bytes(0x180188, [0x80, 0, 0]) # Zelda respawn refills (magic, bombs, arrows) + rom.write_bytes(0x18018B, [0x80, 0, 0]) # Mantle respawn refills (magic, bombs, arrows) + magic_max = 0x80 if world.doorShuffle[player] not in ['vanilla', 'basic']: # Uncle respawn refills (magic, bombs, arrows) - rom.write_bytes(0x180185, [max(0x20, magic_max), max(3, bomb_max), max(10, bow_max)]) + rom.write_bytes(0x180185, [max(magic_small, magic_max), max(bomb_small, bomb_max), max(bow_small, bow_max)]) # Zelda respawn refills (magic, bombs, arrows) - rom.write_bytes(0x180188, [max(0x20, magic_max), max(3, bomb_max), max(10, bow_max)]) + rom.write_bytes(0x180188, [max(magic_small, magic_max), max(bomb_small, bomb_max), max(bow_small, bow_max)]) # Mantle respawn refills (magic, bombs, arrows) - rom.write_bytes(0x18018B, [max(0x20, magic_max), max(3, bomb_max), max(10, bow_max)]) + rom.write_bytes(0x18018B, [max(magic_small, magic_max), max(bomb_small, bomb_max), max(bow_small, bow_max)]) elif world.doorShuffle[player] == 'basic': # just in case a bomb is needed to get to a chest - rom.write_bytes(0x180185, [max(0x00, magic_max), max(3, bomb_max), max(0, bow_max)]) - rom.write_bytes(0x180188, [magic_small, 3, bow_small]) # Zelda respawn refills (magic, bombs, arrows) - rom.write_bytes(0x18018B, [magic_small, 3, bow_small]) # Mantle respawn refills (magic, bombs, arrows) + rom.write_bytes(0x180185, [max(magic_small, magic_max), max(bomb_small, bomb_max), max(bow_small, bow_max)]) + rom.write_bytes(0x180188, [magic_small, max(bomb_small, bomb_max), bow_small]) # Zelda respawn refills (magic, bombs, arrows) + rom.write_bytes(0x18018B, [magic_small, max(bomb_small, bomb_max), bow_small]) # Mantle respawn refills (magic, bombs, arrows) # patch swamp: Need to enable permanent drain of water as dam or swamp were moved rom.write_byte(0x18003D, 0x01 if world.swamp_patch_required[player] else 0x00) @@ -1773,7 +1773,7 @@ def patch_rom(world, rom, player, team, is_mystery=False, rom_header=None): write_enemy_shuffle_settings(world, player, rom) if (world.doorShuffle[player] != 'vanilla' or world.dropshuffle[player] != 'none' - or world.pottery[player] != 'none'): + or world.pottery[player] != 'none'): for room in world.rooms: if room.player == player and room.modified: if room.index in world.data_tables[player].room_list: @@ -1835,7 +1835,7 @@ def patch_rom(world, rom, player, team, is_mystery=False, rom_header=None): (hashint >> 10) & 0x1F, (hashint >> 5) & 0x1F, hashint & 0x1F, - ] + ] rom.write_bytes(0x180215, code) rom.hash = code @@ -2244,6 +2244,9 @@ def write_strings(rom, world, player, team): " Crosskeys\n" " Tournament\n" " Winners\n{HARP}\n" + " ~~~2025~~~\n humbugh\n\n" + " ~~~2024~~~\n Gammachuu\n\n" + " ~~~2023~~~\n WallKicks\n\n" " ~~~2022~~~\n Schulzer\n\n" " ~~~2021~~~\n Goomba\n\n" " ~~~2020~~~\n Linlinlin\n\n" @@ -2576,16 +2579,19 @@ def write_strings(rom, world, player, team): loc.item = i return loc (crystal5, crystal6, greenpendant) = tuple([x[0] if x else missing_prize() for x in [crystal5, crystal6, greenpendant]]) + bigbomb_follower = 'Big Bomb?\n' + if world.shuffle_followers[player]: + bigbomb_follower = '' if world.prizeshuffle[player] in ['none', 'dungeon']: (crystal5, crystal6, greenpendant) = tuple([x.parent_region.dungeon.name for x in [crystal5, crystal6, greenpendant]]) - tt['bomb_shop'] = 'Big Bomb?\nMy supply is blocked until you clear %s and %s.' % (crystal5, crystal6) + tt['bomb_shop'] = f'{bigbomb_follower}My supply is blocked until you clear %s and %s.' % (crystal5, crystal6) tt['sahasrahla_bring_courage'] = 'I lost my family heirloom in %s' % greenpendant elif world.prizeshuffle[player] == 'nearby': (crystal5, crystal6, greenpendant) = tuple([x.item.dungeon_object.name for x in [crystal5, crystal6, greenpendant]]) - tt['bomb_shop'] = 'Big Bomb?\nThe crystals can be found near %s and %s.' % (crystal5, crystal6) + tt['bomb_shop'] = f'{bigbomb_follower}The crystals can be found near %s and %s.' % (crystal5, crystal6) tt['sahasrahla_bring_courage'] = 'I lost my family heirloom near %s' % greenpendant else: - tt['bomb_shop'] = 'Big Bomb?\nThe crystals can be found %s and %s.' % (crystal5.hint_text, crystal6.hint_text) + tt['bomb_shop'] = f'{bigbomb_follower}The crystals can be found %s and %s.' % (crystal5.hint_text, crystal6.hint_text) tt['sahasrahla_bring_courage'] = 'My family heirloom can be found %s' % greenpendant.hint_text tt['sign_ganons_tower'] = ('You need %d crystal to enter.' if world.crystals_needed_for_gt[player] == 1 else 'You need %d crystals to enter.') % world.crystals_needed_for_gt[player] diff --git a/Text.py b/Text.py index e7bbe072..7a9c0404 100644 --- a/Text.py +++ b/Text.py @@ -1798,6 +1798,7 @@ class TextTable(object): text['telepathic_tile_ice_stalfos_knights_room'] = CompressedTextMapper.convert("{NOBORDER}\nKnock 'em down and then bomb them dead.") text['telepathic_tile_tower_of_hera_entrance'] = CompressedTextMapper.convert("{NOBORDER}\nThis is a bad place, with a guy who will make you fall…\n\n\na lot.") text['houlihan_room'] = CompressedTextMapper.convert("Randomizer tournament winners\n{HARP}\n" + " ~~~2025~~~\nGammachuu\n\n" " ~~~2024~~~\nGammachuu\n\n" " ~~~2023~~~\nGanonsGoneWild\n\n" " ~~~2022~~~\nObscure\n\n" diff --git a/_config.yml b/_config.yml index c7418817..33a55de0 100644 --- a/_config.yml +++ b/_config.yml @@ -1 +1,139 @@ -theme: jekyll-theme-slate \ No newline at end of file +# Site settings +title: ALttP Dungeon Randomizer +description: Advanced dungeon randomization for The Legend of Zelda - A Link to the Past +baseurl: "/ALttPDoorRandomizer" +url: "https://aerinon.github.io" + +# Theme +theme: jekyll-theme-slate +remote_theme: just-the-docs/just-the-docs + +# Logo and branding +# logo: "/assets/images/logo.png" + +# Navigation +nav_enabled: true +nav_external_links: + - title: GitHub + url: https://github.com/aerinon/ALttPDoorRandomizer + - title: Discord + url: https://discordapp.com/invite/alttprandomizer + - title: Download + url: https://github.com/aerinon/ALttPDoorRandomizer/releases + +# Search +search_enabled: true +search: + heading_level: 2 + previews: 3 + preview_words_before: 5 + preview_words_after: 10 + tokenizer_separator: /[\s/]+/ + rel_url: true + button: true + +# Heading anchors +heading_anchors: true + +# Aux links +aux_links: + "Door Randomizer on GitHub": + - "https://github.com/aerinon/ALttPDoorRandomizer" + "ALTTP Rando Discord": + - "https://discordapp.com/invite/alttprandomizer" + +aux_links_new_tab: true + +# Footer +footer_content: "Copyright © 2026 ALttP Door Randomizer Team. Based on ALttP Entrance Randomizer." + +# Back to top link +back_to_top: true +back_to_top_text: "Back to top" + +# Collections for blog posts +collections: + posts: + output: true + permalink: /blog/:year/:month/:day/:title/ + +# Defaults +defaults: + - scope: + path: "" + type: "posts" + values: + layout: "default" + - scope: + path: "" + values: + layout: "default" + +# Build settings +markdown: kramdown +kramdown: + input: GFM + syntax_highlighter: rouge + syntax_highlighter_opts: + css_class: 'highlight' + +plugins: + - jekyll-feed + - jekyll-seo-tag + - jekyll-sitemap + +# Exclude from processing +exclude: + - .git/ + - .github/ + - .gitignore + - .gitattributes + - source/ + - test/ + - resources/ + - data/ + - debug/ + - analysis/ + - analysis2/ + - alttp_dungeon_randomizer.egg-info/ + - DR/ + - "*.py" + - "*.pyc" + - "*.pyd" + - "*.pyo" + - "*.egg-info" + - "*.spec" + - requirements*.txt + - setup.py + - TestSuite.py + - DungeonRandomizer.py + - Gui.py + - MultiServer.py + - MultiClient.py + - CLAUDE.md + - LICENSE + - libbz2-dev + - tlogbfs.txt + +# Include files +include: + - _posts + - blog + - docs/Customizer.md + - docs/BUILDING.md + - docs/DR_hint_reference.md + +# Color scheme (for just-the-docs theme) +color_scheme: dark + +# Google Analytics (optional - add your tracking ID) +# ga_tracking: UA-XXXXXXXX-X + +# Compress HTML +compress_html: + clippings: all + comments: all + endings: all + startings: [] + blanklines: false + profile: false diff --git a/_posts/2026-01-30-welcome-to-door-randomizer.md b/_posts/2026-01-30-welcome-to-door-randomizer.md new file mode 100644 index 00000000..fbe4eb23 --- /dev/null +++ b/_posts/2026-01-30-welcome-to-door-randomizer.md @@ -0,0 +1,74 @@ +--- +layout: default +title: "Welcome to the ALttP Door Randomizer Blog" +date: 2026-01-26 +author: Door Randomizer Team +category: development +excerpt: "Introducing the new Door Randomizer documentation site and blog. Learn about what's new, what's coming, and how to get involved." +--- + +# Welcome to the ALttP Door Randomizer Blog + +We're excited to launch the official documentation site and development blog for ALttP Door Randomizer! This site serves as a central hub for all things Door Rando - from comprehensive feature documentation to release notes and development updates. + +## What's New Here? + +### Comprehensive Documentation + +We've reorganized and expanded our documentation to make it easier to find what you need: + +- **[Features Guide](/features)** - Complete reference for all randomizer settings and modes +- **[Installation & Usage](/installation)** - Step-by-step setup instructions for all platforms +- **[Known Issues](/known-issues)** - Tracking current bugs and limitations +- **[Roadmap](/roadmap)** - Our vision for the future of Door Randomizer + +### Development Blog + +This blog will be your source for: + +- **Feature highlights** - Deep dives into specific features +- **Development updates** - Behind-the-scenes looks at ongoing work +- **Technical articles** - How the randomizer works under the hood + +## What is Door Randomizer? + +If you're new here, Door Randomizer takes the ALttP randomizer experience to the next level by shuffling the connections between rooms within dungeons. Walk through a door in Eastern Palace and you might end up in Tower of Hera, Ice Palace, or anywhere else! + +Key features include: + +- **Four shuffle modes** - From basic (within dungeon) to crossed (full chaos) +- **Three intensity levels** - Control how thoroughly dungeons are shuffled +- **Advanced key logic** - Multiple algorithms to prevent self-locking +- **Pottery shuffle** - Randomize items under pots with multiple modes +- **Shopsanity** - 32+ shop locations with intelligent pricing +- **Enemizer integration** - Enemy and boss randomization with logic +- **Custom seeds** - Create your own dungeons and rooms + +[Learn more about features β†’](/features) + +[Read the Customizer guide β†’](https://github.com/aerinon/ALttPDoorRandomizer/blob/DoorDev/docs/Customizer.md) + +## What's Coming Next? + +We have plans for Door Randomizer's future. Check out our [Roadmap](/roadmap) for details. (Still very much a work in progress!) + +## Community + +Join the Door Randomizer community: + +- **Discord**: [ALTTP Randomizer Discord](https://discordapp.com/invite/alttprandomizer) + - `#door-rando` - General discussion and help + - `#bug-reports` - Report bugs and issues +- **GitHub**: [aerinon/ALttPDoorRandomizer](https://github.com/aerinon/ALttPDoorRandomizer) + +## Stay Tuned + +We'll be posting irregular updates here as development continues. + +Thank you to everyone who has contributed to Door Randomizer through code, testing, feedback, and community support. We're excited about the future and can't wait to see what lies in store! + +Happy randomizing! + +--- + +*Have questions or feedback about the new documentation site? Let us know in Discord!* diff --git a/blog/index.md b/blog/index.md new file mode 100644 index 00000000..392cc00d --- /dev/null +++ b/blog/index.md @@ -0,0 +1,100 @@ +--- +layout: default +title: Blog +nav_order: 6 +has_children: false +--- + +# Development Blog +{: .no_toc } + +Latest updates, release notes, and development insights for ALttP Door Randomizer. +{: .fs-6 .fw-300 } + +--- + +## Recent Posts + +{% assign posts = site.posts | sort: 'date' | reverse %} +{% for post in posts limit:10 %} +
+

+ {{ post.title }} +

+

+ {{ post.date | date: "%B %d, %Y" }} + {% if post.author %} β€’ by {{ post.author }}{% endif %} +

+

{{ post.excerpt | strip_html | truncatewords: 50 }}

+

Read more β†’

+
+{% endfor %} + +--- + +## Categories + +Browse posts by category: + +- [Release Notes](#release-notes) +- [Development Updates](#development-updates) +- [Feature Highlights](#feature-highlights) +- [Technical Deep Dives](#technical-deep-dives) + +### Release Notes + +{% assign release_posts = site.posts | where: "category", "release" %} +{% for post in release_posts limit:5 %} +- [{{ post.title }}]({{ post.url | relative_url }}) - {{ post.date | date: "%B %d, %Y" }} +{% endfor %} + +### Development Updates + +{% assign dev_posts = site.posts | where: "category", "development" %} +{% for post in dev_posts limit:5 %} +- [{{ post.title }}]({{ post.url | relative_url }}) - {{ post.date | date: "%B %d, %Y" }} +{% endfor %} + +### Feature Highlights + +{% assign feature_posts = site.posts | where: "category", "features" %} +{% for post in feature_posts limit:5 %} +- [{{ post.title }}]({{ post.url | relative_url }}) - {{ post.date | date: "%B %d, %Y" }} +{% endfor %} + +### Technical Deep Dives + +{% assign feature_posts = site.posts | where: "category", "features" %} +{% for post in feature_posts limit:5 %} +- [{{ post.title }}]({{ post.url | relative_url }}) - {{ post.date | date: "%B %d, %Y" }} + {% endfor %} + +--- + +## Subscribe + +Stay up to date with Door Randomizer development: + +- **Discord**: Join [ALTTP Randomizer Discord](https://discordapp.com/invite/alttprandomizer) in `#door-rando` + +--- + +## Archive + +View all posts by year: + +{% assign posts_by_year = site.posts | group_by_exp: "post", "post.date | date: '%Y'" %} +{% for year in posts_by_year %} +### {{ year.name }} +{% for post in year.items %} +- [{{ post.title }}]({{ post.url | relative_url }}) - {{ post.date | date: "%B %d, %Y" }} +{% endfor %} +{% endfor %} + +--- + +## Contributing to the Blog + +Want to write a guest post or contribute content? + +Contact us on Discord to discuss your ideas! diff --git a/data/base2current.bps b/data/base2current.bps index ff23c010..bb248699 100644 Binary files a/data/base2current.bps and b/data/base2current.bps differ diff --git a/docs/Customizer.md b/docs/Customizer.md index 5d5e083d..cc617522 100644 --- a/docs/Customizer.md +++ b/docs/Customizer.md @@ -68,10 +68,30 @@ Then each player can have the entire item pool defined. The name of item should `Bottle (Random)` is supported to randomize bottle contents according to those allowed by difficulty. Pendants and crystals are supported here. -##### Caveat - +**Note**: `item_pool` is a **full replacement** of the base item pool. Every item the player will receive must be listed. If you only want to tweak the default pool, use `item_pool_adjust` instead. + +##### Caveat + Dungeon items amount can be increased (but not decreased as the minimum of each dungeon item is either pre-determined or calculated by door rando) if the type of dungeon item is not shuffled then it is attempted to be placed in the dungeon. Extra item beyond dungeon capacity not be confined to the dungeon. +### item_pool_adjust + +This must be defined by player. Each player number should be listed with the appropriate adjustments. + +Unlike `item_pool`, this section **adjusts** the base item pool generated by the randomizer settings rather than replacing it. Use positive values to add items and negative values to remove items. + +```yaml +item_pool_adjust: + 1: + Bottle (Random): 2 # add 2 extra random bottles + Rupees (300): 1 # add 1 extra rupee pack + Boss Heart Container: -3 # remove 3 heart containers from the base pool +``` + +`Bottle (Random)` follows the same bottle randomization rules as in `item_pool`. When removing bottles with `Bottle (Random): -N`, any bottle (regardless of contents) will be removed. + +Removals that exceed the number of that item currently in the pool are silently ignored. Item pool adjustments are applied after beemizer but before the standard-mode Link's Uncle weapon selection, so weapons added here are eligible for that placement. + ### goals This must be defined by player. Each player number should be listed with the appropriate custom goals. This section has four primary subsections for each of the current supported events: @@ -257,10 +277,45 @@ someDescription: `grid` contains additional options that only have an effect when `ow_layout` is set to `grid`. +#### fixed_arrangements + +Use this to dictate the relative positioning between multiple screens (or quadrants of large screens). Screens and quadrants are addressed by their OW Slot ID (independently of their world), ranging from 0x00 to 0x3F. An `arrangement` is given as a list of rows with equal lenghts. If you do not want to specify a full rectangle of screens, you can use `.` as a placeholder to allow the generator to place any screen there. The `world` property can be set to `light`, `dark` or `both` (default value) and determines for which worlds the arrangement applies. + +This example forces Death Mountain to stay connected the same as vanilla in both worlds: +``` +fixed_arrangements: + - arrangement: + - 0x03 0x04 0x05 0x06 0x07 + - 0x0B 0x0C 0x0D 0x0E . + world: both +``` + +#### restricted_positions + +Use this to restrict cells to a specified set of possible positions. The `world` property can be set to `light`, `dark` or `both` (default value) and determines for which worlds the restriction applies. + +This example forces the Sanctuary and Link's House screens in both worlds to get placed in corners of the grid: +``` +restricted_positions: + - cells: + - 0x13 + - 0x2C + positions: + - 0x00 + - 0x07 + - 0x38 + - 0x3F + world: both +``` + #### wrap_horizontal / wrap_vertical Set these to `true` to allow for overworld edge transitions to wrap from one side of a world to the opposite side. With `wrap_horizontal`, there can be east transitions on the eastern edge of the world map that send the player to the western edge of the world. With `wrap_vertical`, there can be south transitions on the southern edge of the world map that send the player to the northern edge of the world. +#### split_large_screens + +When set to `true`, the four quadrants of each large screen are placed on the grid independently of each other. + ### ow-crossed This must be defined by player. Each player number should be listed with the appropriate sections and each of these players MUST have `ow_crossed` enabled in the `settings` section in order for any values here to take effect. This section has four primary subsections: `force_crossed`, `force_noncrossed`, `limit_crossed`, and `undefined_chance`. There are also diff --git a/docs/customizer_example.yaml b/docs/customizer_example.yaml index c2f3943c..ced9f4d4 100644 --- a/docs/customizer_example.yaml +++ b/docs/customizer_example.yaml @@ -67,6 +67,14 @@ item_pool: Sanctuary Heart Container: 3 Shovel: 3 Single Arrow: 1 + Green Potion: 1 + Blue Potion: 1 + Red Potion: 1 +item_pool_adjust: + 1: + Bottle (Random): 2 # add 2 extra random bottles on top of the base pool + Magic Upgrade (1/2): 1 # add 1 extra half-magic + Boss Heart Container: -3 # remove 3 heart containers from the base pool placements: 1: Palace of Darkness - Big Chest: Hammer diff --git a/features.md b/features.md new file mode 100644 index 00000000..2a404b18 --- /dev/null +++ b/features.md @@ -0,0 +1,473 @@ +--- +layout: default +title: Features +nav_order: 2 +--- + +# Features Guide +{: .no_toc } + +Comprehensive documentation of all Door Randomizer features and settings. +{: .fs-6 .fw-300 } + +## Table of contents +{: .no_toc .text-delta } + +1. TOC +{:toc} + +--- + +## Important Differences from Other Randomizers + +Most of these apply only when door shuffle is not vanilla. + +### Starting Item + +You start with a **Mirror Scroll** (looks like a map), a simplified mirror that only works in dungeons, not the overworld, and can't erase blocks like the Mirror. + +### Navigation Changes + +- Holes in Mire Torches Top and Mire Torches Bottom fall through to rooms below (you only need fire to get the chest) +- You can Hookshot from the left Mire wooden Bridge to the right one +- In the PoD Arena, you can bonk with Boots between the two blue crystal barriers against the ladder to reach the Arena Bridge chest and door (Bomb Jump also possible but not in logic - Boots are required) +- Flooded Rooms in Swamp can be traversed backward and may be required. Flippers are needed to get out of the water + +### Logic Differences + +- The chest in southeast Skull Woods that is traditionally a guaranteed Small Key in ER is not guaranteed here +- Fire Rod is not in logic for dark rooms (hard enough to figure out which dark room you are in) +- The hammerjump (and some other skips) are not in logic by default (see the mixed_travel setting for details). Doing so in a crossed dungeon seed can put you into another dungeon with the wrong dungeon id + +### Boss Differences + +- You have to find the attic floor and bomb it open and bring the maiden to the light to fight Blind. In cross dungeon door shuffle, the attic can be in any dungeon. If you bring the maiden to the boss arena, she will hint where the cracked floor can be found +- GT Bosses do not respawn after killing them in this mode +- Enemizer change: The attic/maiden sequence is now active and required when Blind is the boss of Thieves' Town even when bosses are shuffled + +### Crystal Switches + +- You can hit the PoD crystal switch in the Sexy Statue room with a bomb from the balcony above without jumping down +- GT Crystal Conveyor room (it has gibdos) - You can hit the crystal switch with a bomb when the blue barrier is up from the far side so you can leave the room to the left with blue barriers down +- PoD Arena Bridge - If entering from the bridge, you can circle round and hit the switch, then fall into the hole to respawn at the bridge again with the crystal barriers different + +--- + +## Dungeon Settings + +### Door Shuffle + +Controls how dungeon doors are shuffled: + +- **Vanilla** - Doors are not shuffled +- **Basic** - Doors are shuffled only within a single dungeon +- **Partitioned** - Dungeons are shuffled in 3 pools: Light World, Early Dark World, Late Dark World (Late Dark are the four dungeons that require Mitts in vanilla, including Ganon's Tower) +- **Crossed** - Doors are shuffled between dungeons as well + +CLI: `--doorShuffle [vanilla|basic|partitioned|crossed]` + +### Intensity + +Controls which types of connections are shuffled: + +- **Level 1** - Normal doors and spiral staircases are shuffled +- **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 + +CLI: `--intensity [1|2|3]` + +### Door Type Shuffle + +Controls which types of doors can be shuffled (only active if door shuffle is not vanilla): + +- **Small Key Doors, Bomb Doors, Dash Doors** - Standard shuffled doors +- **Adds Big Key Doors** - Big key doors are now shuffled in addition to those above +- **Adds Trap Doors** - All trap doors that are permanently shut in vanilla are shuffled, excluding boss trap doors +- **Increases all Door Types** - Chaos mode where each door type per dungeon is randomized between 1 less and 4 more + +CLI: `--door_type_mode [original|big|all|chaos]` + +### Trap Door Removal + +Options for making dungeon traversal more convenient: + +- **No Removal** - Does not remove any trap doors +- **Removed If Blocking Path** - Dungeon generation removes annoying trap doors if necessary (boss trap doors never shuffled) +- **Remove Boss Traps** - Boss traps are removed, including the one near Mothula +- **Remove All Annoying Traps** - Removes all trap doors that are annoying, including boss traps + +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 can be found anywhere +- **Universal** - Small keys work in any dungeon, can be found anywhere, and at least one shop will sell keys (like original Legend of Zelda) + +CLI: `--keyshuffle [none|wild|universal]` + +All other dungeon items (maps, compasses, Big Keys) can be restricted to their own dungeon or shuffled in the general pool. + +### Key Logic Algorithm + +Determines how small key door logic works: + +- **Partial Protection** - Assumes you always have full inventory and worst case usage. Accounts for dark room and bunny revival glitches +- **Strict** - Small key doors require all small keys to be available to be in logic +- **Dangerous** - Assumes you never use keys out of logic (not recommended) + +CLI: `--key_logic [partial|strict|dangerous]` + +### Decouple Doors + +Similar to insanity mode in ER where door entrances and exits are not paired anymore. Tends to remove more logic from dungeons as many rooms will not be required to traverse. + +CLI: `--decoupledoors` + +### Allow Self-Looping Spiral Stairs + +If enabled, spiral stairs are allowed to lead to themselves. + +CLI: `--door_self_loops` + +### Experimental Features + +You will start as a bunny if your spawn point is in the dark world. + +CLI: `--experimental` + +### Crossed Dungeon Specific Settings + +#### Dungeon Chest Counters + +- **Auto** - Picks an appropriate setting based on other settings +- **On** - Dungeon counters on HUD always displayed +- **Off** - Dungeon counters on HUD never displayed +- **On Compass Pickup** - Dungeons with a compass item will display the counter once the compass is found + +CLI: `--dungeon_counters [auto|on|off|pickup]` + +#### Mixed Travel + +Controls Hammerjump, PoD Arena hovering, and Mire Big Key Chest bomb jump: + +- **Prevent (default)** - Rails are added to prevent these tricks. Recommended for those learning crossed dungeon mode +- **Allow** - Rooms are left alone and it is up to player discretion whether to use these tricks +- **Force** - The two disjointed sections are forced to be in the same dungeon but the glitches are never logically required + +CLI: `--mixed_travel [prevent|allow|force]` + +#### Standardize Palettes + +- **Standardize (default)** - Rooms in the same dungeon have their palettes changed to match +- **Original** - Rooms/supertiles keep their original palettes + +CLI: `--standardize_palettes` + +--- + +## Pool Expansions + +### Pottery + +Controls 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 +- **Cave Pots** - The pots that are not found in dungeons are in the pool (includes Spike Cave large block) +- **Cave + Keys Pots** - Both non-dungeon pots and pots that used to have keys +- **Reduced Dungeon Pots** - Cave+Keys plus roughly 25% of dungeon pots (dynamic mode with colored pots) +- **Clustered Dungeon Pots** - Like reduced but pots grouped by logical sets, roughly 50% chosen (dynamic mode) +- **Excludes Empty Pots** - All pots that had some sort of objects under them +- **Dungeon Pots** - The pots that are in dungeons +- **Lottery** - All pots and large blocks are in the pool + +CLI: `--pottery [none|keys|cave|cavekeys|reduced|clustered|nonempty|dungeon|lottery]` + +#### Colorize Pots + +Colors the pots that have been chosen to be part of the location pool. Forced on for dynamic modes (clustered and reduced). + +CLI: `--colorizepots` + +### Shuffle Enemy Drops + +Controls whether enemies that drop items are randomized: + +- **None** - Special enemies drop keys normally +- **Keys** - Enemies that drop keys are added to the randomization pool (includes Hyrule Castle Big Key) +- **Underworld** - Enemies in the underworld are added to the randomization pool. Blue square indicates if there are any enemies on the supertile that still have an available drop + +CLI: `--dropshuffle [none|keys|underworld]` + +### Shopsanity + +Adds 32 shop locations (9 more in retro) to the general location pool. Multi-world supported. + +Shop locations include: +- Lake Hylia Cave Shop (3 items) +- Kakariko Village Shop (3 items) +- Potion Shop (3 new items) +- Paradox Cave Shop (3 items) +- Capacity Upgrade Fairy (2 items) +- Dark Lake Hylia Shop (3 items) +- Curiosity/Red Shield Shop (3 items) +- Dark Lumberjack Shop (3 items) +- Dark Potion Shop (3 items) +- Village of Outcast Hammer Peg Shop (3 items) +- Dark Death Mountain Shop (3 items) + +[See README for complete pricing guide and mechanics](/README#shopsanity) + +### Take Any Caves + +Three options: None, Random, and Fixed. Fixed means take any caves replace specific fairy caves: + +- 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" + +#### Bomb Bag + +Two bomb bags are added to the item pool (look like +10 Capacity upgrades). Bombs are unable to be used until one is found. + +CLI: `--bombbag` + +#### Pseudo Boots + +Dashing is allowed without the boots item however doors and certain rocks remain unopenable until boots are found. Specific sequence breaks like hovering and water-walking are not allowed until boots are found. + +CLI: `--pseudoboots` + +#### Mirror Scroll + +Mirror is usable inside dungeons. Locations that require the mirror are still unattainable. + +CLI: `--mirrorscroll` + +#### Flute Mode + +- **Normal** - Need to activate it at the village statue after finding it +- **Activated** - Can use it immediately upon finding it + +CLI: `--flute_mode` + +#### Bow Mode + +- **Progressive** - Standard progressive bows +- **Silvers separate** - One bow in the pool and silvers are a separate item +- **Retro (progressive)** - Arrows cost rupees, need to purchase single arrow item at shop +- **Retro + Silvers** - Arrows cost rupees, one bow, silvers are separate item + +CLI: `--bow_mode [progressive|silvers|retro|retro_silvers]` + + + +### Goal Options + +- **Trinity** - Find one of 3 triforces to win (pedestal, Ganon, or Murahdahla with 8 of 10 pieces) +- **Ganonhunt** - Collect the requisite triforce pieces, then defeat Ganon (Aga2 not required) +- **Completionist** - Obtain every item in the game and defeat Ganon (forces 100% accessibility) + +### Item Sorting (Fill Algorithms) + +Controls how items are placed in the world: + +#### Balanced + +Most random distribution of items (recommended). + +#### Vanilla Fill + +Attempts to place all items in their vanilla locations when possible. If not possible, prefers "major" locations, then heart piece locations, then the rest. + +#### Major Location Restriction + +Attempts to place major items in major locations. Major locations are where major items are found in the vanilla game. + +#### Dungeon Restriction + +Attempts to place all major items in dungeons. Overflows to overworld if necessary. + +#### District Restriction + +The world is divided into different regions/districts. Districts are chosen at random and filled with major items. Single green rupees indicate chosen districts. + +CLI: `--algorithm [balanced|vanilla_fill|major_only|dungeon_only|district]` + +### Forbidden Boss Items + +Restrict items that can appear on bosses: + +- **None** - Boss may have any item +- **MapCompass** - Map and compass are logically required to defeat a boss (currently bugged) +- **Dungeon** - Small keys and big keys of the dungeon are not allowed on a boss + +CLI: `--restrict_boss_items [none|mapcompass|dungeon]` + +--- + +## Entrance Randomization + +### New Modes + +- **Lite** - Non item entrances are vanilla, dungeons/caves grouped with restrictions +- **Lean** - Same grouping as Lite but cross-world connections allowed +- **Swapped** - Entrances are swapped with each other + +### Shuffle Links House + +In certain ER shuffles (not dungeonssimple or dungeonsfulls), control whether Links House is shuffled or remains vanilla. + +### Skull Woods Shuffle + +Options to reduce annoying Skull Woods layouts: + +- **Original** - Skull woods shuffles classically amongst itself unless insanity mode +- **Restricted** - Skull woods drops are vanilla, entrances stay in skull woods and are shuffled +- **Loose** - Skull woods drops are vanilla, main ER mode's pool determines handling +- **Followlinked** - Follows Linked Drops setting + +### Linked Drops Override + +Controls whether drops should be linked to nearby entrances: + +- **Unset** - Uses the mode's default (linked for all modes except insanity) +- **Linked** - Forces drops to be linked to their entrances +- **Independent** - Decouples drops from entrances + +### Overworld Map + +Option to move indicators on overworld map to reference dungeon location: + +- **Default** - Showing only the prize markers on vanilla dungeon locations +- **Compass** - Compass item controls whether marker is moved to dungeon locations +- **Map** - Map item shows both prize and location of the dungeon + +CLI: `--overworld_map [default|compass|map]` + +--- + +## Enemizer + +Enemizer has been incorporated into the generator. See [Enemizer in DR documentation](https://docs.google.com/document/d/1iwY7Gy50DR3SsdXVaLFIbx4xRBqo9a-e1_jAl5LMCX8/edit?usp=sharing) for extensive details. + +### Enemy Shuffle + +Enemies are shuffled with an enemy ban list that prevents problematic placements (blocking paths, unavoidable damage, glitches). + +### Enemy Damage + +The shuffled setting actually shuffles the damage table unlike the original enemizer. + +### Boss Shuffle: Unique + +Bosses are shuffled with some exceptions: +- Trinexx is not allowed on GT basement when DR is enabled +- Harder bosses in GT basement have logic concessions for low percentage requirements + +New variant: At least one boss of each type for prize bosses will be present guarding prizes. + +### Enemy Health + +Health is taken into account for challenge rooms if magic or ammo is required. + +### Enemy Logic + +Can account for logical access to challenge rooms and item/key drops when enemies are shuffled: + +- **Forbid special enemies** - Special enemies disallowed from drops and challenge rooms +- **Item drops may have special enemies** - Challenge rooms won't have special enemies, but drops may +- **Allow special enemies anywhere** - Both challenge rooms and enemy drops can have special requirements + +--- + +## Glitched Logic + +CLI: `--logic [noglitches|owglitches|hybridglitches|nologic]` + +### Overworld Glitches + +Includes overworld teleports, clips, superbunny, mirror to access Desert Palace East Entrance, bunny pocket access, etc. + +### Hybrid Major Glitches + +**Not compatible with Door Shuffle** + +Includes all Overworld Glitches logic plus: +- Kikiskip to access PoD without MP or DW access +- IP Lobby clip to skip fire requirement +- Various traversals between dungeons (TT ↔ Desert, Spec rock, Paradox, Mire ↔ Hera ↔ Swamp) +- Stealing SK from Mire to open SP +- Using Mire big key to open Hera doors + +--- + +## Game Options + +### MSU Resume + +Turns on MSU resume support. + +CLI: `--msu_resume` + +### Collection Rate + +Display the collection rate unless the triforce piece counter is needed. + +CLI: `--collection_rate` + +### Reduce Flashing + +Accessibility option to reduce some flashing animations in the game. + +CLI: `--reduce_flashing` + +### Shuffle Sound Effects + +Shuffles a large portion of the sound effects. Can be used with the adjuster. + +CLI: `--shuffle_sfx` + +--- + +## Customizer + +Create custom seeds with custom dungeons and rooms. + +See [Customizer documentation](Customizer.md) for details. + +--- + +## Generation Setup & Miscellaneous + +### Create BPS Patches + +Create BPS patch(es) instead of generating ROM(s) for distribution. + +CLI: `--bps` + +### Triforce Hunt Settings + +Controls for triforce piece pool: +- `--triforce_goal_min` / `--triforce_goal_max` - Pieces to collect to win +- `--triforce_pool_min` / `--triforce_pool_max` - Pieces in item pool +- `--triforce_min_difference` / `--triforce_max_difference` - Difference between pool and goal + +### Seed + +Set a seed number to generate. Same seed with same settings on same version will always yield identical output. + +### Count + +Batch generate multiple seeds with same settings. If seed number provided, it will be used to derive subsequent seeds. diff --git a/index.md b/index.md new file mode 100644 index 00000000..f8ba5794 --- /dev/null +++ b/index.md @@ -0,0 +1,81 @@ +--- +layout: default +title: Home +nav_order: 1 +--- + +# ALttP Dungeon Randomizer + +**A dungeon randomizer for The Legend of Zelda: A Link to the Past** + +Door Randomizer extends the standard ALttP Entrance Randomizer with advanced dungeon shuffling capabilities that can rearrange dungeon interiors at the room level, creating entirely new dungeon experiences. + +[Download Latest Release](https://github.com/aerinon/ALttPDoorRandomizer/releases/latest){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 } +[View on GitHub](https://github.com/aerinon/ALttPDoorRandomizer){: .btn .fs-5 .mb-4 .mb-md-0 } + +--- + +## What is Door Randomizer? + +Door Randomizer takes the dungeon experience in A Link to the Past to the next level by shuffling the connections between rooms within dungeons. Instead of just shuffling dungeon entrances, Door Randomizer can: + +- **Shuffle doors within dungeons** - Rooms connect in completely new ways +- **Cross dungeon boundaries** - Walk through a door in Eastern Palace and end up in Tower of Hera +- **Adjust intensity levels** - From basic door shuffling to complete dungeon lobby randomization + +## Key Features + +### Basic Randomizer Features + +- Supports many standard ALttP Randomizer features without needing more advanced settings. + +### Door Shuffle Modes +- **Vanilla** - No shuffling, classic experience +- **Basic** - Doors shuffled within each dungeon +- **Partitioned** - Shuffle in pools (Light World, Early Dark World, Late Dark World) +- **Crossed** - Full shuffle between all dungeons + +### Intensity Levels +- **Level 1** - Normal doors and spiral staircases +- **Level 2** - + open edges and straight staircases +- **Level 3** - + dungeon lobbies + +### Advanced Features +- **Multiple key shuffle modes** - In dungeon, randomized, or universal keys +- **Pottery shuffle** - Randomize items under pots with multiple modes +- **Shopsanity** - 32 shop locations added to item pool +- **Enemy randomization** - Built-in enemizer with logic-aware placement +- **Custom seeds** - Create your own custom dungeons and rooms +- **Fill algorithms** - Multiple item placement strategies (balanced, vanilla fill, major only, district) + +## Quick Start + +1. [Download the latest release](https://github.com/aerinon/ALttPDoorRandomizer/releases/latest) +2. Extract the archive for your platform (Windows, Mac, or Linux) +3. Run `DungeonRandomizer.exe` (or the appropriate platform executable) +4. Configure your settings and generate a seed +5. Apply the patch to your A Link to the Past ROM (must be JP 1.0 version) + +[See detailed installation instructions β†’](installation.html) + +## Community + +Join the discussion and get help: + +- **Discord**: [ALTTP Randomizer Discord](https://discordapp.com/invite/alttprandomizer) + - `#door-rando` - General discussion and help + - `#bug-reports` - Report bugs and issues + +## Learn More + +- [Features Guide](features.html) - Comprehensive feature documentation +- [Installation & Usage](installation.html) - Setup and running the randomizer +- [Known Issues](known-issues.html) - Current bugs and limitations +- [Roadmap](roadmap.html) - Future development plans +- [Blog](blog.html) - Latest updates and release notes + +## Credits + +Based on the [ALttP Entrance Randomizer](https://github.com/KevinCathcart/ALttPEntranceRandomizer) by KevinCathcart et al. + +See [alttpr.com](https://alttpr.com/) for more details on the original VT randomizer. diff --git a/installation.md b/installation.md new file mode 100644 index 00000000..0c02b8ec --- /dev/null +++ b/installation.md @@ -0,0 +1,369 @@ +--- +layout: default +title: Installation & Usage +nav_order: 3 +--- + +# Installation & Usage +{: .no_toc } + +Complete guide to installing and running ALttP Door Randomizer. +{: .fs-6 .fw-300 } + +## Table of contents +{: .no_toc .text-delta } + +1. TOC +{:toc} + +--- + +## Requirements + +- Python 3.10 or higher (for running from source) +- A legal copy of The Legend of Zelda: A Link to the Past (JP 1.0 version) ROM + +--- + +## Installation Methods + +### Method 1: Pre-built Releases (Recommended) + +This is the easiest method for most users. + +1. Visit the [Releases page](https://github.com/aerinon/ALttPDoorRandomizer/releases) +2. Download the appropriate build for your system: + - **Windows**: `ALttPDoorRandomizer-{version}-windows.zip` + - **macOS**: `ALttPDoorRandomizer-{version}-osx.tar.gz` + - **Linux**: `ALttPDoorRandomizer-{version}-linux-focal.tar.gz` +3. Extract the archive to a folder of your choice +4. Run the executable: + - **Windows**: `DungeonRandomizer.exe` + - **macOS/Linux**: `./DungeonRandomizer` or `./Gui.py` + +### Method 2: Running from Source + +For developers or users who want to run the latest development version. + +#### Step 1: Clone the Repository + +```bash +git clone https://github.com/aerinon/ALttPDoorRandomizer.git +cd ALttPDoorRandomizer +``` + +For the development branch: +```bash +git checkout DoorDevUnstable +``` + +#### Step 2: Install Python Dependencies + +The project includes a script to install platform-specific dependencies: + +```bash +python resources/ci/common/local_install.py +``` + +This will install all necessary Python packages and platform-specific dependencies. + +#### Step 3: Verify Installation + +Test that everything is working: + +```bash +python DungeonRandomizer.py --help +``` + +You should see the help text with all available options. + +--- + +## Usage + +### GUI (Graphical User Interface) + +The GUI provides an easy-to-use interface for generating seeds. + +#### Starting the GUI + +**Pre-built release:** +- **Windows**: Double-click `DungeonRandomizer.exe` +- **macOS/Linux**: Run `./DungeonRandomizer` from terminal + +**From source:** +```bash +python Gui.py +``` + +#### Using the GUI + +1. **Select your ROM**: Click "Select ROM" and choose your ALttP ROM file +2. **Configure settings**: Use the tabs to adjust: + - **Dungeon Settings**: Door shuffle mode, intensity, key logic + - **Item Settings**: Item placement, shopsanity, pottery + - **Entrance Settings**: Entrance randomization options + - **Enemy Settings**: Enemy shuffle, boss shuffle + - **Game Options**: MSU resume, collection rate, etc. +3. **Generate**: Click "Generate" to create your seed +4. **Output**: The patched ROM will be created in the same directory + +### CLI (Command-Line Interface) + +The CLI offers more control and is useful for batch generation or scripting. + +#### Basic Usage + +```bash +python DungeonRandomizer.py [options] +``` + +#### Common Examples + +**Basic crossed dungeon shuffle:** +```bash +python DungeonRandomizer.py --doorShuffle crossed --intensity 2 +``` + +**With key shuffle and shopsanity:** +```bash +python DungeonRandomizer.py --doorShuffle crossed --keyshuffle wild --shopsanity +``` + +**Pottery and enemy drops:** +```bash +python DungeonRandomizer.py --doorShuffle basic --pottery lottery --dropshuffle underworld +``` + +**Generate without creating ROM (testing):** +```bash +python DungeonRandomizer.py --suppress_rom --spoiler none +``` + +**Create BPS patch instead of ROM:** +```bash +python DungeonRandomizer.py --bps --doorShuffle crossed +``` + +**Batch generation:** +```bash +python DungeonRandomizer.py --doorShuffle crossed --count 10 +``` + +#### Key CLI Arguments + +**Dungeon Settings:** +- `--doorShuffle [vanilla|basic|partitioned|crossed]` - Door shuffle mode +- `--intensity [1|2|3]` - Intensity level +- `--keyshuffle [none|wild|universal]` - Key shuffle mode +- `--key_logic [partial|strict|dangerous]` - Key logic algorithm +- `--door_type_mode [original|big|all|chaos]` - Door type shuffle +- `--trap_door_mode [vanilla|optional|boss|oneway]` - Trap door removal + +**Item Settings:** +- `--algorithm [balanced|vanilla_fill|major_only|dungeon_only|district]` - Item placement +- `--pottery [none|keys|cave|cavekeys|reduced|clustered|nonempty|dungeon|lottery]` - Pot shuffle +- `--dropshuffle [none|keys|underworld]` - Enemy drop shuffle +- `--shopsanity` - Enable shop randomization +- `--bombbag` - Enable bomb bag item +- `--pseudoboots` - Enable pseudo boots + +**Entrance Settings:** +- `--shuffle [vanilla|simple|restricted|full|crossed|insanity|...]` - Entrance shuffle mode +- `--overworld_map [default|compass|map]` - Overworld map mode + +**Enemy Settings:** +- `--enemizercli [none|basic|shuffled]` - Enemy shuffle mode +- `--enemy_damage [default|shuffled|chaos]` - Enemy damage +- `--enemy_health [default|easy|hard]` - Enemy health +- `--shufflebosses [none|basic|normal|chaos|unique]` - Boss shuffle + +**Logic:** +- `--logic [noglitches|owglitches|hybridglitches|nologic]` - Logic mode +- `--mode [open|standard|inverted]` - Game mode +- `--goal [ganon|trinity|ganonhunt|completionist]` - Victory condition + +**Generation:** +- `--seed SEED` - Set seed number +- `--count N` - Generate N seeds +- `--suppress_rom` - Don't create ROM (testing) +- `--bps` - Create BPS patch instead of ROM +- `--spoiler [none|spoiler|playthrough]` - Spoiler log type + +**Game Options:** +- `--msu_resume` - Enable MSU resume +- `--collection_rate` - Display collection rate +- `--reduce_flashing` - Reduce flashing animations +- `--shuffle_sfx` - Shuffle sound effects + +For a complete list of options: +```bash +python DungeonRandomizer.py --help +``` + +--- + +## Multiworld Setup + +Door Randomizer supports multiworld seeds where multiple players play different randomized games with shared item pools. + +### Installing Multiworld Dependencies + +Run the same installation script to install multiworld-specific dependencies: + +```bash +python resources/ci/common/local_install.py +``` + +### Generating Multiworld Seeds + +Create YAML files for each player (see `docs/player1.yml`, `docs/player2.yml`, `docs/player3.yml` for individual examples, or `docs/multi_mystery_example.yaml` for a complete multiworld configuration). + +**Example player configuration:** +```yaml +description: Player 1's World +name: Player1 +doorShuffle: crossed +intensity: 2 +keyshuffle: wild +shopsanity: true +``` + +Generate the multiworld using the multi-mystery configuration file: +```bash +python DungeonRandomizer.py --customizer docs/multi_mystery_example.yaml +``` + +### Running Multiworld Server + +```bash +python MultiServer.py +``` + +It will prompt you for the multidata file created from the multiworld generation step. + +### Connecting with Multiworld Client + +```bash +python MultiClient.py +``` + +Enter the server address and your player name to connect. + +--- + +## Testing & Verification + +### Running the Test Suite + +To verify your installation and test the randomizer logic: + +```bash +python TestSuite.py +``` + +**Test with specific settings:** +```bash +python TestSuite.py --dr basic --count 10 --tense 2 +``` + +**Run specific test modules:** +```bash +python -m pytest test/ +python -m pytest test/dungeons/TestDarkPalace.py +``` + +--- + +## Troubleshooting + +### Common Issues + +#### "Python not found" or "python: command not found" + +- **Windows**: Make sure Python is installed and added to PATH during installation +- **macOS/Linux**: Install Python 3.10+ via your package manager or from [python.org](https://www.python.org/) + +#### "No module named 'yaml'" or similar import errors + +Run the dependency installation script: +```bash +python resources/ci/common/local_install.py +``` + +#### Pre-built executable won't run on macOS + +macOS may block unsigned applications. Right-click the app and select "Open" to bypass the warning. + +#### Pre-built executable won't run on Linux + +Ensure the file has execute permissions: +```bash +chmod +x DungeonRandomizer +``` + +#### GUI window is too small or cut off + +Try running from the command line to see if there are any error messages. Some display scaling settings can cause issues. + +#### Generated ROM doesn't work with emulator + +- Ensure you're using a clean US version of ALttP ROM (Japan 1.0) +- Try a different emulator (recommended: SNES9x, RetroArch with bsnes core) +- Verify the ROM was patched successfully (check file size and modification date) + +### Getting Help + +If you encounter issues: + +1. Check the [Known Issues](/known-issues) page +2. Search [GitHub Issues](https://github.com/aerinon/ALttPDoorRandomizer/issues) +3. Ask in the [ALTTP Randomizer Discord](https://discordapp.com/invite/alttprandomizer): + - `#door-rando` - General help and questions + - `#bug-reports` - Report bugs and issues + +When reporting issues, please include: +- Operating system and version +- Python version (`python --version`) +- Door Randomizer version or commit hash +- Full error message or description of the problem +- Settings used (CLI command or screenshot of GUI) + +--- + +## Advanced Usage + +### Custom Presets + +You can create custom preset files to save your favorite settings combinations. + +See the [Customizer documentation](docs/Customizer.md) for details on creating custom seeds with custom dungeons and rooms. + +### Build from Source (Packaging) + +To create a standalone executable from source: + +See [BUILDING.md](docs/BUILDING.md) for detailed build instructions. + +### Development Workflow + +For contributors: + +1. Fork the repository +2. Create a feature branch from `DoorDevUnstable`: + ```bash + git checkout DoorDevUnstable + git checkout -b my-feature + ``` +3. Make your changes +4. Run tests: `python TestSuite.py` +5. Submit a pull request to `DoorDevUnstable` (not main/master) + +--- + +## Next Steps + +- Read the [Features Guide](/features) for detailed information on all settings +- Check the [Known Issues](/known-issues) page for current limitations +- See the [Roadmap](/roadmap) for upcoming features +- Join the community on [Discord](https://discordapp.com/invite/alttprandomizer) diff --git a/known-issues.md b/known-issues.md new file mode 100644 index 00000000..15b3daeb --- /dev/null +++ b/known-issues.md @@ -0,0 +1,366 @@ +--- +layout: default +title: Known Issues +nav_order: 4 +--- + +# Known Issues & Bug Tracking +{: .no_toc } + +Current known issues, bugs, and limitations in ALttP Door Randomizer. +{: .fs-6 .fw-300 } + +## Table of contents +{: .no_toc .text-delta } + +1. TOC +{:toc} + +--- + +## Reporting Bugs + +Before reporting a bug, please: + +1. Check this page to see if the issue is already known +2. Search [existing GitHub issues](https://github.com/aerinon/ALttPDoorRandomizer/issues) +3. Verify you're using the latest version + +### How to Report + +Report bugs in this location: + +- **Discord**: [ALTTP Randomizer Discord](https://discordapp.com/invite/alttprandomizer) in `#bug-reports` or `#door-rando` channels + +### What to Include + +When reporting a bug, please provide: + +- **Spoiler log** if you have one +- If you don't have a spoiler log, include: + - **Seed number** and **settings used** + - **Version** of Door Randomizer (from GUI or `--version`) +- **Website or Platform** (Windows, macOS, Linux) if generator error, or which website was used +- **Description** of the issue +- **Steps to reproduce** the problem +- **Screenshots or videos** (if applicable) +- Optionally, **Save state** (if gameplay issue) (and which emulator/version) + +--- + +## Known Issues + +### Critical Issues + +#### Links House on Death Mountain - no logical way off the mountain + +**Status**: Under investigation + +Some ER generations can have Link's House be on Death Mountain and no good way off the mountain. + + +--- + +### Major Issues + +#### Crossed Dungeon Generation Can Be Slow + +**Status**: Performance optimization needed + +Generating crossed dungeon seeds, especially with high intensity and complex settings, can take a significant amount of time (30 seconds to several minutes). + +**Why**: The dungeon generation algorithm uses constraint satisfaction and local search, which can require many attempts to find valid layouts. + +**Workaround**: Be patient, or reduce intensity/complexity of settings. + +#### Rare Impossible Seeds (Generation Failures) + +**Status**: Occasional, investigating + +In rare cases, the generator may fail to place all items or create a valid dungeon layout. This usually happens with very restrictive settings combinations. + +**Workaround**: Try a different seed number, or slightly adjust settings. + +--- + +### Moderate Issues + +#### Some Enemy Placements Can Be Problematic + +**Status**: Ongoing ban list maintenance + +Despite the enemy ban list, some enemy placements can occasionally cause issues: +- Blocking required paths +- Causing unavoidable damage +- Creating glitchy behavior +- Bush enemies not working correctly +- Wallmasters can cause issues in certain locations + +**Workaround**: Report specific problematic enemy locations so they can be added to the ban list. + +**Note**: Thieves are always unkillable and banned from the entire underworld. + + +--- + +### Minor Issues + +#### Forbidden Boss Items "MapCompass" Mode Bugged + +**Status**: Under investigation + +The `mapcompass` option for `--restrict_boss_items` is currently bugged and not recommended for use. + +**Workaround**: Use `dungeon` option instead, or use `none`. + +#### Swamp Trench 2 Keeps Draining + +**Status**: Known issue + +In some configurations, Swamp Trench 2 continues to drain even after the pot is obtained. + +**Workaround**: None currently. This is a known behavior issue. + +#### Killing Certain Red Guards Kills Music + +**Status**: Known issue + +Killing certain red guards in specific locations causes the music to stop playing. + +**Workaround**: None currently. This is a cosmetic issue that doesn't affect gameplay. + +#### Some Lobbies Exitable During Escape (Standard Mode) + +**Status**: Known issue + +In standard mode, some dungeon lobbies can be exited during the escape sequence when they shouldn't be. + +**Workaround**: Avoid leaving during escape if you want to maintain intended flow. + +--- + +### Logic Issues + +These are cases where the logic may not perfectly match what's actually possible in-game: + +#### GT Crystal Paths Room Logic + +**Status**: Under investigation + +Crystal switch logic for GT Crystal Paths room may not properly account for OHKO scenarios when traversing backwards. + +#### OHKO (One-Hit KO) Logic Issues + +**Status**: Under investigation + +In some configurations, unavoidable damage logic or OHKO scenarios may not be properly accounted for. + +#### Hammerjump Logic and Mixed Travel + +**Status**: Configurable behavior + +Hammerjump and similar tricks (PoD Arena hovering, Mire Big Key bomb jump) can unintentionally put you in another dungeon with the wrong dungeon ID. + +**Setting**: Use `--mixed_travel` to control this behavior: +- `prevent`: Adds rails to prevent tricks (default, recommended for learning) +- `allow`: Up to player discretion +- `force`: Sections forced to same dungeon + +--- + +## Mode-Specific Issues + +### Glitched Logic Modes + +Several issues specific to glitched logic modes (OWG, HMG): + +#### Cave State Issues + +**Status**: Under investigation + +Cave state in GT hearts area may not work correctly in glitched modes. + +#### Rain State Issues + +**Status**: Under investigation + +Rain state handling may have issues in glitched logic modes. + +#### Key/Pot SRAM System + +**Status**: Needs restoration + +Old key/pot SRAM system needs to be restored for glitched modes to work properly. + +### Inverted Mode Issues + +#### Dark Sanctuary Inverted Insanity + +**Status**: Under investigation + +Dark Sanctuary with inverted mode and insanity entrance shuffle may have double entrance issues. + +#### Dark Sanctuary at Tavern Error + +**Status**: In progress + +When Dark Sanctuary is at Tavern location, Link's body position may be incorrect. + +### Entrance Randomization Issues + +#### Dungeon Boss Exits in Non-ER + +**Status**: Under investigation + +Dungeon boss exits may not work correctly when entrance randomization is disabled. + +### Decoupled Doors Issues + +#### Sanctuary Palette Detection + +**Status**: Known issue + +In decoupled doors mode, sanctuary palette doesn't correctly identify adjacent rooms. Uses exits instead of entrances for determination. + +**Workaround**: Use coupled doors or original palette mode. + +### Shopsanity Issues + +#### Output YAML: Shopsanity Potions Missing + +**Status**: Under investigation + +When outputting to YAML format, shopsanity potions may not be correctly included in the item pool representation. + +**Workaround**: Check spoiler log for actual item locations. + +--- + +## Known Limitations & Design Decisions + +These items are **not planned to be fixed** as they are either fundamental limitations, intentional design choices, or affect all ALttP randomizers. + +### Game Engine Limitations + +#### Compass Count Stops Working After Triforce + +After obtaining the Triforce, compass counts no longer function correctly. This is true in all ALttP randomizers and is a base game limitation. + +**Workaround**: Complete dungeon exploration before finishing the game if you need counts. + +#### GT Bosses Don't Respawn + +GT bosses don't respawn after killing them. This is intentional base game behavior. + +### Door Randomizer Design Decisions + +#### Hybrid Major Glitches Not Compatible with Door Shuffle + +Hybrid major glitches logic is not compatible with door shuffle modes. This is a fundamental limitation due to how glitch logic interacts with shuffled dungeon interiors. + +**Workaround**: Use Overworld Glitches logic instead, or disable door shuffle. + +#### Fire Rod Not in Logic for Dark Rooms + +Fire Rod is not in logic for dark rooms in door shuffle mode, as it's too difficult to determine which dark room you're in after doors are shuffled. + +**Note**: This is different from Advanced mode in the vanilla randomizer. + +#### Hammerjump Requiring Mixed Travel Settings + +Hammerjump and similar tricks (PoD Arena hovering, Mire Big Key bomb jump) require `--mixed_travel` settings in crossed mode to allow unintended dungeon transitions. + +#### Blind Maiden/Attic Sequence Always Required + +Blind maiden/attic sequence is required even when boss is shuffled. This maintains story consistency. + +#### Southeast Skull Woods Chest Not Guaranteed Key + +In Entrance Randomizer, the southeast Skull Woods chest is guaranteed to be a small key. In Door Randomizer, this is not guaranteed. This is an intentional change from ER. + +### Technical Limitations + +#### Pottery Lottery Mode: Multiworld Item Limit + +In pottery lottery mode, only 256 items for other players can be placed under pots in your world due to technical constraints in how the game tracks items. + +--- + +## Feature Limitations + +See the [Roadmap](/roadmap) for planned features. + +--- + +## Recently Fixed Issues + +See RELEASENOTES.md for the latest fixes. + +And PastReleaseNotes.md for older fixes. + +--- + +## Performance Issues + +### Memory Usage + +**Issue**: Generator can use significant memory for complex seeds. + +**Most affected by**: +- Multiworld with many players +- Pottery lottery mode + +**Workaround**: Close other applications, or increase available RAM. + +--- + +## Emulator Compatibility + +### Known Issues with Emulators + +#### Older SNES9x versions + +Some older versions (< 1.55) may have graphical glitches with certain custom graphics. + +#### ZSNES + +**Not recommended**: ZSNES is outdated and has known accuracy issues. + +--- + +## Workarounds & Tips + +### If Generation Keeps Failing + +1. Switch to a different door shuffle mode +4. Disable some restrictive settings (strict key logic, dungeon item restrictions) +5. Use balanced fill algorithm instead of district restriction + +### If Seed Seems Impossible + +1. Check spoiler log to verify it's beatable +2. Remember new logic differences (see Features guide) +3. Check for required techniques (boots bonking, crystal switch bombs, etc.) +4. Ask for help in Discord with spoiler log + +### If Performance Is Poor + +1. Use pre-built executable instead of running from source +2. Close other applications +3. Update to latest version +4. Use simpler settings combinations + + +--- + +## Issue Status Tracking + +For real-time status of known issues, check: + +- Discord `#bug-reports` and `#door-rando` channels + +--- + +Last updated: 2026-01-30 + +This page is maintained as issues are discovered and fixed. If you notice an issue not listed here, please report it! diff --git a/presets/world/owr_blockshuffle.yaml b/presets/world/owr_blockshuffle.yaml index 55f27c87..8da580cc 100644 --- a/presets/world/owr_blockshuffle.yaml +++ b/presets/world/owr_blockshuffle.yaml @@ -1,5 +1,6 @@ -meta: - players: 1 +settings: + 1: + ow_layout: wild ow-edges: 1: two-way: diff --git a/presets/world/owr_checkerboardshuffle.yaml b/presets/world/owr_checkerboardshuffle.yaml new file mode 100644 index 00000000..b173f67d --- /dev/null +++ b/presets/world/owr_checkerboardshuffle.yaml @@ -0,0 +1,140 @@ +settings: + 1: + ow_layout: grid +ow-grid: + 1: + restricted_positions: + - cells: + - 0x00 + - 0x02 + - 0x04 + - 0x06 + - 0x09 + - 0x0B + - 0x0D + - 0x0F + - 0x10 + - 0x12 + - 0x14 + - 0x16 + - 0x19 + - 0x1B + - 0x1D + - 0x1F + - 0x20 + - 0x22 + - 0x24 + - 0x26 + - 0x29 + - 0x2B + - 0x2D + - 0x2F + - 0x30 + - 0x32 + - 0x34 + - 0x36 + - 0x39 + - 0x3B + - 0x3D + - 0x3F + positions: + - 0x00 + - 0x02 + - 0x04 + - 0x06 + - 0x09 + - 0x0B + - 0x0D + - 0x0F + - 0x10 + - 0x12 + - 0x14 + - 0x16 + - 0x19 + - 0x1B + - 0x1D + - 0x1F + - 0x20 + - 0x22 + - 0x24 + - 0x26 + - 0x29 + - 0x2B + - 0x2D + - 0x2F + - 0x30 + - 0x32 + - 0x34 + - 0x36 + - 0x39 + - 0x3B + - 0x3D + - 0x3F + world: both + - cells: + - 0x01 + - 0x03 + - 0x05 + - 0x07 + - 0x08 + - 0x0A + - 0x0C + - 0x0E + - 0x11 + - 0x13 + - 0x15 + - 0x17 + - 0x18 + - 0x1A + - 0x1C + - 0x1E + - 0x21 + - 0x23 + - 0x25 + - 0x27 + - 0x28 + - 0x2A + - 0x2C + - 0x2E + - 0x31 + - 0x33 + - 0x35 + - 0x37 + - 0x38 + - 0x3A + - 0x3C + - 0x3E + positions: + - 0x01 + - 0x03 + - 0x05 + - 0x07 + - 0x08 + - 0x0A + - 0x0C + - 0x0E + - 0x11 + - 0x13 + - 0x15 + - 0x17 + - 0x18 + - 0x1A + - 0x1C + - 0x1E + - 0x21 + - 0x23 + - 0x25 + - 0x27 + - 0x28 + - 0x2A + - 0x2C + - 0x2E + - 0x31 + - 0x33 + - 0x35 + - 0x37 + - 0x38 + - 0x3A + - 0x3C + - 0x3E + world: both \ No newline at end of file diff --git a/presets/world/owr_quadrantshuffle-diagonal.yaml b/presets/world/owr_quadrantshuffle-diagonal.yaml index 010d9e3c..56209a63 100644 --- a/presets/world/owr_quadrantshuffle-diagonal.yaml +++ b/presets/world/owr_quadrantshuffle-diagonal.yaml @@ -1,3 +1,6 @@ +settings: + 1: + ow_layout: wild ow-edges: 1: groups: diff --git a/presets/world/owr_quadrantshuffle-full.yaml b/presets/world/owr_quadrantshuffle-full.yaml index 6dabad7c..f230cdca 100644 --- a/presets/world/owr_quadrantshuffle-full.yaml +++ b/presets/world/owr_quadrantshuffle-full.yaml @@ -1,3 +1,6 @@ +settings: + 1: + ow_layout: wild ow-edges: 1: groups: diff --git a/presets/world/owr_quadrantshuffle-grid.yaml b/presets/world/owr_quadrantshuffle-grid.yaml new file mode 100644 index 00000000..c655fa49 --- /dev/null +++ b/presets/world/owr_quadrantshuffle-grid.yaml @@ -0,0 +1,147 @@ +settings: + 1: + ow_layout: grid +ow-grid: + 1: + restricted_positions: + - cells: + - 0x00 + - 0x01 + - 0x02 + - 0x03 + - 0x08 + - 0x09 + - 0x0A + - 0x0B + - 0x10 + - 0x11 + - 0x12 + - 0x13 + - 0x18 + - 0x19 + - 0x1A + - 0x1B + positions: + - 0x00 + - 0x01 + - 0x02 + - 0x03 + - 0x08 + - 0x09 + - 0x0A + - 0x0B + - 0x10 + - 0x11 + - 0x12 + - 0x13 + - 0x18 + - 0x19 + - 0x1A + - 0x1B + world: both + - cells: + - 0x20 + - 0x21 + - 0x22 + - 0x23 + - 0x28 + - 0x29 + - 0x2A + - 0x2B + - 0x30 + - 0x31 + - 0x32 + - 0x33 + - 0x38 + - 0x39 + - 0x3A + - 0x3B + positions: + - 0x20 + - 0x21 + - 0x22 + - 0x23 + - 0x28 + - 0x29 + - 0x2A + - 0x2B + - 0x30 + - 0x31 + - 0x32 + - 0x33 + - 0x38 + - 0x39 + - 0x3A + - 0x3B + world: both + - cells: + - 0x04 + - 0x05 + - 0x06 + - 0x07 + - 0x0C + - 0x0D + - 0x0E + - 0x0F + - 0x14 + - 0x15 + - 0x16 + - 0x17 + - 0x1C + - 0x1D + - 0x1E + - 0x1F + positions: + - 0x04 + - 0x05 + - 0x06 + - 0x07 + - 0x0C + - 0x0D + - 0x0E + - 0x0F + - 0x14 + - 0x15 + - 0x16 + - 0x17 + - 0x1C + - 0x1D + - 0x1E + - 0x1F + world: both + - cells: + - 0x24 + - 0x25 + - 0x26 + - 0x27 + - 0x2C + - 0x2D + - 0x2E + - 0x2F + - 0x34 + - 0x35 + - 0x36 + - 0x37 + - 0x3C + - 0x3D + - 0x3E + - 0x3F + positions: + - 0x24 + - 0x25 + - 0x26 + - 0x27 + - 0x2C + - 0x2D + - 0x2E + - 0x2F + - 0x34 + - 0x35 + - 0x36 + - 0x37 + - 0x3C + - 0x3D + - 0x3E + - 0x3F + world: both + split_large_screens: true \ No newline at end of file diff --git a/presets/world/owr_quadrantshuffle-vanillaborders.yaml b/presets/world/owr_quadrantshuffle-vanillaborders.yaml index 22f9e8fb..41c6b7c8 100644 --- a/presets/world/owr_quadrantshuffle-vanillaborders.yaml +++ b/presets/world/owr_quadrantshuffle-vanillaborders.yaml @@ -1,5 +1,6 @@ settings: 1: + ow_layout: wild ow_whirlpool: false ow-edges: 1: diff --git a/presets/world/owr_ringshuffle-borders.yaml b/presets/world/owr_ringshuffle-borders.yaml index 3cbdb28f..8c96582b 100644 --- a/presets/world/owr_ringshuffle-borders.yaml +++ b/presets/world/owr_ringshuffle-borders.yaml @@ -1,3 +1,6 @@ +settings: + 1: + ow_layout: wild ow-edges: 1: two-way: diff --git a/presets/world/owr_ringshuffle-full.yaml b/presets/world/owr_ringshuffle-full.yaml index c271befe..e113aa2d 100644 --- a/presets/world/owr_ringshuffle-full.yaml +++ b/presets/world/owr_ringshuffle-full.yaml @@ -1,3 +1,6 @@ +settings: + 1: + ow_layout: wild ow-edges: 1: groups: diff --git a/presets/world/owr_ringshuffle-grid.yaml b/presets/world/owr_ringshuffle-grid.yaml new file mode 100644 index 00000000..ded19fe2 --- /dev/null +++ b/presets/world/owr_ringshuffle-grid.yaml @@ -0,0 +1,147 @@ +settings: + 1: + ow_layout: grid +ow-grid: + 1: + restricted_positions: + - cells: + - 0x00 + - 0x01 + - 0x02 + - 0x03 + - 0x04 + - 0x05 + - 0x06 + - 0x07 + - 0x08 + - 0x0F + - 0x10 + - 0x17 + - 0x18 + - 0x1F + - 0x20 + - 0x27 + - 0x28 + - 0x2F + - 0x30 + - 0x37 + - 0x38 + - 0x39 + - 0x3A + - 0x3B + - 0x3C + - 0x3D + - 0x3E + - 0x3F + positions: + - 0x00 + - 0x01 + - 0x02 + - 0x03 + - 0x04 + - 0x05 + - 0x06 + - 0x07 + - 0x08 + - 0x0F + - 0x10 + - 0x17 + - 0x18 + - 0x1F + - 0x20 + - 0x27 + - 0x28 + - 0x2F + - 0x30 + - 0x37 + - 0x38 + - 0x39 + - 0x3A + - 0x3B + - 0x3C + - 0x3D + - 0x3E + - 0x3F + world: both + - cells: + - 0x09 + - 0x0A + - 0x0B + - 0x0C + - 0x0D + - 0x0E + - 0x11 + - 0x16 + - 0x19 + - 0x1E + - 0x21 + - 0x26 + - 0x29 + - 0x2E + - 0x31 + - 0x32 + - 0x33 + - 0x34 + - 0x35 + - 0x36 + positions: + - 0x09 + - 0x0A + - 0x0B + - 0x0C + - 0x0D + - 0x0E + - 0x11 + - 0x16 + - 0x19 + - 0x1E + - 0x21 + - 0x26 + - 0x29 + - 0x2E + - 0x31 + - 0x32 + - 0x33 + - 0x34 + - 0x35 + - 0x36 + world: both + - cells: + - 0x12 + - 0x13 + - 0x14 + - 0x15 + - 0x1A + - 0x1D + - 0x22 + - 0x25 + - 0x2A + - 0x2B + - 0x2C + - 0x2D + positions: + - 0x12 + - 0x13 + - 0x14 + - 0x15 + - 0x1A + - 0x1D + - 0x22 + - 0x25 + - 0x2A + - 0x2B + - 0x2C + - 0x2D + world: both + - cells: + - 0x1B + - 0x1C + - 0x23 + - 0x24 + positions: + - 0x1B + - 0x1C + - 0x23 + - 0x24 + world: both + split_large_screens: true \ No newline at end of file diff --git a/presets/world/owr_ringshuffle-interiors.yaml b/presets/world/owr_ringshuffle-interiors.yaml index 0dcfbaa7..d63655ad 100644 --- a/presets/world/owr_ringshuffle-interiors.yaml +++ b/presets/world/owr_ringshuffle-interiors.yaml @@ -1,3 +1,6 @@ +settings: + 1: + ow_layout: wild ow-edges: 1: two-way: diff --git a/presets/world/owr_shuffle-dark.yaml b/presets/world/owr_shuffle-dark.yaml index 3b27e6d2..e6e7bf48 100644 --- a/presets/world/owr_shuffle-dark.yaml +++ b/presets/world/owr_shuffle-dark.yaml @@ -1,5 +1,6 @@ settings: 1: + ow_parallel: false ow_whirlpool: false ow-edges: 1: @@ -77,6 +78,25 @@ ow-edges: Desert Pass EC*: Dam WC* Desert Pass ES*: Dam WS* Dam EC*: South Pass WC* +ow-grid: + 1: + fixed_arrangements: + - arrangement: + - 0x00 0x01 0x02 0x03 0x04 0x05 0x06 0x07 + - 0x08 0x09 0x0A 0x0B 0x0C 0x0D 0x0E 0x0F + - 0x10 0x11 0x12 0x13 0x14 0x15 0x16 0x17 + - 0x18 0x19 0x1A 0x1B 0x1C 0x1D 0x1E 0x1F + - 0x20 0x21 0x22 0x23 0x24 0x25 0x26 0x27 + - 0x28 0x29 0x2A 0x2B 0x2C 0x2D 0x2E 0x2F + - 0x30 0x31 0x32 0x33 0x34 0x35 0x36 0x37 + - 0x38 0x39 0x3A 0x3B 0x3C 0x3D 0x3E 0x3F + world: light + restricted_positions: + - cells: + - 0x00 + positions: + - 0x00 + world: light ow-whirlpools: 1: two-way: diff --git a/presets/world/owr_shuffle-horizontal.yaml b/presets/world/owr_shuffle-horizontal.yaml index 9eba3118..7fead28b 100644 --- a/presets/world/owr_shuffle-horizontal.yaml +++ b/presets/world/owr_shuffle-horizontal.yaml @@ -1,3 +1,6 @@ +settings: + 1: + ow_layout: wild ow-edges: 1: two-way: diff --git a/presets/world/owr_shuffle-horizontalbycolumns.yaml b/presets/world/owr_shuffle-horizontalbycolumns.yaml index 117b81d5..f56e5696 100644 --- a/presets/world/owr_shuffle-horizontalbycolumns.yaml +++ b/presets/world/owr_shuffle-horizontalbycolumns.yaml @@ -1,3 +1,6 @@ +settings: + 1: + ow_layout: wild ow-edges: 1: two-way: diff --git a/presets/world/owr_shuffle-largescreenpool.yaml b/presets/world/owr_shuffle-largescreenpool.yaml new file mode 100644 index 00000000..600493b8 --- /dev/null +++ b/presets/world/owr_shuffle-largescreenpool.yaml @@ -0,0 +1,149 @@ +settings: + 1: + ow_layout: grid +ow-grid: + 1: + restricted_positions: + - cells: + - 0x00 + - 0x03 + - 0x05 + - 0x18 + - 0x1B + - 0x1E + - 0x30 + - 0x35 + positions: + - 0x00 + - 0x03 + - 0x05 + - 0x18 + - 0x1B + - 0x1E + - 0x30 + - 0x35 + world: both + - cells: + - 0x01 + - 0x04 + - 0x06 + - 0x19 + - 0x1C + - 0x1F + - 0x31 + - 0x36 + positions: + - 0x01 + - 0x04 + - 0x06 + - 0x19 + - 0x1C + - 0x1F + - 0x31 + - 0x36 + world: both + - cells: + - 0x08 + - 0x0B + - 0x0D + - 0x20 + - 0x23 + - 0x26 + - 0x38 + - 0x3D + positions: + - 0x08 + - 0x0B + - 0x0D + - 0x20 + - 0x23 + - 0x26 + - 0x38 + - 0x3D + world: both + - cells: + - 0x09 + - 0x0C + - 0x0E + - 0x21 + - 0x24 + - 0x27 + - 0x39 + - 0x3E + positions: + - 0x09 + - 0x0C + - 0x0E + - 0x21 + - 0x24 + - 0x27 + - 0x39 + - 0x3E + world: both + - cells: + - 0x02 + - 0x07 + - 0x0A + - 0x0F + - 0x10 + - 0x11 + - 0x12 + - 0x13 + - 0x14 + - 0x15 + - 0x16 + - 0x17 + - 0x1A + - 0x1D + - 0x22 + - 0x25 + - 0x28 + - 0x29 + - 0x2A + - 0x2B + - 0x2C + - 0x2D + - 0x2E + - 0x2F + - 0x32 + - 0x33 + - 0x34 + - 0x37 + - 0x3A + - 0x3B + - 0x3C + - 0x3F + positions: + - 0x02 + - 0x07 + - 0x0A + - 0x0F + - 0x10 + - 0x11 + - 0x12 + - 0x13 + - 0x14 + - 0x15 + - 0x16 + - 0x17 + - 0x1A + - 0x1D + - 0x22 + - 0x25 + - 0x28 + - 0x29 + - 0x2A + - 0x2B + - 0x2C + - 0x2D + - 0x2E + - 0x2F + - 0x32 + - 0x33 + - 0x34 + - 0x37 + - 0x3A + - 0x3B + - 0x3C + - 0x3F + world: both \ No newline at end of file diff --git a/presets/world/owr_shuffle-largescreens.yaml b/presets/world/owr_shuffle-largescreens.yaml index 47798cfa..9bc37ecf 100644 --- a/presets/world/owr_shuffle-largescreens.yaml +++ b/presets/world/owr_shuffle-largescreens.yaml @@ -1,3 +1,6 @@ +settings: + 1: + ow_layout: wild settings: 1: ow_whirlpool: false diff --git a/presets/world/owr_shuffle-light.yaml b/presets/world/owr_shuffle-light.yaml index 4feaa75e..9b532c9a 100644 --- a/presets/world/owr_shuffle-light.yaml +++ b/presets/world/owr_shuffle-light.yaml @@ -1,3 +1,6 @@ +settings: + 1: + ow_parallel: false ow-edges: 1: two-way: @@ -69,6 +72,25 @@ ow-edges: Swamp Nook EC*: Swamp WC* Swamp Nook ES*: Swamp WS* Swamp EC*: Dark South Pass WC* +ow-grid: + 1: + fixed_arrangements: + - arrangement: + - 0x00 0x01 0x02 0x03 0x04 0x05 0x06 0x07 + - 0x08 0x09 0x0A 0x0B 0x0C 0x0D 0x0E 0x0F + - 0x10 0x11 0x12 0x13 0x14 0x15 0x16 0x17 + - 0x18 0x19 0x1A 0x1B 0x1C 0x1D 0x1E 0x1F + - 0x20 0x21 0x22 0x23 0x24 0x25 0x26 0x27 + - 0x28 0x29 0x2A 0x2B 0x2C 0x2D 0x2E 0x2F + - 0x30 0x31 0x32 0x33 0x34 0x35 0x36 0x37 + - 0x38 0x39 0x3A 0x3B 0x3C 0x3D 0x3E 0x3F + world: dark + restricted_positions: + - cells: + - 0x00 + positions: + - 0x00 + world: dark ow-whirlpools: 1: two-way: diff --git a/presets/world/owr_shuffle-separatemountain.yaml b/presets/world/owr_shuffle-separatemountain.yaml index 02a53d9c..0f07f4e6 100644 --- a/presets/world/owr_shuffle-separatemountain.yaml +++ b/presets/world/owr_shuffle-separatemountain.yaml @@ -1,3 +1,6 @@ +settings: + 1: + ow_layout: wild ow-edges: 1: groups: diff --git a/presets/world/owr_shuffle-smallscreens.yaml b/presets/world/owr_shuffle-smallscreens.yaml index a12ad95d..ab0af00b 100644 --- a/presets/world/owr_shuffle-smallscreens.yaml +++ b/presets/world/owr_shuffle-smallscreens.yaml @@ -1,3 +1,6 @@ +settings: + 1: + ow_layout: wild ow-edges: 1: two-way: diff --git a/presets/world/owr_shuffle-splitsimilar.yaml b/presets/world/owr_shuffle-splitsimilar.yaml index bf1dde3d..825aa744 100644 --- a/presets/world/owr_shuffle-splitsimilar.yaml +++ b/presets/world/owr_shuffle-splitsimilar.yaml @@ -1,5 +1,6 @@ settings: 1: + ow_layout: wild ow_terrain: false ow-edges: 1: diff --git a/presets/world/owr_shuffle-splitsimilarterrain.yaml b/presets/world/owr_shuffle-splitsimilarterrain.yaml index 2ade18e4..0e97404a 100644 --- a/presets/world/owr_shuffle-splitsimilarterrain.yaml +++ b/presets/world/owr_shuffle-splitsimilarterrain.yaml @@ -1,5 +1,6 @@ settings: 1: + ow_layout: wild ow_terrain: true ow-edges: 1: diff --git a/presets/world/owr_shuffle-vanillaloop.yaml b/presets/world/owr_shuffle-vanillaloop.yaml index bc4223fb..7a31c031 100644 --- a/presets/world/owr_shuffle-vanillaloop.yaml +++ b/presets/world/owr_shuffle-vanillaloop.yaml @@ -1,3 +1,6 @@ +settings: + 1: + ow_layout: wild ow-edges: 1: two-way: diff --git a/presets/world/owr_shuffle-vanillamountain.yaml b/presets/world/owr_shuffle-vanillamountain.yaml new file mode 100644 index 00000000..33cf3f3c --- /dev/null +++ b/presets/world/owr_shuffle-vanillamountain.yaml @@ -0,0 +1,16 @@ +ow-edges: + 1: + two-way: + West Death Mountain EN*: East Death Mountain WN* + West Death Mountain ES*: East Death Mountain WS* + East Death Mountain EN*: Death Mountain TR Pegs WN* + West Dark Death Mountain EN*: East Dark Death Mountain WN* + West Dark Death Mountain ES*: East Dark Death Mountain WS* + East Dark Death Mountain EN*: Turtle Rock WN* +ow-grid: + 1: + fixed_arrangements: + - arrangement: + - 0x03 0x04 0x05 0x06 0x07 + - 0x0B 0x0C 0x0D 0x0E . + world: both \ No newline at end of file diff --git a/presets/world/owr_shuffle-vertical.yaml b/presets/world/owr_shuffle-vertical.yaml index d037f0c7..6994698e 100644 --- a/presets/world/owr_shuffle-vertical.yaml +++ b/presets/world/owr_shuffle-vertical.yaml @@ -1,3 +1,6 @@ +settings: + 1: + ow_layout: wild ow-edges: 1: two-way: diff --git a/presets/world/owr_shuffle-verticalbyrows.yaml b/presets/world/owr_shuffle-verticalbyrows.yaml index 25650d60..44948112 100644 --- a/presets/world/owr_shuffle-verticalbyrows.yaml +++ b/presets/world/owr_shuffle-verticalbyrows.yaml @@ -1,3 +1,6 @@ +settings: + 1: + ow_layout: wild ow-edges: 1: two-way: diff --git a/presets/world/owr_shuffle-wrappedgrid.yaml b/presets/world/owr_shuffle-wrappedgrid.yaml new file mode 100644 index 00000000..537498e3 --- /dev/null +++ b/presets/world/owr_shuffle-wrappedgrid.yaml @@ -0,0 +1,7 @@ +settings: + 1: + ow_layout: grid +ow-grid: + 1: + wrap_horizontal: true + wrap_vertical: true \ No newline at end of file diff --git a/presets/world/owr_vanilla.yaml b/presets/world/owr_vanilla.yaml index 9c86cc79..992aaa0f 100644 --- a/presets/world/owr_vanilla.yaml +++ b/presets/world/owr_vanilla.yaml @@ -144,6 +144,25 @@ ow-edges: Swamp EC*: Dark South Pass WC* South Pass ES*: Lake Hylia WS* Dark South Pass ES*: Ice Lake WS* +ow-grid: + 1: + fixed_arrangements: + - arrangement: + - 0x00 0x01 0x02 0x03 0x04 0x05 0x06 0x07 + - 0x08 0x09 0x0A 0x0B 0x0C 0x0D 0x0E 0x0F + - 0x10 0x11 0x12 0x13 0x14 0x15 0x16 0x17 + - 0x18 0x19 0x1A 0x1B 0x1C 0x1D 0x1E 0x1F + - 0x20 0x21 0x22 0x23 0x24 0x25 0x26 0x27 + - 0x28 0x29 0x2A 0x2B 0x2C 0x2D 0x2E 0x2F + - 0x30 0x31 0x32 0x33 0x34 0x35 0x36 0x37 + - 0x38 0x39 0x3A 0x3B 0x3C 0x3D 0x3E 0x3F + world: both + restricted_positions: + - cells: + - 0x00 + positions: + - 0x00 + world: both ow-whirlpools: 1: two-way: diff --git a/resources/app/gui/lang/en.json b/resources/app/gui/lang/en.json index c43a383e..e2859dc3 100644 --- a/resources/app/gui/lang/en.json +++ b/resources/app/gui/lang/en.json @@ -111,11 +111,11 @@ "randomizer.dungeon.experimental": "Enable Experimental Features", - "randomizer.dungeon.dungeon_counters": "Dungeon Chest Counters", + "randomizer.dungeon.dungeon_counters": "Dungeon Counters", "randomizer.dungeon.dungeon_counters.default": "Auto", "randomizer.dungeon.dungeon_counters.off": "Off", "randomizer.dungeon.dungeon_counters.on": "On", - "randomizer.dungeon.dungeon_counters.pickup": "On Compass Pickup", + "randomizer.dungeon.dungeon_counters.pickup": "On Item Pickup", "randomizer.dungeon.mixed_travel": "Mixed Dungeon Travel ", "randomizer.dungeon.mixed_travel.prevent": "Prevent Mixed Dungeon Travel", diff --git a/roadmap.md b/roadmap.md new file mode 100644 index 00000000..9aaef290 --- /dev/null +++ b/roadmap.md @@ -0,0 +1,234 @@ +--- +layout: default +title: Roadmap +nav_order: 5 +--- + +# Development Roadmap +{: .no_toc } + +Future plans and upcoming features for ALttP Door Randomizer. +{: .fs-6 .fw-300 } + +## Table of contents +{: .no_toc .text-delta } + +1. TOC +{:toc} + +--- + +## Project Vision + +Door Randomizer aims to provide the most comprehensive and flexible dungeon randomization experience for A Link to the Past while maintaining playability and logical consistency. Our focus is on: + +1. **Robust Generation** - Ensuring seeds are always completable and logical +2. **Feature Richness** - Providing extensive customization options +3. **Community Engagement** - Responding to player feedback and needs +4. **Performance** - Improving generation speed and reliability + +--- + +## Bug Fixes + +Critical and important bugs that need to be addressed: + +### Critical Bugs +- Dungeon Key HUD indicator issue (total is incorrect) +- Links House on DM pathing issues (See OWR solution) + +### Minor Bugs +- Resolve Swamp Trench 2 draining issue (pot obtained but still drains) +- Fix OHKO logic issues - Crystal Path backwards in GT +- Fix MapCompass forbidden boss items mode (currently bugged) +- Killing Certain Red Guards Kills Music + +--- + +## Logic & Generation Improvements + +Improving dungeon generation algorithms and logic: + +- Enhanced key logic algorithms (experimental mode in New Generation) +- Rework Uncle weapon/Escape small key +- Make Sanctuary heart the logical one (simplify sanctuary heart logic) +- Investigate rupee balancing issues causing failed generations + +--- + +## New Features + +New functionality and game modes, mostly planned for the NewGeneration branch: + +- Portal placement flexibility (customizability and mixed dungeon pools) +- Smarter trap door placement (reduce forced mirroring) +- DR Keysanity menu improvements +- PitWarp feature +- Door Type pooling customizations +- OWR ER standardization (District ER, Links on Death Mountain issue) +- NewSwappedAlgorithm integration +- Bonk Item Pool from Overworld Randomizer (downstream integration) +- A better hint system +- Prize Shuffle from Overworld Randomizer (downstream integration) +- Map Screen from GK Randomizer (need to investigate) +- Other downstream integrations? (custom goals, follower shuffle, flute shuffle?) + +--- + +## Quality of Life Enhancements + +Improving user experience and usability: + +- Preferred location groups (control item placement with warnings/failures/retries) +- Preset support +- Control output ROM name (customize generated ROM filename) +- Progress indicators for generations +- Better entrance tracking for trackers (investigate race legality) +- Super-tile split palettes (reduce hinting from palette colors) +- Turn off Bob by default for enemizer (fewer graphical glitches) + +--- + +## Performance Improvements + +Making generation faster and more efficient: + +- Reduce memory footprint + +--- + +## Customization & Content Creation + +Tools and features for creating custom content: + +- Re-design customizer file format (improved YAML structure) +- Presets for customizer (start from predefined base) +- Easier enemy customization (simpler interface for customizing specific enemies - better integration with customization system) + +--- + +## Multiworld + +Enhancements for multiplayer seeds: + +- Multiworld documentation +- Ability to have similar randomizations across multiworlds (makes parts of it co-op) + +--- + +## External Tools & Integration + +Integration with external tools and platforms: + +- Tracker integration features +- Web-based API + +--- + +## Technical Debt & Refactoring + +Behind-the-scenes code improvements: + +- Modernize Rules.py (improve readability and maintainability) +- Python upgrade (3.10 deprecated in 2026) + +--- + +## Research & Exploration + +Experimental ideas that may or may not be implemented: + +### Dungeon Randomization Ideas + +- **Subroom randomization** - Randomize smaller rooms within a larger room (subtile vs. supertile doors) +- **Euclidean dungeon layouts** - Dungeon randomization that makes spatial sense (rooms connected geographically) +- **Swapped dungeon generation** - Create dungeons by swapping door destinations (requires new algorithms) + +--- + +## Branch Strategy + +### Current Branches + +- **NewGeneration** - Active development branch for new generation system +- **NewSwappedAlgorithm** - Experimental branch for swapped item algorithm +- **DoorDevUnstable** - Main branch, maintenance mode - only bug fixes and patches (ready to be moved to official stable) +- **DoorDev** - Stale development branch (needs update) +- **Dev/Master** - Do NOT use for PRs. Used by upstream only. + +### Planned Branch Changes + +- Transition from DoorDevUnstable to DoorDev as main maintenance branch +- Transition NewGeneration to main development branch + +--- + +## Completed Features + +Recent accomplishments: + +- βœ… Dynamic colored pots +- βœ… Free lamp cone +- βœ… Experimental key logic improvements + +--- + +## How to Contribute + +Want to help shape the future of Door Randomizer? + +### For Players +- **Test seeds** - Play with different settings and report issues +- **Provide feedback** - Share what you like and what could be better +- **Suggest features** - Tell us what you want to see + +### For Developers +- **Submit PRs to DoorDevUnstable** +- **Join Discord** - Discuss development in `#door-rando` +- **Write tests** - Improve test coverage +- **Improve documentation** - Help others understand the code + +### For Creators +- **Custom rooms** - Design interesting custom rooms +- **Presets** - Create balanced preset configurations +- **Tutorials** - Teach others how to use Door Rando +- **Tools** - Build complementary tools (trackers, analyzers) + +--- + +## Release Schedule + +### Regular Releases +- **Unstable builds** - Automated on every push to DoorDevUnstable +- **Hotfixes** - As needed for critical bugs + +### Upcoming Releases (Tentative) +- **v1.5.x** (Q2 2026) - DoorDevUnstable becomes DoorDev +- **v1.6** (Q3 2026) - Python upgrade +- **v2.0** (Q4 2026) - New Generation branch release + +--- + +## Success Metrics + +How we measure progress: + +### Technical Metrics +- Generation success rate (target: >95%) +- Average generation time (target: <10s for crossed seeds) +- Memory usage (start measuring) +- Test coverage (start measuring) + +--- + +## Feedback & Discussion + +Have thoughts on the roadmap? + +- **Discord**: Join `#door-rando` to discuss + +--- + +*This roadmap is a living document and will be updated regularly as priorities shift and progress is made.* + +Last updated: 2026-01-30 diff --git a/source/classes/BabelFish.py b/source/classes/BabelFish.py index 40b6463f..58d26670 100644 --- a/source/classes/BabelFish.py +++ b/source/classes/BabelFish.py @@ -5,6 +5,8 @@ import os class BabelFish(): def __init__(self,subpath=["resources","app","meta"],lang=None): localization_string = locale.getdefaultlocale()[0] #get set localization + if localization_string is None: + localization_string = "en" self.locale = localization_string[:2] if lang is None else lang #let caller override localization self.langs = ["en"] #start with English if(not self.locale == "en"): #add localization diff --git a/source/classes/CustomSettings.py b/source/classes/CustomSettings.py index 0e66b2de..d20e1f4c 100644 --- a/source/classes/CustomSettings.py +++ b/source/classes/CustomSettings.py @@ -245,6 +245,11 @@ class CustomSettings(object): return self.file_source['item_pool'] return None + def get_item_pool_adjust(self): + if 'item_pool_adjust' in self.file_source: + return self.file_source['item_pool_adjust'] + return None + def get_placements(self): if 'placements' in self.file_source: return self.file_source['placements'] @@ -504,6 +509,7 @@ class CustomSettings(object): self.world_rep['ow-whirlpools'] = whirlpools = {} self.world_rep['ow-tileflips'] = flips = {} self.world_rep['ow-flutespots'] = flute = {} + self.world_rep['ow-grid'] = owgrid = {} for p in self.player_range: connections = edges[p] = {} connections['two-way'] = {} @@ -524,6 +530,57 @@ class CustomSettings(object): else: flute[p]['force'] = list(HexInt(id) for id in sorted(default_flute_connections)) flute[p]['forbid'] = [] + # layout grid + owgrid[p] = {} + grid = world.owgrid[p] + if grid is None: + grid = [ + [[HexInt(row * 8 + col) for col in range(8)] for row in range(8)], + [[HexInt(row * 8 + col) for col in range(8)] for row in range(8)] + ] + else: + grid = [ + [[HexInt(cell & 0xBF) for cell in row] for row in grid[0]], + [[HexInt(cell & 0xBF) for cell in row] for row in grid[1]] + ] + # Create fixed_arrangements for both worlds + owgrid[p]['fixed_arrangements'] = [ + { + 'arrangement': [' '.join(f'0x{cell:02X}' for cell in row) for row in grid[0]], + 'world': 'light' + }, + { + 'arrangement': [' '.join(f'0x{cell:02X}' for cell in row) for row in grid[1]], + 'world': 'dark' + } + ] + # Pin top left corners to position 0x00 + owgrid[p]['restricted_positions'] = [ + { + 'cells': [HexInt(grid[0][0][0])], + 'positions': [HexInt(0x00)], + 'world': 'light' + }, + { + 'cells': [HexInt(grid[1][0][0])], + 'positions': [HexInt(0x00)], + 'world': 'dark' + } + ] + # Set advanced grid options + horizontal_wrap = False + vertical_wrap = False + split_large_screens = False + if world.customizer: + grid_options = world.customizer.get_owgrid() + if grid_options and p in grid_options: + grid_options = grid_options[p] + horizontal_wrap = 'wrap_horizontal' in grid_options and grid_options['wrap_horizontal'] == True + vertical_wrap = 'wrap_vertical' in grid_options and grid_options['wrap_vertical'] == True + split_large_screens = 'split_large_screens' in grid_options and grid_options['split_large_screens'] == True + owgrid[p]['wrap_horizontal'] = horizontal_wrap + owgrid[p]['wrap_vertical'] = vertical_wrap + owgrid[p]['split_large_screens'] = split_large_screens for key, data in world.spoiler.overworlds.items(): player = data['player'] if 'player' in data else 1 connections = edges[player] @@ -531,7 +588,7 @@ class CustomSettings(object): connections[sub][data['entrance']] = data['exit'] for key, data in world.spoiler.whirlpools.items(): player = data['player'] if 'player' in data else 1 - whirlconnects = whirlconnects[player] + whirlconnects = whirlpools[player] sub = 'two-way' if data['direction'] == 'both' else 'one-way' whirlconnects[sub][data['entrance']] = data['exit'] diff --git a/source/dungeon/EnemyList.py b/source/dungeon/EnemyList.py index 90ee3fba..05a60de4 100644 --- a/source/dungeon/EnemyList.py +++ b/source/dungeon/EnemyList.py @@ -450,7 +450,7 @@ def init_enemy_stats(): EnemySprite.Stalfos: EnemyStats(EnemySprite.Stalfos, False, True, 6, health=4, dmg=1), EnemySprite.GreenZirro: EnemyStats(EnemySprite.GreenZirro, False, False, 1, health=4, dmg=5, dmask=0x80), EnemySprite.BlueZirro: EnemyStats(EnemySprite.BlueZirro, False, False, 7, health=8, dmg=3, dmask=0x80), - EnemySprite.Pikit: EnemyStats(EnemySprite.Pikit, False, True, 2, health=12, dmg=5), + EnemySprite.Pikit: EnemyStats(EnemySprite.Pikit, False, False, 2, health=12, dmg=5), EnemySprite.OldMan: EnemyStats(EnemySprite.OldMan, True, dmg=0), EnemySprite.PipeDown: EnemyStats(EnemySprite.PipeDown, True, dmg=0), diff --git a/source/enemizer/SpriteSheets.py b/source/enemizer/SpriteSheets.py index 15b81f51..60c09f81 100644 --- a/source/enemizer/SpriteSheets.py +++ b/source/enemizer/SpriteSheets.py @@ -329,7 +329,7 @@ def init_sprite_requirements(): SpriteRequirement(EnemySprite.Stalfos).sub_group(0, 0x1f), SpriteRequirement(EnemySprite.GreenZirro).no_drop().sub_group(3, 0x1b).exclude(NoFlyingRooms), SpriteRequirement(EnemySprite.BlueZirro).no_drop().sub_group(3, 0x1b).exclude(NoFlyingRooms), - SpriteRequirement(EnemySprite.Pikit).sub_group(3, 0x1b), + SpriteRequirement(EnemySprite.Pikit).no_drop().sub_group(3, 0x1b), SpriteRequirement(EnemySprite.CrystalMaiden).affix(), SpriteRequirement(EnemySprite.OldMan).affix().sub_group(2, 0x1c), SpriteRequirement(EnemySprite.PipeDown).affix(), diff --git a/source/item/FillUtil.py b/source/item/FillUtil.py index 25bebbcd..6f1016fa 100644 --- a/source/item/FillUtil.py +++ b/source/item/FillUtil.py @@ -120,9 +120,6 @@ def create_item_pool_config(world): LocationGroup('bkgt').locs(mode_grouping['GT Trash'])] for loc_name in mode_grouping['Big Chests'] + mode_grouping['Heart Containers']: config.reserved_locations[player].add(loc_name) - if world.prizeshuffle[player] != 'none': - for loc_name in mode_grouping['Prizes']: - config.reserved_locations[player].add(loc_name) elif world.algorithm == 'major_only': config.location_groups = [ LocationGroup('MajorItems'), diff --git a/source/overworld/LayoutGenerator.py b/source/overworld/LayoutGenerator.py index 467941ab..26666a47 100644 --- a/source/overworld/LayoutGenerator.py +++ b/source/overworld/LayoutGenerator.py @@ -1,13 +1,12 @@ -import copy import logging +from DungeonGenerator import GenerationException import RaceRandom as random import random as _random from typing import List, Dict, Optional, Set, Tuple from BaseClasses import OWEdge, World, Direction, Terrain -from OverworldShuffle import connect_two_way, validate_layout +from OverworldShuffle import connect_two_way, get_separate_ow_areas, validate_layout ENABLE_KEEP_SIMILAR_SPECIAL_HANDLING = False -PREVENT_WRAPPED_LARGE_SCREENS = False DRAW_IMAGE = False large_screen_ids = [0x00, 0x03, 0x05, 0x18, 0x1B, 0x1E, 0x30, 0x35] + [0x40, 0x43, 0x45, 0x58, 0x5B, 0x5E, 0x70, 0x75] @@ -49,7 +48,7 @@ class WorldPiece: def __init__( self, - screens: List[List[Optional[Screen]]], + screens: Optional[List[List[Optional[Screen]]]] = None, grid: Optional[List[List[int]]] = None, width: int = 0, height: int = 0, @@ -62,7 +61,7 @@ class WorldPiece: west_edges_water: Optional[List[List[List[OWEdge]]]] = None, east_edges_water: Optional[List[List[List[OWEdge]]]] = None ): - self.screens = screens + self.screens = screens if screens is not None else [] self.grid = grid if grid is not None else [] self.width = width self.height = height @@ -79,8 +78,7 @@ class Piece: """ Represents a piece consisting of a main and optionally a parallel world piece. """ - __slots__ = ('main', 'parallel', 'world', 'width', 'height', - 'invalid_wrap_row', 'invalid_wrap_column', 'restriction', + __slots__ = ('main', 'parallel', 'world', 'width', 'height', 'restriction', 'crossed_groups', 'delay', 'order', 'edge_sides', 'max_edges_per_side') def __init__( @@ -90,8 +88,6 @@ class Piece: world: int = 0, width: int = 0, height: int = 0, - invalid_wrap_row: Optional[List[int]] = None, - invalid_wrap_column: Optional[List[int]] = None, restriction: Optional[List[int]] = None, crossed_groups: Optional[List[List[int]]] = None, delay: int = 0, @@ -104,8 +100,6 @@ class Piece: self.world = world # 0 or 1 self.width = width self.height = height - self.invalid_wrap_row = invalid_wrap_row if invalid_wrap_row is not None else [] - self.invalid_wrap_column = invalid_wrap_column if invalid_wrap_column is not None else [] self.restriction = restriction self.crossed_groups = crossed_groups if crossed_groups is not None else [] self.delay = delay @@ -154,21 +148,21 @@ class LayoutGeneratorOptions: """ Configuration options for layout generation. """ - __slots__ = ('horizontal_wrap', 'vertical_wrap', - 'large_screen_pool', 'distortion_chance', 'random_order', + __slots__ = ('horizontal_wrap', 'vertical_wrap', 'split_large_screens', 'distortion_chance', 'random_order', 'multi_choice', 'max_delay', 'first_ignore_bonus_points', 'penalty_full_edge_mismatch', 'penalty_partial_edge_mismatch', 'bonus_partial_edge_match', 'bonus_full_edge_match', 'bonus_crossed_group_match', 'bonus_fill_parallel', 'forced_non_crossed_edges', 'forced_crossed_edges', 'check_reachability', 'crossed_chance', 'crossed_limit', 'sort_by_edge_sides', 'sort_by_max_edges_per_side', 'sort_by_piece_size', - 'min_runs', 'max_runs', 'target_runs_times_successes') + 'min_runs', 'max_runs', 'target_runs_times_successes', 'score_mult_separate_areas', + 'start_loc_min_distance', 'score_mult_start_loc_distance') def __init__( self, horizontal_wrap: bool = True, vertical_wrap: bool = True, - large_screen_pool: bool = False, + split_large_screens = False, distortion_chance: float = 0.0, random_order: int = 0, multi_choice: int = 1, @@ -190,11 +184,14 @@ class LayoutGeneratorOptions: sort_by_piece_size: bool = False, min_runs: int = 100, max_runs: int = 10000, - target_runs_times_successes: int = 5000 + target_runs_times_successes: int = 5000, + score_mult_separate_areas: float = 4, + start_loc_min_distance: int = 4, + score_mult_start_loc_distance: float = 3 ): self.horizontal_wrap = horizontal_wrap self.vertical_wrap = vertical_wrap - self.large_screen_pool = large_screen_pool + self.split_large_screens = split_large_screens self.distortion_chance = distortion_chance self.random_order = random_order self.multi_choice = multi_choice @@ -217,6 +214,9 @@ class LayoutGeneratorOptions: self.min_runs = min_runs self.max_runs = max_runs self.target_runs_times_successes = target_runs_times_successes + self.score_mult_separate_areas = score_mult_separate_areas + self.start_loc_min_distance = start_loc_min_distance + self.score_mult_start_loc_distance = score_mult_start_loc_distance class LayoutGeneratorResult: """ @@ -277,6 +277,25 @@ def create_empty_grid_info(edge_connection_seed: float) -> GridInfo: edge_connection_seed=edge_connection_seed ) +def copy_grid_info(source: GridInfo, edge_connection_seed: float) -> GridInfo: + """ + Create a deep copy of a GridInfo object with a new edge_connection_seed. + Only copies the grid data structures, not the OWEdge references (which are shared). + """ + return GridInfo( + grid=[[row[:] for row in world_grid] for world_grid in source.grid], + north_edges_grid=[[[cell[:] for cell in row] for row in world_grid] for world_grid in source.north_edges_grid], + south_edges_grid=[[[cell[:] for cell in row] for row in world_grid] for world_grid in source.south_edges_grid], + west_edges_grid=[[[cell[:] for cell in row] for row in world_grid] for world_grid in source.west_edges_grid], + east_edges_grid=[[[cell[:] for cell in row] for row in world_grid] for world_grid in source.east_edges_grid], + north_edges_water_grid=[[[cell[:] for cell in row] for row in world_grid] for world_grid in source.north_edges_water_grid], + south_edges_water_grid=[[[cell[:] for cell in row] for row in world_grid] for world_grid in source.south_edges_water_grid], + west_edges_water_grid=[[[cell[:] for cell in row] for row in world_grid] for world_grid in source.west_edges_water_grid], + east_edges_water_grid=[[[cell[:] for cell in row] for row in world_grid] for world_grid in source.east_edges_water_grid], + crossed_groups=[row[:] for row in source.crossed_groups], + edge_connection_seed=edge_connection_seed + ) + def initialize_screens(world: World, player: int) -> Dict[int, Screen]: overworld_screens: Dict[int, Screen] = {} screen_edges_map = group_owedges_by_screens(world, player) @@ -399,66 +418,50 @@ def define_large_screen_quadrants( def create_piece_list(world: World, player: int, options: LayoutGeneratorOptions, crossed_group_b: List[int], overworld_screens: Dict[int, Screen], large_screen_quadrant_info: Dict[int, Dict], large_screen_quadrant_info_land: Dict[int, Dict], large_screen_quadrant_info_water: Dict[int, Dict]) -> List[Piece]: piece_list: List[Piece] = [] - used_screens_set = set() - - all_large_screens = [s for s in overworld_screens.values() if s.big] - all_small_screens = [s for s in overworld_screens.values() if not s.big] + # Determine which screens to process + all_screens = list(overworld_screens.values()) if world.owParallel[player]: # In Parallel, only use light world screens # Each piece will automatically handle both worlds through parallel mechanism - all_large_screens = [s for s in all_large_screens if not s.dark_world] - all_small_screens = [s for s in all_small_screens if not s.dark_world] + all_screens = [s for s in all_screens if not s.dark_world] - # In Standard mode, screens 0x1B, 0x2B, 0x2C are glued together as a single piece - if world.mode[player] == 'standard': - castle_screen = overworld_screens.get(0x1B) - central_bonk_screen = overworld_screens.get(0x2B) - links_house_screen = overworld_screens.get(0x2C) - - if castle_screen and central_bonk_screen and links_house_screen: - piece = create_piece(world, player, [ - [0x1B, 0x1B], - [0x1B, 0x1B], - [0x2B, 0x2C] - ], overworld_screens) - - if options.large_screen_pool: - piece.restriction = [0x00, 0x03, 0x05, 0x18, 0x1B, 0x1E, 0x30, 0x35] - - piece_list.append(piece) - used_screens_set.add(castle_screen) - used_screens_set.add(central_bonk_screen) - used_screens_set.add(links_house_screen) - - if world.owParallel[player]: - used_screens_set.add(castle_screen.parallel) - used_screens_set.add(central_bonk_screen.parallel) - used_screens_set.add(links_house_screen.parallel) - - # Add large screens - for screen in all_large_screens: - if screen not in used_screens_set: - piece = create_piece(world, player, [[screen.id, screen.id], [screen.id, screen.id]], overworld_screens) - if options.large_screen_pool: - piece.restriction = [0x00, 0x03, 0x05, 0x18, 0x1B, 0x1E, 0x30, 0x35] - piece_list.append(piece) - used_screens_set.add(screen) - if world.owParallel[player]: - used_screens_set.add(screen.parallel) - - # Add small screens - for screen in all_small_screens: - if screen not in used_screens_set: + # Phase 1: Create individual 1x1 pieces for all cells + for screen in all_screens: + if screen.big: + # Create 4 pieces for large screen quadrants + for offset in [0x00, 0x01, 0x08, 0x09]: + piece = create_piece(world, player, [[screen.id + offset]], overworld_screens) + piece_list.append(piece) + else: piece = create_piece(world, player, [[screen.id]], overworld_screens) - if options.large_screen_pool: - piece.restriction = [s.id for s in overworld_screens.values() if not s.big] piece_list.append(piece) - used_screens_set.add(screen) - if world.owParallel[player]: - used_screens_set.add(screen.parallel) - # Add piece data + # Apply position restrictions from Customizer + piece_list = apply_position_restrictions(world, player, piece_list, overworld_screens) + + # Phase 2: Apply options via merging + + # Merge large screens if not split + if not options.split_large_screens: + for large_id in large_screen_ids: + if large_id in [s.id for s in all_screens if s.big]: + piece_list = merge_pieces(piece_list, [[large_id, large_id + 0x01], [large_id + 0x08, large_id + 0x09]], world, player, overworld_screens) + + # Standard mode: merge castle area + if world.mode[player] == 'standard': + piece_list = merge_pieces(piece_list, [[0x23, 0x24], [0x2B, 0x2C]], world, player, overworld_screens) + + # Apply fixed arrangement restrictions from Customizer + piece_list = apply_arrangement_restrictions(world, player, piece_list, overworld_screens) + + # Trim pieces by removing empty rows/columns on edges + piece_list = [trim_piece(piece) for piece in piece_list] + + # Validate piece sizes and apply wrapping if needed + piece_list = validate_and_wrap_pieces(piece_list, options, world, player, overworld_screens) + + # Phase 3: Add piece data for piece in piece_list: add_piece_data(world, player, piece, large_screen_quadrant_info, large_screen_quadrant_info_land, large_screen_quadrant_info_water) # Handle crossed groups @@ -478,71 +481,635 @@ def create_piece_list(world: World, player: int, options: LayoutGeneratorOptions for k in range(piece.height): for l in range(piece.width): piece.crossed_groups[k].append(-1) - screen_id = piece.main.grid[k][l] - if screen_id != -1: - piece.crossed_groups[k][l] = 1 if screen_id in crossed_group_b else 0 + screen = piece.main.screens[k][l] + if screen: + piece.crossed_groups[k][l] = 1 if screen.id in crossed_group_b else 0 else: if piece.parallel and piece.parallel.screens[k][l]: - piece.crossed_groups[k][l] = 1 if piece.parallel.grid[k][l] in crossed_group_b else 0 + piece.crossed_groups[k][l] = 1 if piece.parallel.screens[k][l].id in crossed_group_b else 0 return piece_list def create_piece(world: World, player: int, grid: List[List[int]], overworld_screens: Dict[int, Screen]) -> Piece: """ - Create piece from grid of screen IDs - Takes 2D array of screen IDs and creates main and parallel pieces + Create piece from grid of cell IDs + Takes 2D array of cell IDs and creates main and parallel pieces """ piece = Piece( - main=WorldPiece(screens=[]), + main=WorldPiece(width=len(grid[0]), height=len(grid)), width=len(grid[0]), height=len(grid) ) if world.owParallel[player]: - piece.parallel = WorldPiece(screens=[]) + piece.parallel = WorldPiece(width=len(grid[0]), height=len(grid)) found_screens = set() for i in range(piece.height): new_row = [] + new_screen_row = [] new_row_parallel = [] - piece.main.screens.append(new_row) + new_screen_row_parallel = [] + piece.main.grid.append(new_row) + piece.main.screens.append(new_screen_row) if world.owParallel[player]: - piece.parallel.screens.append(new_row_parallel) + piece.parallel.grid.append(new_row_parallel) + piece.parallel.screens.append(new_screen_row_parallel) for j in range(piece.width): - screen = overworld_screens.get(grid[i][j]) - new_row.append(screen) - if world.owParallel[player]: - new_row_parallel.append(screen.parallel if screen else None) - - if screen and screen not in found_screens: + cell_id = grid[i][j] + new_row.append(cell_id) + screen = None if cell_id == -1 else overworld_screens.get(get_screen_id_from_cell(cell_id)) + if screen: found_screens.add(screen) - piece.world = 1 if screen.dark_world else 0 - if screen.big and PREVENT_WRAPPED_LARGE_SCREENS: - # For large screens, prevent wrapping at the second row/column - # This ensures the 2x2 piece doesn't split across the grid boundary - if (i + 1) not in piece.invalid_wrap_row: - piece.invalid_wrap_row.append(i + 1) - if (j + 1) not in piece.invalid_wrap_column: - piece.invalid_wrap_column.append(j + 1) + new_screen_row.append(screen) + if world.owParallel[player]: + if screen: + new_row_parallel.append(cell_id - screen.id + screen.parallel.id) + new_screen_row_parallel.append(screen.parallel) + else: + new_row_parallel.append(-1) + new_screen_row_parallel.append(None) + + worlds = set(s.dark_world for s in found_screens if s is not None) + if len(worlds) != 1: + raise GenerationException("Piece contains screens from both Light World and Dark World") + piece.world = 1 if True in worlds else 0 return piece +def apply_position_restrictions(world: World, player: int, piece_list: List[Piece], overworld_screens: Dict[int, Screen]) -> List[Piece]: + """ + Apply position restrictions from Customizer to pieces at the end of phase 1. + + Position restrictions specify that certain cells can only be placed at certain positions. + The Customizer format is: + restricted_positions: + - cells: [0x13, 0x2C] + positions: [0x00, 0x07, 0x38, 0x3F] + world: both # or 'light' or 'dark' + + Note: At the end of phase 1, all pieces are 1x1 (one piece per cell). + + The world bit (0x40) in user input is ignored. The actual cell ID is determined by: + - The world where the restriction applies (light=0, dark=1) + - The mixed_state of the screen containing that cell (swapped screens flip the world bit) + """ + if not world.customizer: + return piece_list + + grid_options = world.customizer.get_owgrid() + if not grid_options or player not in grid_options: + return piece_list + + grid_options = grid_options[player] + restricted_positions = grid_options.get('restricted_positions', []) + if not restricted_positions: + return piece_list + + # Build a mapping from cell ID to piece for quick lookup + cell_to_piece = {piece.main.grid[0][0]: piece for piece in piece_list} + + for restriction_idx, restriction in enumerate(restricted_positions): + cells = restriction.get('cells', []) + positions = restriction.get('positions', []) + restriction_world = restriction.get('world', 'both') + + # Validate input + if not cells: + raise GenerationException(f"Invalid restriction in restricted_positions[{restriction_idx}]: No cells provided") + for cell_id in cells: + validate_cell_id(cell_id, f"restricted_positions[{restriction_idx}].cells") + if not positions: + raise GenerationException(f"Invalid restriction in restricted_positions[{restriction_idx}]: No positions provided") + for pos in positions: + validate_cell_id(pos, f"restricted_positions[{restriction_idx}].positions") + validate_world_value(restriction_world, f"restricted_positions[{restriction_idx}]") + + position_set = set(positions) + + for user_cell_id in cells: + # Ignore the world bit in user input + base_cell_id = user_cell_id & 0xBF + + # Determine which worlds this restriction applies to + worlds_to_check = [] + if restriction_world == 'light' or restriction_world == 'both': + worlds_to_check.append(0) # Light World + if restriction_world == 'dark' or restriction_world == 'both': + worlds_to_check.append(1) # Dark World + + for target_world in worlds_to_check: + # Determine the actual cell ID based on the target world and mixed state + screen_id = get_screen_id_from_cell(base_cell_id) + screen = overworld_screens.get(screen_id) + is_swapped = screen.mixed_state == "swapped" + + # Calculate the actual cell ID: + # - In Light World (target_world=0): use base_cell_id if normal, base_cell_id|0x40 if swapped + # - In Dark World (target_world=1): use base_cell_id|0x40 if normal, base_cell_id if swapped + if target_world == 0: + # Light World + actual_cell_id = (base_cell_id | 0x40) if is_swapped else base_cell_id + else: + # Dark World + actual_cell_id = base_cell_id if is_swapped else (base_cell_id | 0x40) + + piece = cell_to_piece.get(actual_cell_id) + + # Apply the position restriction + if piece.restriction is None: + piece.restriction = list(position_set) + else: + # Intersect with existing restrictions + piece.restriction = [p for p in piece.restriction if p in position_set] + + return piece_list + +def apply_arrangement_restrictions(world: World, player: int, piece_list: List[Piece], overworld_screens: Dict[int, Screen]) -> List[Piece]: + """ + Apply fixed arrangement restrictions from Customizer to pieces at the end of phase 2. + + Fixed arrangements specify the relative positioning between multiple screens. + The Customizer format is: + fixed_arrangements: + - arrangement: + - 0x03 0x04 0x05 0x06 0x07 + - 0x0B 0x0C 0x0D 0x0E . + world: both # or 'light' or 'dark' + + The '.' character is a placeholder that allows any screen to be placed there. + + The world bit (0x40) in user input is ignored. The actual cell ID is determined by: + - The world where the restriction applies (light=0, dark=1) + - The mixed_state of the screen containing that cell (swapped screens flip the world bit) + """ + if not world.customizer: + return piece_list + + grid_options = world.customizer.get_owgrid() + if not grid_options or player not in grid_options: + return piece_list + + grid_options = grid_options[player] + fixed_arrangements = grid_options.get('fixed_arrangements', []) + if not fixed_arrangements: + return piece_list + + for arrangement_idx, arrangement_config in enumerate(fixed_arrangements): + arrangement_rows = arrangement_config.get('arrangement', []) + arrangement_world = arrangement_config.get('world', 'both') + + # Validate world value + validate_world_value(arrangement_world, f"fixed_arrangements[{arrangement_idx}]") + + if not arrangement_rows: + raise GenerationException(f"Invalid arrangement in fixed_arrangements[{arrangement_idx}]: No arrangement provided") + + # Pre-validate the arrangement: check row lengths and entry validity + expected_row_length = None + for row_idx, row_str in enumerate(arrangement_rows): + parts = str(row_str).split() + if expected_row_length is None: + expected_row_length = len(parts) + elif len(parts) != expected_row_length: + raise GenerationException(f"Invalid arrangement in fixed_arrangements[{arrangement_idx}]: row {row_idx} has {len(parts)} entries but expected {expected_row_length} (all rows must have the same number of entries)") + + # Validate each entry + for part_idx, part in enumerate(parts): + part = part.strip() + if part == '.': + continue + # Try to parse as cell ID + try: + if part.startswith('0x') or part.startswith('0X'): + cell_id = int(part, 16) + else: + cell_id = int(part) + validate_cell_id(cell_id, f"fixed_arrangements[{arrangement_idx}].arrangement[{row_idx}][{part_idx}]") + except ValueError: + raise GenerationException(f"Invalid entry '{part}' in fixed_arrangements[{arrangement_idx}].arrangement[{row_idx}][{part_idx}]: must be a cell ID (0x00-0x7F) or '.'") + + # Determine which worlds this arrangement applies to + worlds_to_apply = [] + if arrangement_world == 'light' or arrangement_world == 'both': + worlds_to_apply.append(0) # Light World + if arrangement_world == 'dark' or arrangement_world == 'both': + worlds_to_apply.append(1) # Dark World + + for target_world in worlds_to_apply: + # Parse the arrangement into a 2D list of cell IDs, translating based on world and mixed state + # Each row is a string like "0x03 0x04 0x05 0x06 0x07" or contains '.' for wildcards + arrangement = [] + for row_str in arrangement_rows: + row = [] + # Split by whitespace + parts = str(row_str).split() + for part in parts: + part = part.strip() + if part == '.': + row.append(-1) # -1 represents wildcard + else: + # Parse as hex or decimal (already validated above) + if part.startswith('0x') or part.startswith('0X'): + user_cell_id = int(part, 16) + else: + user_cell_id = int(part) + + # Ignore the world bit in user input + base_cell_id = user_cell_id & 0xBF + + # Get the screen that contains this cell + screen_id = get_screen_id_from_cell(base_cell_id) + screen = overworld_screens.get(screen_id) + is_swapped = screen.mixed_state == "swapped" + + # Calculate the actual cell ID: + # - In Light World (target_world=0): use base_cell_id if normal, base_cell_id|0x40 if swapped + # - In Dark World (target_world=1): use base_cell_id|0x40 if normal, base_cell_id if swapped + if target_world == 0: + # Light World + actual_cell_id = (base_cell_id | 0x40) if is_swapped else base_cell_id + else: + # Dark World + actual_cell_id = base_cell_id if is_swapped else (base_cell_id | 0x40) + + row.append(actual_cell_id) + if row: + arrangement.append(row) + + # Merge the pieces according to the arrangement + piece_list = merge_pieces(piece_list, arrangement, world, player, overworld_screens) + + return piece_list + +def get_piece_cells(piece: Piece) -> Set[int]: + """Get all cell IDs contained in a piece.""" + cells = set() + for row in piece.main.grid: + for cell in row: + if cell != -1: + cells.add(cell) + return cells + +def validate_cell_id(cell_id: int, context: str) -> None: + if not isinstance(cell_id, int) or cell_id < 0x00 or cell_id > 0x7F: + raise GenerationException(f"Invalid cell ID 0x{cell_id:02X} in {context}: must be in range 0x00-0x7F") + +def validate_world_value(world_value: str, context: str) -> None: + allowed_values = {'light', 'dark', 'both'} + if world_value not in allowed_values: + raise GenerationException(f"Invalid world value '{world_value}' in {context}: must be one of {allowed_values}") + +def trim_piece(piece: Piece) -> Piece: + """ + Trim a piece by removing any full rows or columns on the edges that only consist of -1. + Adjusts position restrictions when present. + """ + # Find the bounds of non-empty cells + min_row, max_row = piece.height, -1 + min_col, max_col = piece.width, -1 + + for i in range(piece.height): + for j in range(piece.width): + has_content = piece.main.grid[i][j] != -1 + if piece.parallel: + has_content = has_content or piece.parallel.grid[i][j] != -1 + if has_content: + min_row = min(min_row, i) + max_row = max(max_row, i) + min_col = min(min_col, j) + max_col = max(max_col, j) + + if max_row < 0 or (min_row == 0 and max_row == piece.height - 1 and min_col == 0 and max_col == piece.width - 1): + return piece + + new_height = max_row - min_row + 1 + new_width = max_col - min_col + 1 + piece.width = new_width + piece.height = new_height + + # Trim piece + piece.main.grid = [row[min_col:max_col + 1] for row in piece.main.grid[min_row:max_row + 1]] + piece.main.screens = [row[min_col:max_col + 1] for row in piece.main.screens[min_row:max_row + 1]] + piece.main.width = new_width + piece.main.height = new_height + + if piece.parallel: + piece.parallel.grid = [row[min_col:max_col + 1] for row in piece.parallel.grid[min_row:max_row + 1]] + piece.parallel.screens = [row[min_col:max_col + 1] for row in piece.parallel.screens[min_row:max_row + 1]] + piece.parallel.width = new_width + piece.parallel.height = new_height + + # Adjust restrictions if present + if piece.restriction is not None: + adjusted_restrictions = [] + for pos in piece.restriction: + old_row = pos // 8 + old_col = pos % 8 + new_row = (old_row + min_row) % 8 + new_col = (old_col + min_col) % 8 + adjusted_restrictions.append(new_row * 8 + new_col) + piece.restriction = adjusted_restrictions + + return piece + +def expand_arrangement(arrangement: List[List[int]], pieces: List[Piece]) -> List[List[int]]: + """ + Expand an arrangement to include all cells from the pieces being merged. + + When merging pieces, if a piece contains cells not in the original arrangement, + we need to expand the arrangement to include those cells in their correct + relative positions. + + Raises an exception if the relative positions of cells within pieces conflict + with the requested arrangement (e.g., contradictory merge operations). + + Note: This function uses wrap-aware position checking. Positions that differ + by multiples of 8 are considered equivalent (for wrapping support). This allows + arrangements like [[0x10, 0x11, 0x12, 0x13, 0x14]] and [[0x14, 0x15, 0x16, 0x17, 0x10]] + to be merged into a valid horizontal loop. + """ + # Build a mapping of cell_id -> (row, col) for all cells in all pieces + # relative to a common coordinate system + cell_positions: Dict[int, Tuple[int, int]] = {} + # Track wrapped_position -> cell_id to detect when two different cells would occupy the same position after wrapping + wrapped_position_to_cell: Dict[Tuple[int, int], int] = {} + + # First, map cells from the original arrangement + for i, row in enumerate(arrangement): + for j, cell in enumerate(row): + if cell != -1: + cell_positions[cell] = (i, j) + wrapped_pos = (i % 8, j % 8) + wrapped_position_to_cell[wrapped_pos] = cell + + # For each piece, determine where its cells should go + for piece in pieces: + # Find a cell that's already in our arrangement to anchor this piece + anchor_cell = None + anchor_piece_pos = None + for i, row in enumerate(piece.main.grid): + for j, cell in enumerate(row): + if cell != -1 and cell in cell_positions: + anchor_cell = cell + anchor_piece_pos = (i, j) + break + if anchor_cell is not None: + break + + # Calculate offset between piece coordinates and arrangement coordinates + anchor_arr_pos = cell_positions[anchor_cell] + offset_row = anchor_arr_pos[0] - anchor_piece_pos[0] + offset_col = anchor_arr_pos[1] - anchor_piece_pos[1] + + # Add all cells from this piece to cell_positions, checking for conflicts + for i, row in enumerate(piece.main.grid): + for j, cell in enumerate(row): + if cell != -1: + new_pos = (i + offset_row, j + offset_col) + # Normalize position for wrapping (positions differing by 8 are equivalent) + wrapped_pos = (new_pos[0] % 8, new_pos[1] % 8) + + if cell in cell_positions: + # Cell already has a position - verify it's consistent after wrapping + existing_pos = cell_positions[cell] + existing_wrapped = (existing_pos[0] % 8, existing_pos[1] % 8) + if existing_wrapped != wrapped_pos: + raise GenerationException( + f"Cannot merge: cell 0x{cell:02X} has conflicting positions. " + f"Existing position {existing_pos} (wrapped: {existing_wrapped}) conflicts with " + f"position {new_pos} (wrapped: {wrapped_pos}) from piece containing cells " + f"{[c for row in piece.main.grid for c in row if c != -1]}. " + f"This indicates contradictory merge operations." + ) + # Same cell at same wrapped position - this is fine (loop detected) + elif wrapped_pos in wrapped_position_to_cell: + # Position is already occupied by a different cell after wrapping + existing_cell = wrapped_position_to_cell[wrapped_pos] + raise GenerationException( + f"Cannot merge: cell 0x{cell:02X} would be placed at position {new_pos} " + f"(wrapped: {wrapped_pos}), but that position is already occupied by " + f"cell 0x{existing_cell:02X}. This indicates contradictory merge operations." + ) + else: + cell_positions[cell] = new_pos + wrapped_position_to_cell[wrapped_pos] = cell + + # Find the bounding box of all cells + if not cell_positions: + return arrangement + + min_row = min(pos[0] for pos in cell_positions.values()) + max_row = max(pos[0] for pos in cell_positions.values()) + min_col = min(pos[1] for pos in cell_positions.values()) + max_col = max(pos[1] for pos in cell_positions.values()) + + # Create new arrangement with normalized coordinates + new_height = max_row - min_row + 1 + new_width = max_col - min_col + 1 + new_arrangement = [[-1] * new_width for _ in range(new_height)] + + for cell, (row, col) in cell_positions.items(): + new_arrangement[row - min_row][col - min_col] = cell + + return new_arrangement + +def calculate_merged_restrictions(pieces: List[Piece], arrangement: List[List[int]]) -> Optional[List[int]]: + """ + Calculate restrictions for the merged piece. + + For each piece with restrictions, we translate the restrictions to account + for the piece's position in the merged arrangement. The final restriction + is the intersection of all translated restrictions. + + For example, when merging 4 quadrant pieces into a 2x2: + - NW piece (at position 0,0) has restrictions like [0x00, 0x03, ...] - no translation needed + - NE piece (at position 0,1) has restrictions like [0x01, 0x04, ...] - translate left by 1 + - SW piece (at position 1,0) has restrictions like [0x08, 0x0B, ...] - translate up by 1 + - SE piece (at position 1,1) has restrictions like [0x09, 0x0C, ...] - translate up and left by 1 + + After translation, all should give [0x00, 0x03, 0x05, 0x18, 0x1B, 0x1E, 0x30, 0x35] + """ + if not any(p.restriction for p in pieces): + return None + + # Build mapping from cell to position in arrangement + cell_to_new_pos = {} + for i, row in enumerate(arrangement): + for j, cell in enumerate(row): + if cell != -1: + cell_to_new_pos[cell] = (i, j) + + # For each piece, translate its restrictions + translated_restrictions = [] + for piece in pieces: + if piece.restriction is None: + continue + + # Find the first cell in this piece and its position in the arrangement + piece_cell = None + piece_old_pos = None + for i, row in enumerate(piece.main.grid): + for j, cell in enumerate(row): + if cell != -1 and cell in cell_to_new_pos: + piece_cell = cell + piece_old_pos = (i, j) + break + if piece_cell is not None: + break + + if piece_cell is None: + continue + + new_pos = cell_to_new_pos[piece_cell] + # The offset is how much we need to shift the restriction positions + # to get the top-left corner position of the merged piece + offset_row = new_pos[0] - piece_old_pos[0] + offset_col = new_pos[1] - piece_old_pos[1] + + # Translate restrictions: shift each restriction position back by the offset + # to get the position where the merged piece's top-left corner would be + translated = [] + for r in piece.restriction: + r_row = r // 8 + r_col = r % 8 + new_r_row = (r_row - offset_row) % 8 + new_r_col = (r_col - offset_col) % 8 + translated.append(new_r_row * 8 + new_r_col) + translated_restrictions.append(set(translated)) + + # Intersection of all translated restrictions + result = translated_restrictions[0] + for tr in translated_restrictions[1:]: + result &= tr + + return list(result) + +def merge_pieces(piece_list: List[Piece], arrangement: List[List[int]], world: World, player: int, overworld_screens: Dict[int, Screen]) -> List[Piece]: + """ + Merge pieces according to the specified arrangement. + + The arrangement is a 2D list where: + - Positive values are cell IDs that must be included + - -1 indicates a flexible/empty position + + Example: [[0x00, 0x01], [0x08, 0x09]] merges 4 pieces into a 2x2 piece + + If a piece being merged contains additional cells not in the arrangement, + the arrangement is automatically expanded to include all cells from all + pieces being merged. + """ + # Collect all cell IDs from arrangement, excluding -1 + target_cells = set() + for row in arrangement: + for cell in row: + if cell != -1: + target_cells.add(cell) + + # Find all pieces containing any of the target cells + pieces_to_merge = [] + remaining_pieces = [] + + for piece in piece_list: + piece_cells = get_piece_cells(piece) + if piece_cells & target_cells: + pieces_to_merge.append(piece) + else: + remaining_pieces.append(piece) + + # Validate: all target cells must be found + found_cells = set() + for piece in pieces_to_merge: + piece_cells = get_piece_cells(piece) + # Check for overlapping cells between pieces (indicates contradictory merges) + overlap = found_cells & piece_cells + if overlap: + raise GenerationException(f"Cannot merge: cells {overlap} appear in multiple pieces (contradictory merge operations)") + found_cells.update(piece_cells) + + if not target_cells.issubset(found_cells): + missing = target_cells - found_cells + raise GenerationException(f"Cannot merge: cells {missing} not found in any piece") + + # If pieces contain additional cells not in the arrangement, expand the arrangement + if found_cells != target_cells: + arrangement = expand_arrangement(arrangement, pieces_to_merge) + + # Create the merged piece + merged_piece = create_piece(world, player, arrangement, overworld_screens) + + # Calculate merged restrictions + merged_piece.restriction = calculate_merged_restrictions(pieces_to_merge, arrangement) + + remaining_pieces.append(merged_piece) + return remaining_pieces + +def validate_and_wrap_pieces(piece_list: List[Piece], options: LayoutGeneratorOptions, world: World, player: int, overworld_screens: Dict[int, Screen]) -> List[Piece]: + """ + Validate that all pieces are at most 8x8 in size. + If a piece is too large, attempt to reduce its size using wrapping. + """ + result_pieces = [] + + for piece in piece_list: + if piece.width <= 8 and piece.height <= 8: + result_pieces.append(piece) + continue + + # Piece is too large, need to apply wrapping + if piece.width > 8 and not options.horizontal_wrap: + raise GenerationException( + f"Piece has width {piece.width} which exceeds 8, but horizontal wrapping is not enabled. " + f"Cells: {[c for row in piece.main.grid for c in row if c != -1]}" + ) + + if piece.height > 8 and not options.vertical_wrap: + raise GenerationException( + f"Piece has height {piece.height} which exceeds 8, but vertical wrapping is not enabled. " + f"Cells: {[c for row in piece.main.grid for c in row if c != -1]}" + ) + + # Calculate wrapped dimensions + wrapped_width = min(piece.width, 8) + wrapped_height = min(piece.height, 8) + + # Create new wrapped grid, checking for conflicts + wrapped_grid = [[-1] * wrapped_width for _ in range(wrapped_height)] + + for i in range(piece.height): + wrapped_i = i % 8 + for j in range(piece.width): + wrapped_j = j % 8 + cell = piece.main.grid[i][j] + + if cell != -1: + existing = wrapped_grid[wrapped_i][wrapped_j] + if existing != -1 and existing != cell: + raise GenerationException( + f"Wrapping conflict: cell 0x{cell:02X} at position ({i}, {j}) " + f"would wrap to ({wrapped_i}, {wrapped_j}) which already contains cell 0x{existing:02X}. " + f"Piece cells: {[c for row in piece.main.grid for c in row if c != -1]}" + ) + wrapped_grid[wrapped_i][wrapped_j] = cell + + # Create the wrapped piece + wrapped_piece = create_piece(world, player, wrapped_grid, overworld_screens) + wrapped_piece.restriction = piece.restriction + result_pieces.append(wrapped_piece) + + return result_pieces + def add_piece_data(world: World, player: int, piece: Piece, large_screen_quadrant_info: Dict[int, Dict], large_screen_quadrant_info_land: Dict[int, Dict], large_screen_quadrant_info_water: Dict[int, Dict]) -> None: """ Add computed data to piece - Calls add_piece_grid_info for main and parallel pieces + Calls add_world_piece_edge_info for main and parallel pieces """ num_pieces = 2 if piece.parallel else 1 for p in range(num_pieces): world_piece = piece.main if p == 0 else piece.parallel - world_piece.width = len(world_piece.screens[0]) - world_piece.height = len(world_piece.screens) - add_piece_grid_info(world, player, world_piece, large_screen_quadrant_info, large_screen_quadrant_info_land, large_screen_quadrant_info_water) - - piece.width = piece.main.width - piece.height = piece.main.height + add_world_piece_edge_info(world, player, world_piece, large_screen_quadrant_info, large_screen_quadrant_info_land, large_screen_quadrant_info_water) # Calculate edge_sides and max_edges_per_side: 0 for multi-cell pieces if piece.width == 1 and piece.height == 1: @@ -572,12 +1139,11 @@ def add_piece_data(world: World, player: int, piece: Piece, large_screen_quadran piece.edge_sides = 0 piece.max_edges_per_side = 0 -def add_piece_grid_info(world: World, player: int, piece: WorldPiece, large_screen_quadrant_info: Dict[int, Dict], large_screen_quadrant_info_land: Dict[int, Dict], large_screen_quadrant_info_water: Dict[int, Dict]) -> None: +def add_world_piece_edge_info(world: World, player: int, piece: WorldPiece, large_screen_quadrant_info: Dict[int, Dict], large_screen_quadrant_info_land: Dict[int, Dict], large_screen_quadrant_info_water: Dict[int, Dict]) -> None: """ Populate piece edge information Initializes 8x8 edge arrays and extracts edges from screens """ - piece.grid = [[] for _ in range(8)] piece.north_edges = [[] for _ in range(8)] piece.south_edges = [[] for _ in range(8)] piece.west_edges = [[] for _ in range(8)] @@ -591,7 +1157,6 @@ def add_piece_grid_info(world: World, player: int, piece: WorldPiece, large_scre for k in range(piece.height): for l in range(piece.width): - piece.grid[k].append(piece.screens[k][l].id if piece.screens[k][l] else -1) piece.north_edges[k].append([]) piece.south_edges[k].append([]) piece.west_edges[k].append([]) @@ -603,38 +1168,41 @@ def add_piece_grid_info(world: World, player: int, piece: WorldPiece, large_scre piece.west_edges_water[k].append([]) piece.east_edges_water[k].append([]) - done_large = set() for k in range(piece.height): for l in range(piece.width): screen = piece.screens[k][l] if not screen: continue + cell_id = piece.grid[k][l] + if screen.big: - if screen.id not in done_large: - done_large.add(screen.id) - quadrant_info = (large_screen_quadrant_info[screen.id] if world.owTerrain[player] - else large_screen_quadrant_info_land[screen.id]) + # Determine quadrant by subtracting cell ID from screen ID + # 0x00 = NW (top-left), 0x01 = NE (top-right), 0x08 = SW (bottom-left), 0x09 = SE (bottom-right) + quadrant_offset = cell_id - screen.id + if quadrant_offset == 0x00: + quadrant_name = "NW" + elif quadrant_offset == 0x01: + quadrant_name = "NE" + elif quadrant_offset == 0x08: + quadrant_name = "SW" + else: + quadrant_name = "SE" - piece.north_edges[k][l] = [e for e in quadrant_info["NW"][Direction.North] if not e.dest] - piece.north_edges[k][l + 1] = [e for e in quadrant_info["NE"][Direction.North] if not e.dest] - piece.south_edges[k + 1][l] = [e for e in quadrant_info["SW"][Direction.South] if not e.dest] - piece.south_edges[k + 1][l + 1] = [e for e in quadrant_info["SE"][Direction.South] if not e.dest] - piece.west_edges[k][l] = [e for e in quadrant_info["NW"][Direction.West] if not e.dest] - piece.west_edges[k + 1][l] = [e for e in quadrant_info["SW"][Direction.West] if not e.dest] - piece.east_edges[k][l + 1] = [e for e in quadrant_info["NE"][Direction.East] if not e.dest] - piece.east_edges[k + 1][l + 1] = [e for e in quadrant_info["SE"][Direction.East] if not e.dest] + quadrant_info = (large_screen_quadrant_info[screen.id] if world.owTerrain[player] + else large_screen_quadrant_info_land[screen.id]) - if not world.owTerrain[player]: - quadrant_info = large_screen_quadrant_info_water[screen.id] - piece.north_edges_water[k][l] = [e for e in quadrant_info["NW"][Direction.North] if not e.dest] - piece.north_edges_water[k][l + 1] = [e for e in quadrant_info["NE"][Direction.North] if not e.dest] - piece.south_edges_water[k + 1][l] = [e for e in quadrant_info["SW"][Direction.South] if not e.dest] - piece.south_edges_water[k + 1][l + 1] = [e for e in quadrant_info["SE"][Direction.South] if not e.dest] - piece.west_edges_water[k][l] = [e for e in quadrant_info["NW"][Direction.West] if not e.dest] - piece.west_edges_water[k + 1][l] = [e for e in quadrant_info["SW"][Direction.West] if not e.dest] - piece.east_edges_water[k][l + 1] = [e for e in quadrant_info["NE"][Direction.East] if not e.dest] - piece.east_edges_water[k + 1][l + 1] = [e for e in quadrant_info["SE"][Direction.East] if not e.dest] + piece.north_edges[k][l] = [e for e in quadrant_info[quadrant_name][Direction.North] if not e.dest] + piece.south_edges[k][l] = [e for e in quadrant_info[quadrant_name][Direction.South] if not e.dest] + piece.west_edges[k][l] = [e for e in quadrant_info[quadrant_name][Direction.West] if not e.dest] + piece.east_edges[k][l] = [e for e in quadrant_info[quadrant_name][Direction.East] if not e.dest] + + if not world.owTerrain[player]: + quadrant_info_water = large_screen_quadrant_info_water[screen.id] + piece.north_edges_water[k][l] = [e for e in quadrant_info_water[quadrant_name][Direction.North] if not e.dest] + piece.south_edges_water[k][l] = [e for e in quadrant_info_water[quadrant_name][Direction.South] if not e.dest] + piece.west_edges_water[k][l] = [e for e in quadrant_info_water[quadrant_name][Direction.West] if not e.dest] + piece.east_edges_water[k][l] = [e for e in quadrant_info_water[quadrant_name][Direction.East] if not e.dest] else: for edge in sorted(screen.edges.values(), key=lambda e: e.midpoint): if not edge.dest: @@ -651,6 +1219,19 @@ def add_piece_grid_info(world: World, player: int, piece: WorldPiece, large_scre target = piece.east_edges[k][l] if world.owTerrain[player] or edge.terrain != Terrain.Water else piece.east_edges_water[k][l] target.append(edge) +def get_screen_id_from_cell(cell_id: int) -> int: + """Get the base screen ID from a cell ID. + + For large screens, returns the top-left corner ID. + For small screens, returns the cell ID unchanged. + """ + base_id = cell_id & 0xBF # Remove world bit if present + # Check if this is a quadrant of a large screen + for large_id in large_screen_ids: + if base_id in [large_id, large_id + 0x01, large_id + 0x08, large_id + 0x09]: + return large_id | (cell_id & 0x40) # Preserve world bit + return cell_id + # ============================================================================ # PLACEMENT ALGORITHM # ============================================================================ @@ -709,8 +1290,6 @@ def random_place_piece( piece_main = piece.main piece_parallel = piece.parallel wrld = piece.world - invalid_wrap_row = piece.invalid_wrap_row - invalid_wrap_column = piece.invalid_wrap_column restriction = piece.restriction piece_width = piece.width piece_height = piece.height @@ -721,13 +1300,8 @@ def random_place_piece( i_range = height if vertical_wrap else height - piece_height + 1 for i in range(i_range): - if i >= height - piece_height + 1 and (height - i) in invalid_wrap_row: - continue - j_range = width if horizontal_wrap else width - piece_width + 1 for j in range(j_range): - if j >= width - piece_width + 1 and (width - j) in invalid_wrap_column: - continue if restriction and (i * 8 + j) not in restriction: continue @@ -961,11 +1535,147 @@ def random_place_piece( return PiecePlacementResult(success=True, piece=piece, score_major=used_score_major, score_minor=used_score_minor) +def place_single_restriction_pieces( + world: World, + player: int, + grid_info: GridInfo, + options: LayoutGeneratorOptions, + pieces: List[Piece] +) -> Tuple[List[Piece], int]: + """ + Place pieces that have a restriction list with only a single element. + These pieces are forced into a single position, so we can place them deterministically. + + This function iteratively: + 1. Validates restriction lists against current grid state and grid bounds + 2. Places pieces with single-element restrictions + 3. Repeats until no more pieces can be placed + + Returns a tuple of (remaining_pieces, count_of_placed_pieces). + """ + use_crossed_groups = (world.owCrossed[player] == 'polar' and world.owMixed[player]) or world.owCrossed[player] == 'grouped' + + remaining_pieces = list(pieces) + placed_count = 0 + + placed_this_iteration = True + while placed_this_iteration: + placed_this_iteration = False + + # Validate and update restriction lists for all remaining pieces + for piece in remaining_pieces: + if piece.restriction is None: + continue + + valid_positions = [] + for position in piece.restriction: + row = position // 8 + column = position % 8 + wrld = piece.world + piece_crossed_groups = piece.crossed_groups + + # Check if this position is valid + is_valid = True + + # Check if piece would go outside grid bounds when wrapping is disabled + if not options.horizontal_wrap and column + piece.width > 8: + is_valid = False + if not options.vertical_wrap and row + piece.height > 8: + is_valid = False + + # Check for overlap with already placed pieces + if is_valid: + for k in range(piece.height): + if not is_valid: + break + row_idx = (row + k) % 8 + for l in range(piece.width): + col_idx = (column + l) % 8 + + # Check main world overlap + if grid_info.grid[wrld][row_idx][col_idx] != -1 and piece.main.screens[k][l]: + is_valid = False + break + + # Check parallel world overlap + if piece.parallel and grid_info.grid[1 - wrld][row_idx][col_idx] != -1 and piece.parallel.screens[k][l]: + is_valid = False + break + + # Check crossed groups + if use_crossed_groups and grid_info.crossed_groups[row_idx][col_idx] != -1 and grid_info.crossed_groups[row_idx][col_idx] != piece_crossed_groups[k][l]: + is_valid = False + break + + if is_valid: + valid_positions.append(position) + + # Update the restriction list + if len(valid_positions) == 0: + raise GenerationException(f"No valid positions remaining for piece with restriction list (original: {piece.restriction})") + + piece.restriction = valid_positions + + # Place pieces with single-element restrictions + new_remaining_pieces = [] + for piece in remaining_pieces: + # Check if this piece has exactly one restriction position + if piece.restriction is not None and len(piece.restriction) == 1: + position = piece.restriction[0] + row = position // 8 + column = position % 8 + wrld = piece.world + piece_crossed_groups = piece.crossed_groups + + # Place the piece on the grid + for k in range(piece.height): + row_idx = (row + k) % 8 + for l in range(piece.width): + col_idx = (column + l) % 8 + num_pieces = 2 if piece.parallel else 1 + for p in range(num_pieces): + world_piece = piece.main if p == 0 else piece.parallel + w = wrld if p == 0 else 1 - wrld + + grid_info.grid[w][row_idx][col_idx] = world_piece.grid[k][l] + grid_info.north_edges_grid[w][row_idx][col_idx] = world_piece.north_edges[k][l] + grid_info.south_edges_grid[w][row_idx][col_idx] = world_piece.south_edges[k][l] + grid_info.west_edges_grid[w][row_idx][col_idx] = world_piece.west_edges[k][l] + grid_info.east_edges_grid[w][row_idx][col_idx] = world_piece.east_edges[k][l] + + if not world.owTerrain[player]: + grid_info.north_edges_water_grid[w][row_idx][col_idx] = world_piece.north_edges_water[k][l] + grid_info.south_edges_water_grid[w][row_idx][col_idx] = world_piece.south_edges_water[k][l] + grid_info.west_edges_water_grid[w][row_idx][col_idx] = world_piece.west_edges_water[k][l] + grid_info.east_edges_water_grid[w][row_idx][col_idx] = world_piece.east_edges_water[k][l] + + if use_crossed_groups: + grid_info.crossed_groups[row_idx][col_idx] = piece_crossed_groups[k][l] + + placed_count += 1 + placed_this_iteration = True + else: + new_remaining_pieces.append(piece) + + remaining_pieces = new_remaining_pieces + + return remaining_pieces, placed_count + def get_random_layout(world: World, player: int, connected_edges_cache: List[str], pieces_to_place: List[Piece], options: LayoutGeneratorOptions, prio_edges: List[str], overworld_screens: Dict[int, Screen]) -> LayoutGeneratorResult: + skip_validate_layout = world.accessibility[player] == 'none' + score_mult_separate_areas = options.score_mult_separate_areas + apply_start_loc_penalty = options.score_mult_start_loc_distance > 0 and world.shuffle[player] == 'vanilla' and (world.is_dark_chapel_start(player) or world.doorShuffle[player] == 'vanilla' or world.intensity[player] < 3 or world.mode[player] == 'standard') total_score = 0 best_score = -1000000 worst_score = 1000000 best_grid_info = None + separate_areas = None + start_loc_distance = None + + # Pre-place pieces with single-element restriction lists + base_grid_info = create_empty_grid_info(0.0) + remaining_pieces, preplaced_count = place_single_restriction_pieces(world, player, base_grid_info, options, pieces_to_place) + logger = logging.getLogger('') successes = 0 failures = 0 @@ -973,9 +1683,10 @@ def get_random_layout(world: World, player: int, connected_edges_cache: List[str while run < options.min_runs or (run * successes < options.target_runs_times_successes and run < options.max_runs): run += 1 connected_edges = connected_edges_cache.copy() - piece_list = pieces_to_place.copy() + piece_list = remaining_pieces.copy() - grid_info = create_empty_grid_info(random.random()) + # Copy the pre-placed grid with a new random seed for edge connections + grid_info = copy_grid_info(base_grid_info, random.random()) for piece in piece_list: piece.delay = 0 @@ -1002,7 +1713,7 @@ def get_random_layout(world: World, player: int, connected_edges_cache: List[str for i in range(1, min(options.multi_choice, len(piece_list))): pieces.append(piece_list[i]) - result = random_place_piece(world, player, grid_info, options, pieces, len(placed_pieces) < options.first_ignore_bonus_points) + result = random_place_piece(world, player, grid_info, options, pieces, len(placed_pieces) + preplaced_count < options.first_ignore_bonus_points) if not result.success: failures += 1 @@ -1018,21 +1729,23 @@ def get_random_layout(world: World, player: int, connected_edges_cache: List[str # Successfully placed all pieces if options.check_reachability: disabled_count = connect_edges_for_screen_layout(world, player, grid_info, options, connected_edges, prio_edges, overworld_screens, False) - valid_layout = validate_layout(world, player) - # Clean up connected entrances and edges - for edge_name in connected_edges: - if edge_name not in connected_edges_cache: - entrance = world.get_entrance(edge_name, player) - entrance.connected_region.entrances.remove(entrance) - entrance.connected_region = None - edge = world.get_owedge(edge_name, player) - edge.dest = None + valid_layout = skip_validate_layout or validate_layout(world, player) if not valid_layout: + clean_up_connected_edges(world, player, connected_edges_cache, connected_edges) failures += 1 continue - logging.getLogger('').debug("Found valid layout with " + str(disabled_count)+ " disabled edges") - successes += 1 score = -disabled_count + if score_mult_separate_areas > 0: + separate_areas = len(get_separate_ow_areas(world, player)) + score -= score_mult_separate_areas * separate_areas + if apply_start_loc_penalty: + start_loc_distance = get_start_loc_distance(world, player, grid_info.grid, options) + min_dist = options.start_loc_min_distance + if start_loc_distance < min_dist: + score -= options.score_mult_start_loc_distance * (min_dist - start_loc_distance) + logger.debug("Found valid layout with " + str(disabled_count) + " disabled edges and " + str(separate_areas) + " separate areas and distance " + str(start_loc_distance) + " between start locations") + clean_up_connected_edges(world, player, connected_edges_cache, connected_edges) + successes += 1 else: successes += 1 score = major_score @@ -1061,6 +1774,40 @@ def get_random_layout(world: World, player: int, connected_edges_cache: List[str failures=failures ) +def clean_up_connected_edges(world: World, player: int, connected_edges_cache: List[str], connected_edges: List[str]) -> None: + for edge_name in connected_edges: + if edge_name not in connected_edges_cache: + entrance = world.get_entrance(edge_name, player) + entrance.connected_region.entrances.remove(entrance) + entrance.connected_region = None + edge = world.get_owedge(edge_name, player) + edge.dest = None + +def find_cell_position(grid: List[List[List[int]]], cell_id: int) -> Optional[Tuple[int, int, int]]: + """Find the position of a cell in the grid, returning (world, row, col) or None if not found.""" + for w in range(2): + for row in range(8): + for col in range(8): + if grid[w][row][col] == cell_id: + return (w, row, col) + return None + +def get_start_loc_distance(world: World, player: int, grid: List[List[List[int]]], options: LayoutGeneratorOptions) -> float: + """Computes the starting location Manhattan distance on the grid, treating the world as a third dimension (switching world adds 1 to the distance).""" + pos_lh = find_cell_position(grid, 0x6C if world.is_bombshop_start(player) else 0x2C) + pos_sanc = find_cell_position(grid, 0x53 if world.is_dark_chapel_start(player) else 0x13) + if pos_lh is None or pos_sanc is None: + raise GenerationException("Could not find starting location cells, something went wrong with grid layout generation!") + w1, row1, col1 = pos_lh + w2, row2, col2 = pos_sanc + row_diff = abs(row1 - row2) + col_diff = abs(col1 - col2) + if options.horizontal_wrap: + col_diff = min(col_diff, 8 - col_diff) + if options.vertical_wrap: + row_diff = min(row_diff, 8 - row_diff) + return row_diff + col_diff + abs(w1 - w2) + def get_prioritized_edges(world: World, player: int) -> List[str]: prio_edges = [] if world.accessibility[player] != 'none': @@ -1238,7 +1985,7 @@ def connect_edge_sets(world: World, player: int, edge_set_1: List[OWEdge], edge_ for k in range(len(edge_set_2)): connect_two_way(world, edges_to_connect[k].name, edge_set_2[k].name, player, connected_edges, final_placement) else: - raise Exception("There should never be multiple edges with high priority in an edge set") + raise GenerationException("There should never be multiple edges with high priority in an edge set") # ============================================================================ # GRID FORMATTING @@ -1316,11 +2063,22 @@ def format_grid_for_spoiler(grid: List[List[int]]) -> str: return "\n".join(lines) def is_same_large_screen(grid: List[List[int]], row1: int, col1: int, row2: int, col2: int) -> bool: - id1 = grid[row1 % 8][col1 % 8] - id2 = grid[row2 % 8][col2 % 8] + """Checks if two adjacent cells belong to the same large screen with correct quadrant positions.""" + id1, id2 = grid[row1 % 8][col1 % 8], grid[row2 % 8][col2 % 8] if id1 == -1 or id2 == -1: return False - return id1 == id2 and id1 in large_screen_ids + base1, base2 = get_screen_id_from_cell(id1), get_screen_id_from_cell(id2) + if base1 != base2 or base1 not in large_screen_ids: + return False + # Get quadrant offsets (0x00=NW, 0x01=NE, 0x08=SW, 0x09=SE) + q1, q2 = (id1 & 0xBF) - (base1 & 0xBF), (id2 & 0xBF) - (base2 & 0xBF) + # Swap if cell2 is before cell1 + if col1 > col2 or row1 > row2: + q1, q2 = q2, q1 + # Check valid adjacency: east (0x00->0x01, 0x08->0x09) or south (0x00->0x08, 0x01->0x09) + if col1 != col2: + return (q1, q2) in [(0x00, 0x01), (0x08, 0x09)] + return (q1, q2) in [(0x00, 0x08), (0x01, 0x09)] # ============================================================================ # MAIN EXECUTION @@ -1332,12 +2090,14 @@ def generate_random_grid_layout(world: World, player: int, connected_edges: List horizontal_wrap = False vertical_wrap = False + split_large_screens = False if world.customizer: grid_options = world.customizer.get_owgrid() if grid_options and player in grid_options: grid_options = grid_options[player] horizontal_wrap = 'wrap_horizontal' in grid_options and grid_options['wrap_horizontal'] == True vertical_wrap = 'wrap_vertical' in grid_options and grid_options['wrap_vertical'] == True + split_large_screens = 'split_large_screens' in grid_options and grid_options['split_large_screens'] == True first_ignore_bonus = 2 if not world.owParallel[player]: @@ -1347,7 +2107,7 @@ def generate_random_grid_layout(world: World, player: int, connected_edges: List options = LayoutGeneratorOptions( horizontal_wrap=horizontal_wrap, vertical_wrap=vertical_wrap, - large_screen_pool=False, + split_large_screens=split_large_screens, distortion_chance=0.0, random_order=6 if world.owParallel[player] else 12, multi_choice=1, @@ -1369,7 +2129,10 @@ def generate_random_grid_layout(world: World, player: int, connected_edges: List sort_by_piece_size=True, min_runs=100, max_runs=10000, - target_runs_times_successes=5000 + target_runs_times_successes=5000, + score_mult_separate_areas=4, + start_loc_min_distance=4, + score_mult_start_loc_distance=3 ) overworld_screens = initialize_screens(world, player) @@ -1385,19 +2148,9 @@ def generate_random_grid_layout(world: World, player: int, connected_edges: List connect_edges_for_screen_layout(world, player, result.grid_info, options, connected_edges, prio_edges, overworld_screens, True) grid = result.grid_info.grid - # Make new grid containing cell IDs for the overworld map - map_grid = copy.deepcopy(grid) - for w in range(2): - for i in range(8): - for j in range(8): - screen_id = map_grid[w][i][j] - if screen_id in large_screen_ids and map_grid[w][i][(j + 1) % 8] == screen_id and map_grid[w][(i + 1) % 8][j] == screen_id and map_grid[w][(i + 1) % 8][(j + 1) % 8] == screen_id: - map_grid[w][i][(j + 1) % 8] = screen_id + 0x01 - map_grid[w][(i + 1) % 8][j] = screen_id + 0x08 - map_grid[w][(i + 1) % 8][(j + 1) % 8] = screen_id + 0x09 - world.owgrid[player] = map_grid - world.owlayoutmap_lw[player] = {id & 0xBF: i for i, id in enumerate(sum(map_grid[0], []))} - world.owlayoutmap_dw[player] = {id & 0xBF: i for i, id in enumerate(sum(map_grid[1], []))} + world.owgrid[player] = grid + world.owlayoutmap_lw[player] = {id & 0xBF: i for i, id in enumerate(sum(grid[0], []))} + world.owlayoutmap_dw[player] = {id & 0xBF: i for i, id in enumerate(sum(grid[1], []))} world.spoiler.set_map('layout_grid_lw', format_grid_for_spoiler(grid[0]), grid[0], player) if not world.owParallel[player]: @@ -1411,6 +2164,7 @@ def generate_random_grid_layout(world: World, player: int, connected_edges: List logger.debug(f" Successes: {result.successes}") logger.debug(f" Failures: {result.failures}") logger.debug(f" Generation time: {elapsed_time:.3f}s") + logger.debug(f" Layouts per second: {(result.successes+result.failures)/elapsed_time:.3f}") if DRAW_IMAGE: logger.debug("Creating layout visualization...") @@ -1420,4 +2174,4 @@ def generate_random_grid_layout(world: World, player: int, connected_edges: List except Exception as e: logger.warning(f"Warning: Could not create visualization: {e}") else: - raise Exception(f"Layout generation FAILED after {result.failures} attempts and {elapsed_time:.3f} seconds") \ No newline at end of file + raise GenerationException(f"Layout generation FAILED after {result.failures} attempts and {elapsed_time:.3f} seconds") \ No newline at end of file diff --git a/source/overworld/LayoutVisualizer.py b/source/overworld/LayoutVisualizer.py index 8dbdea34..f76ddc58 100644 --- a/source/overworld/LayoutVisualizer.py +++ b/source/overworld/LayoutVisualizer.py @@ -4,7 +4,18 @@ from datetime import datetime from typing import Dict, List from PIL import Image, ImageDraw from BaseClasses import Direction, OWEdge -from source.overworld.LayoutGenerator import Screen +from source.overworld.LayoutGenerator import Screen, get_screen_id_from_cell + +def get_quadrant_from_cell_id(cell_id: int, screen_id: int) -> str: + offset = (cell_id & 0xBF) - (screen_id & 0xBF) + if offset == 0x00: + return "NW" + elif offset == 0x01: + return "NE" + elif offset == 0x08: + return "SW" + else: + return "SE" def get_edge_lists(grid: List[List[List[int]]], overworld_screens: Dict[int, Screen], @@ -13,7 +24,7 @@ def get_edge_lists(grid: List[List[List[int]]], Get list of edges for each cell and direction. Args: - grid: 3D list [world][row][col] containing screen IDs + grid: 3D list [world][row][col] containing cell IDs overworld_screens: Dict of screen_id -> Screen objects large_screen_quadrant_info: Dict of screen_id -> quadrant info for large screens @@ -24,47 +35,27 @@ def get_edge_lists(grid: List[List[List[int]]], GRID_SIZE = 8 edge_lists = {} - # Large screen base IDs - large_screen_base_ids = [0x00, 0x03, 0x05, 0x18, 0x1B, 0x1E, 0x30, 0x35, - 0x40, 0x43, 0x45, 0x58, 0x5B, 0x5E, 0x70, 0x75] - for world_idx in range(2): - # Build a map of screen_id -> list of (row, col) positions for large screens - large_screen_positions = {} for row in range(GRID_SIZE): for col in range(GRID_SIZE): - screen_id = grid[world_idx][row][col] - if screen_id != -1 and screen_id in large_screen_base_ids: - if screen_id not in large_screen_positions: - large_screen_positions[screen_id] = [] - large_screen_positions[screen_id].append((row, col)) + cell_id = grid[world_idx][row][col] - for row in range(GRID_SIZE): - for col in range(GRID_SIZE): - screen_id = grid[world_idx][row][col] - - if screen_id == -1: + if cell_id == -1: # Empty cell - no edges for direction in [Direction.North, Direction.South, Direction.East, Direction.West]: edge_lists[(world_idx, row, col, direction)] = [] continue + screen_id = get_screen_id_from_cell(cell_id) screen = overworld_screens.get(screen_id) if not screen: for direction in [Direction.North, Direction.South, Direction.East, Direction.West]: edge_lists[(world_idx, row, col, direction)] = [] continue - is_large = screen_id in large_screen_base_ids - - if is_large: - # For large screens, determine which quadrant this cell is - # Find all positions of this large screen and determine quadrant - positions = large_screen_positions.get(screen_id, [(row, col)]) - - # Determine quadrant by finding relative position - # The quadrant is determined by which cells are adjacent - quadrant = determine_large_screen_quadrant(row, col, positions, GRID_SIZE) + if screen.big: + # For large screens, determine quadrant from cell ID + quadrant = get_quadrant_from_cell_id(cell_id, screen_id) # Get edges for this quadrant if screen_id in large_screen_quadrant_info: @@ -85,45 +76,6 @@ def get_edge_lists(grid: List[List[List[int]]], return edge_lists -def determine_large_screen_quadrant(row: int, col: int, positions: List[tuple], grid_size: int) -> str: - """ - Determine which quadrant (NW, NE, SW, SE) a cell is in for a large screen. - Handles wrapping correctly by checking adjacency patterns. - - Args: - row: Current cell row - col: Current cell column - positions: List of all (row, col) positions for this large screen - grid_size: Size of the grid (8) - - Returns: - Quadrant string: "NW", "NE", "SW", or "SE" - """ - positions_set = set(positions) - - # Check which adjacent cells also belong to this large screen - has_right = ((row, (col + 1) % grid_size) in positions_set) - has_below = (((row + 1) % grid_size, col) in positions_set) - has_left = ((row, (col - 1) % grid_size) in positions_set) - has_above = (((row - 1) % grid_size, col) in positions_set) - - # Determine quadrant based on adjacency - # NW: has right and below neighbors - # NE: has left and below neighbors - # SW: has right and above neighbors - # SE: has left and above neighbors - - if has_right and has_below: - return "NW" - elif has_left and has_below: - return "NE" - elif has_right and has_above: - return "SW" - elif has_left and has_above: - return "SE" - else: - raise Exception("?") - def is_crossed_edge(edge: OWEdge, overworld_screens: Dict[int, Screen]) -> bool: if edge.dest is None: return False @@ -132,6 +84,40 @@ def is_crossed_edge(edge: OWEdge, overworld_screens: Dict[int, Screen]) -> bool: dest_screen = overworld_screens.get(edge.dest.owIndex) return source_screen.dark_world != dest_screen.dark_world +def are_large_screen_cells_connected(cell_id1: int, cell_id2: int, quadrant1: str, quadrant2: str, direction: str) -> bool: + """ + Check if two cells of a large screen are connected (should have no border between them). + + For cells to be connected: + 1. They must be from the same large screen (same base screen ID) + 2. Their quadrants must be adjacent in the expected direction + + Args: + cell_id1: Cell ID of the first cell + cell_id2: Cell ID of the second cell + quadrant1: Quadrant of the first cell ("NW", "NE", "SW", "SE") + quadrant2: Quadrant of the second cell + direction: Direction from cell1 to cell2 ("east", "south") + + Returns: + True if the cells should have no border between them + """ + # Must be from the same large screen + screen_id1 = get_screen_id_from_cell(cell_id1) + screen_id2 = get_screen_id_from_cell(cell_id2) + if screen_id1 != screen_id2: + return False + + # Check if quadrants are properly adjacent + if direction == "east": + # For east connection: NW->NE or SW->SE + return (quadrant1 == "NW" and quadrant2 == "NE") or (quadrant1 == "SW" and quadrant2 == "SE") + elif direction == "south": + # For south connection: NW->SW or NE->SE + return (quadrant1 == "NW" and quadrant2 == "SW") or (quadrant1 == "NE" and quadrant2 == "SE") + + return False + def visualize_layout(grid: List[List[List[int]]], output_dir: str, overworld_screens: Dict[int, Screen], large_screen_quadrant_info: Dict[int, Dict]) -> None: @@ -162,78 +148,42 @@ def visualize_layout(grid: List[List[List[int]]], output_dir: str, output_height = world_height output_img = Image.new('RGB', (output_width, output_height), color='black') - # Large screen base IDs (defined once for reuse) - large_screen_base_ids = [0x00, 0x03, 0x05, 0x18, 0x1B, 0x1E, 0x30, 0x35, - 0x40, 0x43, 0x45, 0x58, 0x5B, 0x5E, 0x70, 0x75] - # Process both worlds for world_idx in range(2): x_offset = 0 if world_idx == 0 else (world_width + gap) - # Build a map of screen_id -> list of (row, col) positions for large screens - large_screen_positions = {} - for row in range(GRID_SIZE): - for col in range(GRID_SIZE): - screen_id = grid[world_idx][row][col] - if screen_id != -1 and screen_id in large_screen_base_ids: - if screen_id not in large_screen_positions: - large_screen_positions[screen_id] = [] - large_screen_positions[screen_id].append((row, col)) - # Process each cell in the grid individually - # This handles wrapped large screens correctly by drawing each quadrant separately for row in range(GRID_SIZE): for col in range(GRID_SIZE): - screen_id = grid[world_idx][row][col] + cell_id = grid[world_idx][row][col] - if screen_id == -1: + if cell_id == -1: # Empty cell - fill with black (already black from initialization) continue - is_large = screen_id in large_screen_base_ids + screen_id = get_screen_id_from_cell(cell_id) + screen = overworld_screens.get(screen_id) + if not screen: + continue - # Calculate source position in the world image - source_row = (screen_id % 0x40) >> 3 - source_col = screen_id % 0x08 - world_img = lightworld_img if screen_id < 0x40 else darkworld_img + is_large = screen.big - if is_large: - # For large screens, determine which quadrant this cell represents - positions = large_screen_positions.get(screen_id, [(row, col)]) - quadrant = determine_large_screen_quadrant(row, col, positions, GRID_SIZE) + # Calculate source position in the world image based on cell_id + # For large screens, cell_id already encodes the quadrant position + source_row = (cell_id % 0x40) >> 3 + source_col = cell_id % 0x08 + world_img = lightworld_img if cell_id < 0x40 else darkworld_img - # Map quadrant to source offset within the 2x2 large screen - quadrant_offsets = { - "NW": (0, 0), - "NE": (1, 0), - "SW": (0, 1), - "SE": (1, 1) - } - q_col_offset, q_row_offset = quadrant_offsets[quadrant] + source_x = source_col * SOURCE_CELL_SIZE + source_y = source_row * SOURCE_CELL_SIZE - # Calculate source position for this quadrant - source_x = (source_col + q_col_offset) * SOURCE_CELL_SIZE - source_y = (source_row + q_row_offset) * SOURCE_CELL_SIZE - - # Crop single cell from source (the specific quadrant) - cropped = world_img.crop(( - source_x, - source_y, - source_x + SOURCE_CELL_SIZE, - source_y + SOURCE_CELL_SIZE - )) - else: - # Small screen (1x1) - source_x = source_col * SOURCE_CELL_SIZE - source_y = source_row * SOURCE_CELL_SIZE - - # Crop single cell from source - cropped = world_img.crop(( - source_x, - source_y, - source_x + SOURCE_CELL_SIZE, - source_y + SOURCE_CELL_SIZE - )) + # Crop single cell from source + cropped = world_img.crop(( + source_x, + source_y, + source_x + SOURCE_CELL_SIZE, + source_y + SOURCE_CELL_SIZE + )) # Resize to output size (64x64 pixels) resized = cropped.resize( @@ -257,52 +207,93 @@ def visualize_layout(grid: List[List[List[int]]], output_dir: str, for world_idx in range(2): x_offset = 0 if world_idx == 0 else (world_width + gap) - # Build large screen positions map for this world - large_screen_positions = {} - for row in range(GRID_SIZE): - for col in range(GRID_SIZE): - screen_id = grid[world_idx][row][col] - if screen_id != -1 and screen_id in large_screen_base_ids: - if screen_id not in large_screen_positions: - large_screen_positions[screen_id] = [] - large_screen_positions[screen_id].append((row, col)) - # Draw borders for each cell + # For large screens, only draw borders where cells are not connected for row in range(GRID_SIZE): for col in range(GRID_SIZE): - screen_id = grid[world_idx][row][col] + cell_id = grid[world_idx][row][col] - if screen_id == -1: + if cell_id == -1: continue - is_large = screen_id in large_screen_base_ids + screen_id = get_screen_id_from_cell(cell_id) + screen = overworld_screens.get(screen_id) + if not screen: + continue + + is_large = screen.big dest_x = x_offset + col * OUTPUT_CELL_SIZE dest_y = row * OUTPUT_CELL_SIZE if is_large: - # For large screens, determine which quadrant this cell is - positions = large_screen_positions.get(screen_id, [(row, col)]) - quadrant = determine_large_screen_quadrant(row, col, positions, GRID_SIZE) + quadrant = get_quadrant_from_cell_id(cell_id, screen_id) - # Draw border only on the outer edges of the large screen - # (not on internal edges between quadrants) - # NW: draw top and left borders - # NE: draw top and right borders - # SW: draw bottom and left borders - # SE: draw bottom and right borders - - if quadrant in ["NW", "NE"]: - # Draw top border - draw.line([(dest_x, dest_y), (dest_x + OUTPUT_CELL_SIZE - 1, dest_y)], fill='black', width=BORDER_WIDTH) + # Check each border direction + # Top border: draw if this is a north quadrant OR if the cell above is not connected + draw_top = True if quadrant in ["SW", "SE"]: - # Draw bottom border - draw.line([(dest_x, dest_y + OUTPUT_CELL_SIZE - 1), (dest_x + OUTPUT_CELL_SIZE - 1, dest_y + OUTPUT_CELL_SIZE - 1)], fill='black', width=BORDER_WIDTH) - if quadrant in ["NW", "SW"]: - # Draw left border - draw.line([(dest_x, dest_y), (dest_x, dest_y + OUTPUT_CELL_SIZE - 1)], fill='black', width=BORDER_WIDTH) + # Check if cell above is connected + above_row = (row - 1) % GRID_SIZE + above_cell_id = grid[world_idx][above_row][col] + if above_cell_id != -1: + above_screen_id = get_screen_id_from_cell(above_cell_id) + above_screen = overworld_screens.get(above_screen_id) + if above_screen and above_screen.big: + above_quadrant = get_quadrant_from_cell_id(above_cell_id, above_screen_id) + if are_large_screen_cells_connected(above_cell_id, cell_id, above_quadrant, quadrant, "south"): + draw_top = False + + # Bottom border: draw if this is a south quadrant OR if the cell below is not connected + draw_bottom = True + if quadrant in ["NW", "NE"]: + # Check if cell below is connected + below_row = (row + 1) % GRID_SIZE + below_cell_id = grid[world_idx][below_row][col] + if below_cell_id != -1: + below_screen_id = get_screen_id_from_cell(below_cell_id) + below_screen = overworld_screens.get(below_screen_id) + if below_screen and below_screen.big: + below_quadrant = get_quadrant_from_cell_id(below_cell_id, below_screen_id) + if are_large_screen_cells_connected(cell_id, below_cell_id, quadrant, below_quadrant, "south"): + draw_bottom = False + + # Left border: draw if this is a west quadrant OR if the cell to the left is not connected + draw_left = True if quadrant in ["NE", "SE"]: - # Draw right border + # Check if cell to the left is connected + left_col = (col - 1) % GRID_SIZE + left_cell_id = grid[world_idx][row][left_col] + if left_cell_id != -1: + left_screen_id = get_screen_id_from_cell(left_cell_id) + left_screen = overworld_screens.get(left_screen_id) + if left_screen and left_screen.big: + left_quadrant = get_quadrant_from_cell_id(left_cell_id, left_screen_id) + if are_large_screen_cells_connected(left_cell_id, cell_id, left_quadrant, quadrant, "east"): + draw_left = False + + # Right border: draw if this is an east quadrant OR if the cell to the right is not connected + draw_right = True + if quadrant in ["NW", "SW"]: + # Check if cell to the right is connected + right_col = (col + 1) % GRID_SIZE + right_cell_id = grid[world_idx][row][right_col] + if right_cell_id != -1: + right_screen_id = get_screen_id_from_cell(right_cell_id) + right_screen = overworld_screens.get(right_screen_id) + if right_screen and right_screen.big: + right_quadrant = get_quadrant_from_cell_id(right_cell_id, right_screen_id) + if are_large_screen_cells_connected(cell_id, right_cell_id, quadrant, right_quadrant, "east"): + draw_right = False + + # Draw the borders + if draw_top: + draw.line([(dest_x, dest_y), (dest_x + OUTPUT_CELL_SIZE - 1, dest_y)], fill='black', width=BORDER_WIDTH) + if draw_bottom: + draw.line([(dest_x, dest_y + OUTPUT_CELL_SIZE - 1), (dest_x + OUTPUT_CELL_SIZE - 1, dest_y + OUTPUT_CELL_SIZE - 1)], fill='black', width=BORDER_WIDTH) + if draw_left: + draw.line([(dest_x, dest_y), (dest_x, dest_y + OUTPUT_CELL_SIZE - 1)], fill='black', width=BORDER_WIDTH) + if draw_right: draw.line([(dest_x + OUTPUT_CELL_SIZE - 1, dest_y), (dest_x + OUTPUT_CELL_SIZE - 1, dest_y + OUTPUT_CELL_SIZE - 1)], fill='black', width=BORDER_WIDTH) else: # Small screen - draw border around single cell @@ -315,8 +306,8 @@ def visualize_layout(grid: List[List[List[int]]], output_dir: str, # Draw edge connection indicators for each cell for row in range(GRID_SIZE): for col in range(GRID_SIZE): - screen_id = grid[world_idx][row][col] - if screen_id == -1: + cell_id = grid[world_idx][row][col] + if cell_id == -1: continue dest_x = x_offset + col * OUTPUT_CELL_SIZE