Merge pull request ArchipelagoMW#1 from doshyw/doshyw/add-extra-completion-conditions

Added extra completion conditions and fixed bugs

Author: doshyw

worlds/celeste/__init__.py

@@ -1,5 +1,6 @@
 # pylint: disable=missing-class-docstring, missing-module-docstring, fixme
 from copy import deepcopy
+from typing import List
 
 from BaseClasses import Item, ItemClassification, MultiWorld, Tutorial
 from worlds.AutoWorld import WebWorld, World
@@ -10,7 +11,7 @@
     CelesteItemType,
     CelesteLocationFactory,
 )
-from .options import celeste_options, get_option_value
+from .options import VictoryConditionEnum, celeste_options, get_option_value
 from .regions import CelesteRegionFactory
 
 
@@ -39,19 +40,36 @@ class CelesteWorld(World):
     topology_present = True
     web = CelesteWebWorld()
 
+    victory_condition: VictoryConditionEnum
+    completion_level: int
+
     item_factory: CelesteItemFactory
     location_factory: CelesteLocationFactory
     region_factory: CelesteRegionFactory
 
     item_name_to_id = CelesteItemFactory.get_name_to_id()
     location_name_to_id = CelesteLocationFactory.get_name_to_id()
 
+    required_client_version = (0, 4, 3)
+
     def __init__(self, multiworld: MultiWorld, player: int):
         super().__init__(multiworld, player)
+        self.completion_level = 10
         self.item_factory = CelesteItemFactory(self)
         self.location_factory = CelesteLocationFactory()
         self.region_factory = CelesteRegionFactory()
 
+    def generate_early(self) -> None:
+        self.victory_condition = VictoryConditionEnum(
+            get_option_value(self.multiworld, self.player, "victory_condition")
+        )
+        if self.victory_condition == VictoryConditionEnum.CHAPTER_9_FAREWELL:
+            self.completion_level = 10
+        elif self.victory_condition == VictoryConditionEnum.CHAPTER_8_CORE:
+            self.completion_level = 9
+        elif self.victory_condition == VictoryConditionEnum.CHAPTER_7_SUMMIT:
+            self.completion_level = 7
+
     def create_item(self, name: str) -> Item:
         return self.item_factory.create_item(name)
 
@@ -62,6 +80,10 @@ def create_items(self):
         item_table = self.item_factory.get_table(self)
 
         for item in item_table:
+            if item.level > self.completion_level:
+                continue
+            if item.level == self.completion_level and item.side == 0 and item.item_type == CelesteItemType.COMPLETION:
+                continue
             self.multiworld.itempool.append(deepcopy(item))
 
         self.item_name_groups = {
@@ -72,10 +94,17 @@ def create_items(self):
         }
 
     def generate_basic(self) -> None:
-        self.multiworld.get_location("Level 10 A-Side Complete", self.player).place_locked_item(
-            CelesteItem("Victory", ItemClassification.progression, None, self.player, CelesteItemType.COMPLETION, 10, 0)
+        self.multiworld.completion_condition[self.player] = lambda state: state.has(
+            f"Level {self.completion_level} A-Side Complete", self.player
         )
-        self.multiworld.completion_condition[self.player] = lambda state: state.has("Victory", self.player)
+
+    def pre_fill(self):
+        item_table = self.item_factory.get_table(self)
+        for item in item_table:
+            if item.level > self.completion_level or (
+                item.level == self.completion_level and item.side == 0 and item.item_type == CelesteItemType.COMPLETION
+            ):
+                self.multiworld.get_location(item.name, self.player).place_locked_item(deepcopy(item))
 
     def fill_slot_data(self):
         slot_data = {}

worlds/celeste/docs/en_Celeste.md

@@ -35,22 +35,17 @@ greyed out cannot be pressed, blocking access to Chapters/Sides that are not yet
 
 ## What is the goal for a Celeste world?
 
-At the moment, the only available goal for a Celeste world is to complete "Chapter 10: Farewell". This is done by
-receiving one of the three `Level 9 X-Side Completion` items from the multi-world, and then accessing and playing
-through Chapter 10.
+The following goals can be selected for a Celeste world:
+- Completing "Chapter 7: The Summit" A-Side.
+- Completing "Chapter 8: Core" A-Side.
+- Completing "Chapter 9: Farewell" A-Side.
 
 There is a set of options that allow you to configure how many items of different types need to have been collected
-prior to passing through the Crystal Heart Gate in Chapter 10. It defaults to matching the original story progression
-(i.e., requiring 15 different Crystal Hearts and nothing else), but can be modified to make it either easier or harder
-to pass through the gate. The required number of Cassettes, Crystal Hearts, Level Completions, and Strawberries can all
-be configured.
+prior to accessing the goal level. The required number of Cassettes, Crystal Hearts, Level Completions, and Strawberries can all be configured.
 
 The following goals are currently being planned for addition:
-- Completing "Chapter 7: The Summit" A-Side.
-- Completing "Chapter 8: Core" A-Side.
 - Completing some set of Sides (e.g., all A-Sides, all A and B-Sides, etc) for all Chapters in-game.
 
-
 The following configuration options are also being planned:
 - Toggle for whether the end-game item checks are based on receiving items from the multi-world or completing location
 checks.

worlds/celeste/items.py

@@ -6,7 +6,7 @@
 from pathlib import Path
 from typing import Any, Dict, List, Optional
 
-from BaseClasses import Item, ItemClassification, Location, LocationProgressType, Region
+from BaseClasses import Item, ItemClassification, Location, Region
 from worlds.AutoWorld import World
 
 from .options import get_option_value
@@ -91,17 +91,15 @@ def __init__(
 
     @staticmethod
     def create_from_pandas(world: World, row: Dict[str, Any]) -> "CelesteLocation":
-        code = row["id"] if row["level"] < 10 else None
-        location = CelesteLocation(world.player, row["level"], row["side"], f"{row['name']}", code)
+        location = CelesteLocation(world.player, row["level"], row["side"], f"{row['name']}", row["id"])
         if location.level == 9:
             if location.side == 0:
                 location.access_rule = lambda state: state.has_group("gemhearts", world.player, 4)
             elif location.side == 1:
                 location.access_rule = lambda state: state.has_group("gemhearts", world.player, 15)
             elif location.side == 2:
                 location.access_rule = lambda state: state.has_group("gemhearts", world.player, 23)
-        if location.level == 10:
-            location.progress_type = LocationProgressType.EXCLUDED
+        if location.level == world.completion_level:
             location.access_rule = (
                 lambda state: state.has_group(
                     "gemhearts", world.player, get_option_value(world.multiworld, world.player, "hearts_required")
@@ -132,15 +130,15 @@ def __init__(self, world: World):
     def _load_table(self, world: World, force: bool = False) -> None:
         if force or not self._loaded or self._world != world:
             json_rows = get_json_data(PATH_ITEMS)
-            self._table = [CelesteItem.create_from_pandas(world, row) for row in json_rows if row["level"] < 10]
+            self._table = [CelesteItem.create_from_pandas(world, row) for row in json_rows]
             self._map = {item.name: item for item in self._table}
             self._world = world
             self._loaded = True
 
     @staticmethod
     def get_name_to_id() -> Dict[str, int]:
         json_rows = get_json_data(PATH_ITEMS)
-        return {f"{row['name']}": row["id"] for row in json_rows if row["level"] < 10}
+        return {f"{row['name']}": row["id"] for row in json_rows}
 
     def create_item(self, item: str) -> CelesteItem:
         self._load_table(self._world)

worlds/celeste/options.py

@@ -1,13 +1,14 @@
 # pylint: disable=missing-class-docstring, missing-module-docstring, fixme, unused-import
 
+from enum import Enum
 from typing import Dict, Union
 
 from BaseClasses import MultiWorld
-from Options import DefaultOnToggle, Range, Toggle
+from Options import Choice, DefaultOnToggle, Range, Toggle
 
 
 class BerriesRequired(Range):
-    """Number of Strawberries required to pass through the Crystal Heart Gate in Chapter 9: Farewell."""
+    """Number of Strawberries required to access the goal level."""
 
     display_name = "Strawberry Requirement"
     range_start = 0
@@ -16,7 +17,7 @@ class BerriesRequired(Range):
 
 
 class CassettesRequired(Range):
-    """Number of Cassettes required to pass through the Crystal Heart Gate in Chapter 9: Farewell."""
+    """Number of Cassettes required to access the goal level."""
 
     display_name = "Cassette Requirement"
     range_start = 0
@@ -25,28 +26,45 @@ class CassettesRequired(Range):
 
 
 class HeartsRequired(Range):
-    """Number of Crystal Hearts required to pass through the Crystal Heart Gate in Chapter 9: Farewell."""
+    """Number of Crystal Hearts required to access the goal level."""
 
     display_name = "Crystal Heart Requirement"
     range_start = 0
     range_end = 24
-    default = 15
+    default = 0
 
 
 class LevelsRequired(Range):
-    """Number of Level Completions required to pass through the Crystal Heart Gate in Chapter 9: Farewell."""
+    """Number of Level Completions required to access the goal level."""
 
     display_name = "Level Completion Requirement"
     range_start = 0
     range_end = 24
     default = 0
 
 
+class VictoryConditionEnum(Enum):
+    CHAPTER_7_SUMMIT = 0
+    CHAPTER_8_CORE = 1
+    CHAPTER_9_FAREWELL = 2
+
+
+class VictoryCondition(Choice):
+    """Selects the Chapter whose Completion is the Victory Condition for the World."""
+
+    display_name = "Victory Condition"
+    option_chapter_7_summit = VictoryConditionEnum.CHAPTER_7_SUMMIT.value
+    option_chapter_8_core = VictoryConditionEnum.CHAPTER_8_CORE.value
+    option_chapter_9_farewell = VictoryConditionEnum.CHAPTER_9_FAREWELL.value
+    default = VictoryConditionEnum.CHAPTER_7_SUMMIT.value
+
+
 celeste_options: Dict[str, type] = {
     "berries_required": BerriesRequired,
     "cassettes_required": CassettesRequired,
     "hearts_required": HeartsRequired,
     "levels_required": LevelsRequired,
+    "victory_condition": VictoryCondition,
 }