""" Archipelago init file for Lingo 2 """ from typing import ClassVar from BaseClasses import ItemClassification, Item, Tutorial from settings import Group, UserFilePath from worlds.AutoWorld import WebWorld, World from .items import Lingo2Item, ANTI_COLLECTABLE_TRAPS from .options import Lingo2Options from .player_logic import Lingo2PlayerLogic from .regions import create_regions, shuffle_entrances, connect_ports_from_ut from .static_logic import Lingo2StaticLogic from .version import APWORLD_VERSION from ..LauncherComponents import Component, Type, components, launch as launch_component, icon_paths class Lingo2WebWorld(WebWorld): rich_text_options_doc = True theme = "grass" tutorials = [Tutorial( "Multiworld Setup Guide", "A guide to playing Lingo 2 with Archipelago.", "English", "en_Lingo_2.md", "setup/en", ["hatkirby"] )] class Lingo2Settings(Group): class ExecutableFile(UserFilePath): """Path to the Lingo 2 executable""" is_exe = True exe_file: ExecutableFile = ExecutableFile() class Lingo2World(World): """ Lingo 2 is a first person indie puzzle game where you solve word puzzles in a labyrinthe world. Compared to its predecessor, Lingo 2 has new mechanics, more areas, and a unique progression system where you have to unlock letters before using them in puzzle solutions. """ game = "Lingo 2" web = Lingo2WebWorld() settings: ClassVar[Lingo2Settings] settings_key = "lingo2_options" topology_present = True options_dataclass = Lingo2Options options: Lingo2Options static_logic = Lingo2StaticLogic() item_name_to_id = static_logic.item_name_to_id location_name_to_id = static_logic.location_name_to_id item_name_groups = static_logic.item_name_groups location_name_groups = static_logic.location_name_groups for_tracker: ClassVar[bool] = False player_logic: Lingo2PlayerLogic port_pairings: dict[int, int] def generate_early(self): self.player_logic = Lingo2PlayerLogic(self) self.port_pairings = {} def create_regions(self): create_regions(self) def connect_entrances(self): if self.options.shuffle_worldports: if hasattr(self.multiworld, "re_gen_passthrough") and "Lingo 2" in self.multiworld.re_gen_passthrough: slot_value = self.multiworld.re_gen_passthrough["Lingo 2"]["port_pairings"] self.port_pairings = {int(fp): int(tp) for fp, tp in slot_value.items()} connect_ports_from_ut(self.port_pairings, self) else: shuffle_entrances(self) from Utils import visualize_regions visualize_regions(self.multiworld.get_region("Menu", self.player), "my_world.puml") def create_items(self): pool = [self.create_item(name) for name in self.player_logic.real_items] total_locations = sum(len(locs) for locs in self.player_logic.locations_by_room.values()) item_difference = total_locations - len(pool) if self.options.trap_percentage > 0: num_traps = int(item_difference * self.options.trap_percentage / 100) item_difference = item_difference - num_traps trap_names = [] trap_weights = [] for letter_name, weight in self.static_logic.letter_weights.items(): trap_names.append(f"Anti {letter_name}") trap_weights.append(weight) bad_letters = self.random.choices(trap_names, weights=trap_weights, k=num_traps) pool += [self.create_item(trap_name) for trap_name in bad_letters] for i in range(0, item_difference): pool.append(self.create_item(self.get_filler_item_name())) self.multiworld.itempool += pool def create_item(self, name: str) -> Item: return Lingo2Item(name, ItemClassification.filler if name == self.get_filler_item_name() else ItemClassification.trap if name in ANTI_COLLECTABLE_TRAPS else ItemClassification.progression, self.item_name_to_id.get(name), self.player) def set_rules(self): self.multiworld.completion_condition[self.player] = lambda state: state.has("Victory", self.player) def fill_slot_data(self): slot_options = [ "cyan_door_behavior", "daedalus_roof_access", "keyholder_sanity", "shuffle_control_center_colors", "shuffle_doors", "shuffle_gallery_paintings", "shuffle_letters", "shuffle_symbols", "shuffle_worldports", "strict_cyan_ending", "strict_purple_ending", "victory_condition", ] slot_data: dict[str, object] = { **self.options.as_dict(*slot_options), "version": [self.static_logic.get_data_version(), APWORLD_VERSION], } if self.options.shuffle_worldports: slot_data["port_pairings"] = self.port_pairings return slot_data def get_filler_item_name(self) -> str: return "A Job Well Done" # for the universal tracker, doesn't get called in standard gen # docs: https://github.com/FarisTheAncient/Archipelago/blob/tracker/worlds/tracker/docs/re-gen-passthrough.md @staticmethod def interpret_slot_data(slot_data: dict[str, object]) -> dict[str, object]: # returning slot_data so it regens, giving it back in multiworld.re_gen_passthrough # we are using re_gen_passthrough over modifying the world here due to complexities with ER return slot_data def launch_client(*args): from .context import client_main launch_component(client_main, name="Lingo2Client", args=args) icon_paths["lingo2_ico"] = f"ap:{__name__}/logo.png" component = Component("Lingo 2 Client", component_type=Type.CLIENT, func=launch_client, description="Open Lingo 2.", supports_uri=True, game_name="Lingo 2", icon="lingo2_ico") components.append(component) 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421