gameboy_worlds.emulation.deja_vu.registry

  1from typing import Optional, Union, Type, Dict
  2from gameboy_worlds.emulation.parser import StateParser
  3from gameboy_worlds.emulation.tracker import StateTracker
  4from gameboy_worlds.emulation.emulator import Emulator
  5from gameboy_worlds.emulation.deja_vu.emulators import DejaVuEmulator
  6from gameboy_worlds.emulation.deja_vu.parsers import DejaVu1StateParser, DejaVu2StateParser
  7from gameboy_worlds.emulation.deja_vu.trackers import *
  8# deja_vu_1 trackers
  9# from gameboy_worlds.emulation.deja_vu.trackers import (
 10#     DejaVu1CheckDeadManTestTracker,
 11#     DejaVu1CheckGunTestTracker,
 12#     DejaVu1CheckNote2TestTracker,
 13#     DejaVu1CheckMapTestTracker,
 14#     DejaVu1CheckPhotoTestTracker,
 15#     DejaVu1CheckSnapshotTestTracker,
 16#     DejaVu1CloseDoorTestTracker,
 17#     DejaVu1CloseElevatorDoorTestTracker,
 18#     DejaVu1ClosePocketTestTracker,
 19#     DejaVu1CloseWalletTestTracker,
 20#     DejaVu1CoatTestTracker,
 21#     DejaVu1EnterCellarTestTracker,
 22#     DejaVu1EnterConnectingRoomTestTracker,
 23#     DejaVu1EnterElevatorTestTracker,
 24#     DejaVu1EnterEmptyRoomFromMapTestTracker,
 25#     DejaVu1EnterShermanTestTracker,
 26#     DejaVu1EnterTaxiTestTracker,
 27#     DejaVu1EnterWestendTestTracker,
 28#     DejaVu1ExitGrimyOfficeTestTracker,
 29#     DejaVu1GoNewsstandTestTracker,
 30#     DejaVu1GotoApartmentTestTracker,
 31#     DejaVu1GotoOfficeTestTracker,
 32#     DejaVu1GotoWestendTestTracker,
 33#     DejaVu1HitBottleTestTracker,
 34#     DejaVu1HitMuggerTestTracker,
 35#     DejaVu1MakeMedicineTestTracker,
 36#     DejaVu1MeetMuggerTestTracker,
 37#     DejaVu1OpenCabinetTestTracker,
 38#     DejaVu1OpenCarTrunkTestTracker,
 39#     DejaVu1OpenDeskTestTracker,
 40#     DejaVu1OpenDiaryTestTracker,
 41#     DejaVu1OpenDoorTestTracker,
 42#     DejaVu1OpenElevatorDoorTestTracker,
 43#     DejaVu1OpenPocketTestTracker,
 44#     DejaVu1OpenSpigotTestTracker,
 45#     DejaVu1OpenWallSafeTestTracker,
 46#     DejaVu1OpenWalletTestTracker,
 47#     DejaVu1PayTaxiTestTracker,
 48#     DejaVu1ShootDoorTestTracker,
 49#     DejaVu1ShootGrimyOfficeDoorTestTracker,
 50#     DejaVu1ShootLockTestTracker,
 51#     DejaVu1TakeGunTestTracker,
 52#     DejaVu1CheckCoatTestTracker,
 53#     DejaVu1TakeMedicineTestTracker,
 54#     DejaVu1TalkToTaxiDriverTestTracker,
 55#     DejaVu1UnlockCarDoorTestTracker,
 56#     DejaVu1UnlockFrontDoorTestTracker,
 57#     DejaVu1CloseDashbrdTestTracker,
 58#     DejaVu1OpenDashbrdTestTracker,
 59#     DejaVu1UnlockOfficeDoorTestTracker,
 60# )
 61# # deja_vu_2 trackers
 62# from gameboy_worlds.emulation.deja_vu.trackers import (
 63#     DejaVu2Buy2ChipsTestTracker,
 64#     DejaVu2CheckNewsclip1TestTracker,
 65#     DejaVu2CloseDoorFromMapTestTracker,
 66#     DejaVu2ClosePantsPocketTestTracker,
 67#     DejaVu2CloseWallet1TestTracker,
 68#     DejaVu2EnterHallwayTestTracker,
 69#     DejaVu2OpenBathroomDoorTestTracker,
 70#     DejaVu2OpenDoorFromMapTestTracker,
 71#     DejaVu2OpenPantsPocketTestTracker,
 72#     DejaVu2OpenTrenchCoatTestTracker,
 73#     DejaVu2OpenWallet1TestTracker,
 74#     DejaVu2PutOnPantsTestTracker,
 75#     DejaVu2PutOnTrenchCoatTestTracker,
 76#     DejaVu2TakeGumTestTracker,
 77#     DejaVu2TakeLicense1TestTracker,
 78#     DejaVu2TakeNewsclip1TestTracker,
 79#     DejaVu2TakePantsTestTracker,
 80#     DejaVu2ReturnToCashierTestTracker,
 81#     DejaVu2CashOutTestTracker,
 82#     DejaVu2ExitCasinoTestTracker,
 83#     DejaVu2OpenLobbyDoorTestTracker,
 84#     DejaVu2TalkInTrainStationTestTracker,
 85#     DejaVu2VisitCounterTestTracker,
 86#     DejaVu2CheckTimetableTestTracker,
 87#     DejaVu2TakePamphletTestTracker,
 88#     DejaVu2EnterPlatformTestTracker,
 89#     DejaVu2EnterTrainTestTracker,
 90#     DejaVu2BuyTicketTestTracker,
 91#     DejaVu2CheckGirlTestTracker,
 92#     DejaVu2CheckSignTestTracker,
 93#     DejaVu2BuyNewspaperTestTracker,
 94#     DejaVu2ChatSellerTestTracker,
 95#     DejaVu2TakeNewsclip4TestTracker,
 96#     DejaVu2ChatTaxiDriverTestTracker,
 97#     DejaVu2EnterChicagoTaxiTestTracker,
 98#     DejaVu2EnterMiddleRoomTestTracker,
 99#     DejaVu2HitBoardTestTracker,
