mirror of
https://github.com/MarioSpore/Grinch-AP.git
synced 2025-10-21 20:21:32 -06:00
Ocarina of Time (#64)
* first commit (not including OoT data files yet) * added some basic options * rule parser works now at least * make sure to commit everything this time * temporary change to BaseClasses for oot * overworld location graph builds mostly correctly * adding oot data files * commenting out world options until later since they only existed to make the RuleParser work * conversion functions between AP ids and OOT ids * world graph outputs * set scrub prices * itempool generates, entrances connected, way too many options added * fixed set_rules and set_shop_rules * temp baseclasses changes * Reaches the fill step now, old event-based system retained in case the new way breaks * Song placements and misc fixes everywhere * temporary changes to make oot work * changed root exits for AP fill framework * prevent infinite recursion due to OoT sharing usage of the address field * age reachability works hopefully, songs are broken again * working spoiler log generation on beatable-only * Logic tricks implemented * need this for logic tricks * fixed map/compass being placed on Serenade location * kill unreachable events before filling the world * add a bunch of utility functions to prepare for rom patching * move OptionList into generic options * fixed some silly bugs with OptionList * properly seed all random behavior (so far) * ROM generation working * fix hints trying to get alttp dungeon hint texts * continue fixing hints * add oot to network data package * change item and location IDs to 66000 and 67000 range respectively * push removed items to precollected items * fixed various issues with cross-contamination with multiple world generation * reenable glitched logic (hopefully) * glitched world files age-check fix * cleaned up some get_locations calls * added token shuffle and scrub shuffle, modified some options slightly to make the parsing work * reenable MQ dungeons * fix forest mq exception * made targeting style an option for now, will be cosmetic later * reminder to move targeting to cosmetics * some oot option maintenance * enabled starting time of day * fixed issue breaking shop slots in multiworld generation * added "off" option for text shuffle and hints * shopsanity functionality restored * change patch file extension * remove unnecessary utility functions + imports * update MIT license * change option to "patch_uncompressed_rom" instead of "compress_rom" * compliance with new AutoWorld systems * Kill only internal events, remove non-internal big poe event in code * re-add the big poe event and handle it correctly * remove extra method in Range option * fix typo * Starting items, starting with consumables option * do not remove nonexistent item * move set_shop_rules to after shop items are placed * some cleanup * add retries for song placement * flagged Skull Mask and Mask of Truth as advancement items * update OoT to use LogicMixin * Fixed trying to assign starting items from the wrong players * fixed song retry step * improved option handling, comments, and starting item replacements * DefaultOnToggle writes Yes or No to spoiler * enable compression of output if Compress executable is present * clean up compression * check whether (de)compressor exists before running the process * allow specification of rom path in host.yaml * check if decompressed file already exists before decompressing again * fix triforce hunt generation * rename all the oot state functions with prefix * OoT: mark triforce pieces as completion goal for triforce hunt * added overworld and any-dungeon shuffle for dungeon items * Hide most unshuffled locations and events from the list of locations in spoiler * build oot option ranges with a generic function instead of defining each separately * move oot output-type control to host.yaml instead of individual yamls * implement dungeon song shuffle * minor improvements to overworld dungeon item shuffle * remove random ice trap names in shops, mostly to avoid maintaining a massive censor list * always output patch file to folder, remove option to generate ROM in preparation for removal * re-add the fix for infinite recursion due to not being light or dark world * change AP-sendable to Ocarina of Time model, since the triforce piece has some extra code apparently * oot: remove item_names and location_names * oot: minor fixes * oot: comment out ROM patching * oot: only add CollectionState objects on creation if actually needed * main entrance shuffle method and entrances-based rules * fix entrances based rules * disable master quest and big poe count options for client compatibility * use get_player_name instead of get_player_names * fix OptionList * fix oot options for new option system * new coop section in oot rom: expand player names to 16 bytes, write AP_PLAYER_NAME at end of PLAYER_NAMES * fill AP player name in oot rom with 0 instead of 0xDF * encode player name with ASCII for fixed-width * revert oot player name array to 8 bytes per name * remove Pierre location if fast scarecrow is on * check player name length * "free_scarecrow" not "fast_scarecrow" * OoT locations now properly store the AP ID instead of the oot internal ID * oot __version__ updates in lockstep with AP version * pull in unmodified oot cosmetic files * also grab JSONDump since it's needed apparently * gather extra needed methods, modify imports * delete cosmetics log, replace all instances of SettingsList with OOTWorld * cosmetic options working, except for sound effects (due to ear-safe issues) * SFX, Music, and Fanfare randomization reenabled * move OoT data files into the worlds folder * move Compress and Decompress into oot data folder * Replace get_all_state with custom method to avoid the cache * OoT ROM: increment item counter before setting incoming item/player values to 0, preventing desync issues * set data_version to 0 * make Kokiri Sword shuffle off by default * reenable "Random Choice" for various cosmetic options * kill Ruto's Letter turnin if open fountain also fix for shopsanity * place Buy Goron/Zora Tunic first in shop shuffle * make ice traps appear as other items instead of breaking generation * managed to break ice traps on non-major-only * only handle ice traps if they are on * fix shopsanity for non-oot games, and write player name instead of player number * light arrows hint uses player name instead of player number * Reenable "skip child zelda" option * fix entrances_based_rules * fix ganondorf hint if starting with light arrows * fix dungeonitem shuffle and shopsanity interaction * remove has_all_of, has_any_of, count_of in BaseClasses, replace usage with has_all, has_any, has_group * force local giveable item on ZL if skip_child_zelda and shuffle_song_items is any * keep bosses and bombchu bowling chus out of data package * revert workaround for infinite recursion and fix it properly * fix shared shop id caches during patching process * fix shop text box overflows, as much as possible * add default oot host.yaml option * add .apz5, .n64, .z64 to gitignore * Properly document and name all (functioning) OOT options * clean up some imports * remove unnecessary files from oot's data * fix typo in gitignore * readd the Compress and Decompress utilities, since they are needed for generation * cleanup of imports and some minor optimizations * increase shop offset for item IDs to 0xCB * remove shop item AP ids entirely * prevent triforce pieces for other players from being received by yourself * add "excluded" property to Location * Hint system adapted and reenabled; hints still unseeded * make hints deterministic with lists instead of sets * do not allow hints to point to Light Arrows on non-vanilla bridge * foreign locations hint as their full name in OoT rather than their region * checkedLocations now stores hint names by player ID, so that the same location in different worlds can have hints associated * consolidate versioning in Utils * ice traps appear as major items rather than any progression item * set prescription and claim check as defaults for adult trade item settings * add oot options to playerSettings * allow case-insensitive logic tricks in yaml * fix oot shopsanity option formatting * Write OoT override info even if local item, enabling local checks to show up immediately in the client * implement CollectionState.can_live_dmg for oot glitched logic * filter item names for invalid characters when patching shops * make ice traps appear according to the settings of the world they are shuffled into, rather than the original world * set hidden-spoiler items and locations with Shop items to events * make GF carpenters, Gerudo Card, Malon, ZL, and Impa events if the relevant settings are enabled, preventing them from appearing in the client on game start * Fix oot Glitched and No Logic generation * fix indenting * Greatly reduce displayed cosmetic options * Change oot data version to 1 * add apz5 distribution to webhost * print player name if an ALttP dungeon contains a good item for OoT world * delete unneeded commented code * remove OcarinaSongs import to satisfy lint
This commit is contained in:
espeon65536
203
worlds/oot/Rules.py
Normal file
203
worlds/oot/Rules.py
Normal file
@@ -0,0 +1,203 @@
|
||||
from collections import deque
|
||||
import logging
|
||||
|
||||
from .SaveContext import SaveContext
|
||||
|
||||
from BaseClasses import CollectionState
|
||||
from worlds.generic.Rules import set_rule, add_rule, add_item_rule, forbid_item, item_in_locations
|
||||
from ..AutoWorld import LogicMixin
|
||||
|
||||
|
||||
class OOTLogic(LogicMixin):
|
||||
|
||||
def _oot_has_stones(self, count, player):
|
||||
return self.has_group("stones", player, count)
|
||||
|
||||
def _oot_has_medallions(self, count, player):
|
||||
return self.has_group("medallions", player, count)
|
||||
|
||||
def _oot_has_dungeon_rewards(self, count, player):
|
||||
return self.has_group("rewards", player, count)
|
||||
|
||||
def _oot_has_bottle(self, player):
|
||||
return self.has_group("bottles", player)
|
||||
|
||||
# Used for fall damage and other situations where damage is unavoidable
|
||||
def _oot_can_live_dmg(self, player, hearts):
|
||||
mult = self.world.worlds[player].damage_multiplier
|
||||
if hearts*4 >= 3:
|
||||
return mult != 'ohko' and mult != 'quadruple'
|
||||
elif hearts*4 < 3:
|
||||
return mult != 'ohko'
|
||||
else:
|
||||
return True
|
||||
|
||||
# This function operates by assuming different behavior based on the "level of recursion", handled manually.
|
||||
# If it's called while self.age[player] is None, then it will set the age variable and then attempt to reach the region.
|
||||
# If self.age[player] is not None, then it will compare it to the 'age' parameter, and return True iff they are equal.
|
||||
# This lets us fake the OOT accessibility check that cares about age. Unfortunately it's still tied to the ground region.
|
||||
def _oot_reach_as_age(self, regionname, age, player):
|
||||
if self.age[player] is None:
|
||||
self.age[player] = age
|
||||
can_reach = self.world.get_region(regionname, player).can_reach(self)
|
||||
self.age[player] = None
|
||||
return can_reach
|
||||
return self.age[player] == age
|
||||
|
||||
# Store the age before calling this!
|
||||
def _oot_update_age_reachable_regions(self, player):
|
||||
self.stale[player] = False
|
||||
for age in ['child', 'adult']:
|
||||
self.age[player] = age
|
||||
rrp = getattr(self, f'{age}_reachable_regions')[player]
|
||||
bc = getattr(self, f'{age}_blocked_connections')[player]
|
||||
queue = deque(getattr(self, f'{age}_blocked_connections')[player])
|
||||
start = self.world.get_region('Menu', player)
|
||||
|
||||
# init on first call - this can't be done on construction since the regions don't exist yet
|
||||
if not start in rrp:
|
||||
rrp.add(start)
|
||||
bc.update(start.exits)
|
||||
queue.extend(start.exits)
|
||||
|
||||
# run BFS on all connections, and keep track of those blocked by missing items
|
||||
while queue:
|
||||
connection = queue.popleft()
|
||||
new_region = connection.connected_region
|
||||
if new_region in rrp:
|
||||
bc.remove(connection)
|
||||
elif connection.can_reach(self):
|
||||
rrp.add(new_region)
|
||||
bc.remove(connection)
|
||||
bc.update(new_region.exits)
|
||||
queue.extend(new_region.exits)
|
||||
self.path[new_region] = (new_region.name, self.path.get(connection, None))
|
||||
|
||||
|
||||
def set_rules(ootworld):
|
||||
logger = logging.getLogger('')
|
||||
|
||||
world = ootworld.world
|
||||
player = ootworld.player
|
||||
|
||||
if ootworld.logic_rules != 'no_logic':
|
||||
if ootworld.triforce_hunt:
|
||||
world.completion_condition[player] = lambda state: state.has('Triforce Piece', player, ootworld.triforce_goal)
|
||||
else:
|
||||
world.completion_condition[player] = lambda state: state.has('Triforce', player)
|
||||
|
||||
# ganon can only carry triforce
|
||||
world.get_location('Ganon', player).item_rule = lambda item: item.name == 'Triforce'
|
||||
|
||||
# is_child = ootworld.parser.parse_rule('is_child')
|
||||
# guarantee_hint = ootworld.parser.parse_rule('guarantee_hint')
|
||||
|
||||
for location in ootworld.get_locations():
|
||||
if ootworld.shuffle_song_items == 'song':
|
||||
if location.type == 'Song':
|
||||
# must be a song, or there are songs in starting items; then it can be anything
|
||||
add_item_rule(location, lambda item:
|
||||
(ootworld.starting_songs and item.type != 'Song')
|
||||
or (item.type == 'Song' and item.player == location.player))
|
||||
else:
|
||||
add_item_rule(location, lambda item: item.type != 'Song')
|
||||
|
||||
if location.type == 'Shop':
|
||||
if location.name in ootworld.shop_prices:
|
||||
add_item_rule(location, lambda item: item.type != 'Shop')
|
||||
location.price = ootworld.shop_prices[location.name]
|
||||
add_rule(location, create_shop_rule(location, ootworld.parser))
|
||||
else:
|
||||
add_item_rule(location, lambda item: item.type == 'Shop' and item.player == location.player)
|
||||
elif 'Deku Scrub' in location.name:
|
||||
add_rule(location, create_shop_rule(location, ootworld.parser))
|
||||
else:
|
||||
add_item_rule(location, lambda item: item.type != 'Shop')
|
||||
|
||||
if ootworld.skip_child_zelda and location.name == 'Song from Impa':
|
||||
limit_to_itemset(location, SaveContext.giveable_items)
|
||||
add_item_rule(location, lambda item: item.player == location.player)
|
||||
|
||||
if location.name == 'Forest Temple MQ First Room Chest' and ootworld.shuffle_bosskeys == 'dungeon' and ootworld.shuffle_smallkeys == 'dungeon' and ootworld.tokensanity == 'off':
|
||||
# This location needs to be a small key. Make sure the boss key isn't placed here.
|
||||
forbid_item(location, 'Boss Key (Forest Temple)', ootworld.player)
|
||||
|
||||
# TODO: re-add hints once they are working
|
||||
# if location.type == 'HintStone' and ootworld.hints == 'mask':
|
||||
# location.add_rule(is_child)
|
||||
|
||||
# if location.name in ootworld.always_hints:
|
||||
# location.add_rule(guarantee_hint)
|
||||
|
||||
|
||||
def create_shop_rule(location, parser):
|
||||
def required_wallets(price):
|
||||
if price > 500:
|
||||
return 3
|
||||
if price > 200:
|
||||
return 2
|
||||
if price > 99:
|
||||
return 1
|
||||
return 0
|
||||
return parser.parse_rule('(Progressive_Wallet, %d)' % required_wallets(location.price))
|
||||
|
||||
|
||||
def limit_to_itemset(location, itemset):
|
||||
old_rule = location.item_rule
|
||||
location.item_rule = lambda item: item.name in itemset and old_rule(item)
|
||||
|
||||
|
||||
# This function should be run once after the shop items are placed in the world.
|
||||
# It should be run before other items are placed in the world so that logic has
|
||||
# the correct checks for them. This is safe to do since every shop is still
|
||||
# accessible when all items are obtained and every shop item is not.
|
||||
# This function should also be called when a world is copied if the original world
|
||||
# had called this function because the world.copy does not copy the rules
|
||||
def set_shop_rules(ootworld):
|
||||
found_bombchus = ootworld.parser.parse_rule('found_bombchus')
|
||||
wallet = ootworld.parser.parse_rule('Progressive_Wallet')
|
||||
wallet2 = ootworld.parser.parse_rule('(Progressive_Wallet, 2)')
|
||||
for location in ootworld.world.get_filled_locations():
|
||||
if location.player == ootworld.player and location.item.type == 'Shop':
|
||||
# Add wallet requirements
|
||||
if location.item.name in ['Buy Arrows (50)', 'Buy Fish', 'Buy Goron Tunic', 'Buy Bombchu (20)', 'Buy Bombs (30)']:
|
||||
add_rule(location, wallet)
|
||||
elif location.item.name in ['Buy Zora Tunic', 'Buy Blue Fire']:
|
||||
add_rule(location, wallet2)
|
||||
|
||||
# Add adult only checks
|
||||
if location.item.name in ['Buy Goron Tunic', 'Buy Zora Tunic']:
|
||||
is_adult = ootworld.parser.parse_rule('is_adult', location)
|
||||
add_rule(location, is_adult)
|
||||
|
||||
# Add item prerequisite checks
|
||||
if location.item.name in ['Buy Blue Fire',
|
||||
'Buy Blue Potion',
|
||||
'Buy Bottle Bug',
|
||||
'Buy Fish',
|
||||
'Buy Green Potion',
|
||||
'Buy Poe',
|
||||
'Buy Red Potion [30]',
|
||||
'Buy Red Potion [40]',
|
||||
'Buy Red Potion [50]',
|
||||
'Buy Fairy\'s Spirit']:
|
||||
add_rule(location, lambda state: CollectionState._oot_has_bottle(state, ootworld.player))
|
||||
if location.item.name in ['Buy Bombchu (10)', 'Buy Bombchu (20)', 'Buy Bombchu (5)']:
|
||||
add_rule(location, found_bombchus)
|
||||
|
||||
|
||||
# This function should be ran once after setting up entrances and before placing items
|
||||
# The goal is to automatically set item rules based on age requirements in case entrances were shuffled
|
||||
def set_entrances_based_rules(ootworld):
|
||||
|
||||
if ootworld.world.accessibility == 'beatable':
|
||||
return
|
||||
|
||||
all_state = ootworld.state_with_items(ootworld.itempool)
|
||||
|
||||
for location in ootworld.get_locations():
|
||||
# If a shop is not reachable as adult, it can't have Goron Tunic or Zora Tunic as child can't buy these
|
||||
if location.type == 'Shop' and not all_state._oot_reach_as_age(location.parent_region.name, 'adult', ootworld.player):
|
||||
forbid_item(location, 'Buy Goron Tunic', ootworld.player)
|
||||
forbid_item(location, 'Buy Zora Tunic', ootworld.player)
|
||||
|
||||
Reference in New Issue
Block a user