Merge pull request #1 from neocerber/feature-addSpiritSelection

Ender lilies: Feature add spirit selection

Author: Trexounay

worlds/enderlilies/Options.py

@@ -0,0 +1,60 @@
+from typing import Dict, FrozenSet, Union
+from Options import Choice, Option, Toggle
+from BaseClasses import MultiWorld
+
+
+class ShuffleSlots(Toggle):
+    display_name = "Shuffle Slots"
+
+class ShuffleBGM(Toggle):
+    display_name = "Shuffle Background Music"
+
+class ShuffleEnemies(Toggle):
+    display_name = "Shuffle Enemies"
+
+class NewGamePlus(Toggle):
+    display_name = "New Game Plus"
+
+class ForceAncientSouls(Toggle):
+    display_name = "Ancient Souls on starting spirit"
+
+class MiniBossIncrementsChapter(Toggle):
+    display_name = "Sub Spirits Increment Chapter"
+
+class ShuffleUpgrades(Toggle):
+    display_name = "Shuffle Upgrades"
+
+class StartingSpirit(Choice):
+    """Defines which spirit you might start with. The starting spirit has infinite usage. Default option is Umbral Knight.
+
+    Vanilla: Umbral knight.
+    Main: One of the main spirit (Gerrod, Silva, Julius, Ulv, Eleine, Hoenir, Faden, Siegrid
+    Any: Any of the spirits.
+    None: You will receive an item at the start but it can from any world.
+        Warning: the logic currently assumes that you start with a spirit. It might make a world impossible. """
+    display_name = "Starting spirits"
+    option_vanilla = 0
+    option_main = 1
+    option_any = 2
+    default = option_vanilla
+
+el_options: Dict[str, type(Option)] = {
+    # # Not added since not sure if the client can read it right now.
+    # "shuffle_slots": ShuffleSlots,
+    # "shuffle_bgm": ShuffleBGM,
+    # "shuffle_enemies": ShuffleEnemies,
+    # "new_game_plus": NewGamePlus,
+    # "force_ancient_souls": ForceAncientSouls,
+    # "mini_boss_incrememnts_chapter": MiniBossIncrementsChapter,
+    # "shuffle_upgrades": ShuffleUpgrades,
+    "starting_spirit": StartingSpirit,
+}
+
+
+def get_option_value(multiworld: MultiWorld, player: int, name: str) -> Union[int,  FrozenSet]:
+    if multiworld is None:
+        return el_options[name].default
+
+    player_option = getattr(multiworld, name)[player]
+
+    return player_option.value

worlds/enderlilies/Rules.py

@@ -777,7 +777,6 @@ def get_rules(p : int) -> Tuple[Dict[str, CollectionRule], Dict[str, ItemRule]]:
 	}
 
 	items_rules : Dict[str, ItemRule] = {
-		'starting_weapon' : lambda item : item.player == p and item.name.startswith('Spirit.'),
 	}
 
 	return (locations_rules, items_rules)

worlds/enderlilies/__init__.py

@@ -2,14 +2,15 @@
 import os
 
 from worlds.AutoWorld import World
-from BaseClasses import ItemClassification, Region, Item, Location
+from BaseClasses import ItemClassification, Region, Item, Location, MultiWorld
 from worlds.generic.Rules import set_rule, add_item_rule
-from typing import Any, Dict
+from typing import Any, Dict, List
 
 from .Items import items
 from .Locations import locations
 from .Rules import get_rules
 from .Names import names as el
+from .Options import el_options, get_option_value
 
 ENDERLILIES = "Ender Lilies"
 
@@ -24,6 +25,7 @@ class EnderLiliesWorld(World):
     Ender Lilies: QUIETUS OF THE KNIGHTS
     """
     game                = ENDERLILIES
+    option_definitions = el_options
     location_name_to_id = { name: data.address for name, data in locations.items() }
     item_name_to_id     = { name: data.code for name, data in items.items() }
 
@@ -34,9 +36,12 @@ def create_item(self, item: str) -> EnderLiliesItem:
             return EnderLiliesItem(item, ItemClassification.progression, None, self.player)
 
     def create_items(self) -> None:
+        starting_item = assign_starting_item(self.multiworld, self.player, items)
+
         for item, data in items.items():
-            for i in range(data.count):
-                self.multiworld.itempool.append(self.create_item(item))
+            if item != starting_item:
+                for i in range(data.count):
+                    self.multiworld.itempool.append(self.create_item(item))
 
     def create_regions(self) -> None:
         regions = {
@@ -90,3 +95,27 @@ def fill_slot_data(self) -> Dict[str, Any]:
                 else:
                     slot_data[location.name] = f"AP.{location.address}"
         return slot_data
+
+def assign_starting_item(multiworld: MultiWorld, player: int, items) -> str:
+    non_local_items = multiworld.non_local_items[player].value
+
+    val = get_option_value(multiworld, player, "starting_spirit")
+    if val == 0: 
+        spirit_list = ['Spirit.s5000']
+    elif val == 1: 
+        spirit_list = [x for x in list(items.keys()) if x.startswith('Spirit.s5')]
+    elif val == 2: 
+        spirit_list = [x for x in list(items.keys()) if x.startswith('Spirit.s')]
+
+    avail_spirit = sorted(item for item in spirit_list if item not in non_local_items)
+    if not avail_spirit:
+        raise Exception("At least one spirit must be local")
+
+    spirit_name = multiworld.random.choice(avail_spirit)
+
+    item = EnderLiliesItem(spirit_name, items[spirit_name].classification, 
+                           items[spirit_name].code, player)
+
+    multiworld.get_location('starting_weapon', player).place_locked_item(item)
+
+    return spirit_name