100#     DejaVu2LoadGunTestTracker,
101#     DejaVu2OpenBoxTestTracker,
102#     DejaVu2OpenDoorByKnifeTestTracker,
103#     DejaVu2OpenLockTestTracker,
104#     DejaVu2OpenPocketKnifeTestTracker,
105#     DejaVu2OpenTelephoneTestTracker,
106# )
107from gameboy_worlds.emulation.deja_vu.trackers import  DejaVuOCRTracker
108GAME_TO_GB_NAME = {
109    "deja_vu_1": "DejaVu.gbc",
110    "deja_vu_2": "DejaVu.gbc",
111}
112""" Expected save name for each game. Save the file to <storage_dir_from_config_file>/<game_name>_rom_data/<gb_name>"""
113
114STRONGEST_PARSERS: Dict[str, Type[StateParser]] = {
115    "deja_vu_1": DejaVu1StateParser,
116    "deja_vu_2": DejaVu2StateParser,
117}
118""" Mapping of game names to their corresponding strongest StateParser classes. 
119Unless you have a very good reason, you should always use the STRONGEST possible parser for a given game. 
120The parser itself does not affect performance, as for it to perform a read / screen comparison operation , it must be called upon by the state tracker.
121This means there is never a reason to use a weaker parser. 
122"""
123
124
125AVAILABLE_STATE_TRACKERS: Dict[str, Dict[str, Type[StateTracker]]] = {
126    "deja_vu_1": {
127        "default": DejaVuOCRTracker,
128        "take_coat_test": DejaVu1CoatTestTracker,
129        "take_gun_test": DejaVu1TakeGunTestTracker,
130        "open_door_test": DejaVu1OpenDoorTestTracker,
131        "close_door_test": DejaVu1CloseDoorTestTracker,
132        "open_pocket_test": DejaVu1OpenPocketTestTracker,
133        "open_wallet_test": DejaVu1OpenWalletTestTracker,
134        "close_pocket_test": DejaVu1ClosePocketTestTracker,
135        "close_wallet_test": DejaVu1CloseWalletTestTracker,
136        "check_coat_test": DejaVu1CheckCoatTestTracker,
137        "check_gun_test": DejaVu1CheckGunTestTracker,
138        "hit_bottle_test": DejaVu1HitBottleTestTracker,
139        "open_spigot_test": DejaVu1OpenSpigotTestTracker,
140        "enter_cellar_test": DejaVu1EnterCellarTestTracker,
141        "enter_connecting_room_test": DejaVu1EnterConnectingRoomTestTracker,
142        # "make_bet_test": DejaVu1MakeBetTestTracker,
143        "enter_empty_room_from_map_test": DejaVu1EnterEmptyRoomFromMapTestTracker,
144        "unlock_front_door_test": DejaVu1UnlockFrontDoorTestTracker,
145        "meet_mugger_test": DejaVu1MeetMuggerTestTracker,
146        "hit_mugger_test": DejaVu1HitMuggerTestTracker,
147        "unlock_car_door_test": DejaVu1UnlockCarDoorTestTracker,
148        "open_dashbrd_test": DejaVu1OpenDashbrdTestTracker,
149        "close_dashbrd_test": DejaVu1CloseDashbrdTestTracker,
150        "check_note2_test": DejaVu1CheckNote2TestTracker,
151        "check_map_test": DejaVu1CheckMapTestTracker,
152        "check_snapshot_test": DejaVu1CheckSnapshotTestTracker,
153        "go_newsstand_test": DejaVu1GoNewsstandTestTracker,
154        "enter_taxi_test": DejaVu1EnterTaxiTestTracker,
155        "talk_to_taxi_driver_test": DejaVu1TalkToTaxiDriverTestTracker,
156        "goto_westend_test": DejaVu1GotoWestendTestTracker,
157        "pay_taxi_test": DejaVu1PayTaxiTestTracker,
158        "goto_apartment_test": DejaVu1GotoApartmentTestTracker,
159        "enter_westend_test": DejaVu1EnterWestendTestTracker,
160        "open_elevator_door_test": DejaVu1OpenElevatorDoorTestTracker,
161        "enter_elevator_test": DejaVu1EnterElevatorTestTracker,
162        "close_elevator_door_test": DejaVu1CloseElevatorDoorTestTracker,
163        "check_photo_test": DejaVu1CheckPhotoTestTracker,
164        "shoot_door_test": DejaVu1ShootDoorTestTracker,
165        "open_desk_test": DejaVu1OpenDeskTestTracker,
166        "enter_sherman_test": DejaVu1EnterShermanTestTracker,
167        "goto_office_test": DejaVu1GotoOfficeTestTracker,
168        "unlock_office_door_test": DejaVu1UnlockOfficeDoorTestTracker,
169        "make_medicine_test": DejaVu1MakeMedicineTestTracker,
170        "take_medicine_test": DejaVu1TakeMedicineTestTracker,
171        "shoot_lock_test": DejaVu1ShootLockTestTracker,
172        "open_diary_test": DejaVu1OpenDiaryTestTracker,
173        "shoot_grimy_office_door_test": DejaVu1ShootGrimyOfficeDoorTestTracker,
174        "check_dead_man_test": DejaVu1CheckDeadManTestTracker,
175        "open_cabinet_test": DejaVu1OpenCabinetTestTracker,
176        "exit_grimy_office_test": DejaVu1ExitGrimyOfficeTestTracker,
177        "open_wall_safe_test": DejaVu1OpenWallSafeTestTracker,
178        "open_car_trunk_test": DejaVu1OpenCarTrunkTestTracker,
179    },
180    "deja_vu_2": {
181        "default": DejaVuOCRTracker,
182        "open_trench_coat_pocket_test": DejaVu2OpenTrenchCoatTestTracker,
183        "open_bathroom_door_test": DejaVu2OpenBathroomDoorTestTracker,
184        "take_gum_test": DejaVu2TakeGumTestTracker,
185        "open_pants_pocket_test": DejaVu2OpenPantsPocketTestTracker,
186        "close_pants_pocket_test": DejaVu2ClosePantsPocketTestTracker,
187        "take_pants_test": DejaVu2TakePantsTestTracker,
188        "put_on_trench_coat_test": DejaVu2PutOnTrenchCoatTestTracker,
189        "put_on_pants_test": DejaVu2PutOnPantsTestTracker,
190        "open_wallet1_test": DejaVu2OpenWallet1TestTracker,
191        "take_newsclip1_test": DejaVu2TakeNewsclip1TestTracker,
192        "take_license1_test": DejaVu2TakeLicense1TestTracker,
193        "close_wallet1_test": DejaVu2CloseWallet1TestTracker,
194        # "open_cold_tap_test": DejaVu2OpenColdTapTestTracker,
195        # "close_cold_tap_test": DejaVu2CloseColdTapTestTracker,
196        "check_newsclip1_test": DejaVu2CheckNewsclip1TestTracker,
197        "take_ring1_test": DejaVu2TakeRing1TestTracker,
198        "open_door_from_map_test": DejaVu2OpenDoorFromMapTestTracker,
199        "close_door_from_map_test": DejaVu2CloseDoorFromMapTestTracker,
200        "enter_hallway_test": DejaVu2EnterHallwayTestTracker,
201        "buy_2_chips_test": DejaVu2Buy2ChipsTestTracker,
202        "return_cashier_test": DejaVu2ReturnToCashierTestTracker,
203        "cash_out_test": DejaVu2CashOutTestTracker,
204        "open_lobby_door_test": DejaVu2OpenLobbyDoorTestTracker,
205        "exit_casino_test": DejaVu2ExitCasinoTestTracker,
206        "talk_in_train_station_test": DejaVu2TalkInTrainStationTestTracker,
207        "visit_counter_test": DejaVu2VisitCounterTestTracker,
208        # "take_pamphlet_test": DejaVu2TakePamphletTestTracker,
209        "check_timetable_test": DejaVu2CheckTimetableTestTracker,
210        "enter_platform_track6_test": DejaVu2EnterPlatformTestTracker,
211        "enter_train_test": DejaVu2EnterTrainTestTracker,
212        "buy_ticket_test": DejaVu2BuyTicketTestTracker,
213        "check_girl_test": DejaVu2CheckGirlTestTracker,
214        "check_sign_test": DejaVu2CheckSignTestTracker,
215        "chat_seller_test": DejaVu2ChatSellerTestTracker,
216        "buy_newspaper_test": DejaVu2BuyNewspaperTestTracker,
217        "take_newsclip4_test": DejaVu2TakeNewsclip4TestTracker,
218        "enter_chicago_taxi_test": DejaVu2EnterChicagoTaxiTestTracker,
219        "chat_taxi_driver_test": DejaVu2ChatTaxiDriverTestTracker,
220        "enter_middle_room_test": DejaVu2EnterMiddleRoomTestTracker,
221        "load_gun_test": DejaVu2LoadGunTestTracker,
222        "open_lock_test": DejaVu2OpenLockTestTracker,
223        "hit_board_test": DejaVu2HitBoardTestTracker,
224        "open_telephone_test": DejaVu2OpenTelephoneTestTracker,
225        "open_box_test": DejaVu2OpenBoxTestTracker,
226        "open_pocket_knife_test": DejaVu2OpenPocketKnifeTestTracker,
227        "open_door_by_knife": DejaVu2OpenDoorByKnifeTestTracker,
228        "put_on_flashlight_test": DejaVu2PutOnFlashlightTestTracker,
229        "enter_joe_place_test": DejaVu2EnterJoePlaceTestTracker,
230        "open_slot_lock_test": DejaVu2OpenSlotLockTestTracker,
231        "turn_off_flashlight_test": DejaVu2TurnOffFlashlightTestTracker,
232        "get_location_from_card_test": DejaVu2GetLocationFromCardTestTracker,
233        "open_bag_with_knife_test": DejaVu2OpenBagWithKnifeTestTracker,
234        "ask_about_nametag2_test": DejaVu2AskAboutNametag2TestTracker,
235    },
236}
237""" Mapping of game names to their available StateTracker classes with string identifiers. """
238
239
240AVAILABLE_EMULATORS: Dict[str, Dict[str, Type[Emulator]]] = {
241    "deja_vu_1": {
242        "default": DejaVuEmulator,
243    },
244    "deja_vu_2": {
245        "default": DejaVuEmulator,
246    },
247}
248""" Mapping of game names to their available Emulator classes with string identifiers. """