Sims 4: Rules Refactor Part 1

.github/workflows/test.yml

@@ -0,0 +1,14 @@
+name: Test apworld
+on:
+  push:
+  pull_request:
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: Eijebong/ap-actions/ap-tests@main
+        with:
+          apworld-path: worlds/sims4
+          ap-version: latest
+          python-version: '3.12'

worlds/sims4/Items.py

@@ -5,6 +5,7 @@
 from .Names import SkillNames, JunkNames, UsefulNames
 from .Names.DLC import ExpansionNames, GamePackNames, StuffNames
 
+
 class ItemDict(TypedDict):
     classification: ItemClassification
     count: int
@@ -24,21 +25,29 @@ class Sims4Item(Item):
 
 skills_table: dict[int, ItemDict] = {}
 
+
+class SkillConfigError(ValueError):
+    """Raised when skill configuration is invalid."""
+
+
 def add_skill(skill_name: str, expansion: str, max_level: int) -> int:
+    if max_level < 2:
+        raise SkillConfigError(f"max_level must be at least 2, got {max_level}")
     if skills_table:
         skill_id = max(skills_table.keys()) + 1
     else:
         skill_id = 0x7334001
 
     skills_table[skill_id] = {
-        "name": f"{skill_name}",
+        "name": skill_name,
         "classification": ItemClassification.progression,
         "count": max_level - 2,
         "tech_type": "Skill",
         "expansion": expansion
         }
     return skill_id
 
+
 add_skill(SkillNames.base_skill_comedy, ExpansionNames.base, 10)
 add_skill(SkillNames.base_skill_guitar, ExpansionNames.base, 10)
 add_skill(SkillNames.base_skill_logic, ExpansionNames.base, 10)
@@ -80,7 +89,7 @@ def add_skill(skill_name: str, expansion: str, max_level: int) -> int:
 add_skill(SkillNames.du_robotics_skill, ExpansionNames.discover_university, 10)
 add_skill(SkillNames.el_fabrication_skill, ExpansionNames.eco_lifestyle, 10)
 add_skill(SkillNames.el_juicefizzing_skill, ExpansionNames.eco_lifestyle, 5)
-add_skill(SkillNames.nk_knitting_skill,  StuffNames.nifty_knitting, 10)
+add_skill(SkillNames.nk_knitting_skill, StuffNames.nifty_knitting, 10)
 add_skill(SkillNames.sy_rock_climbing_skill, ExpansionNames.snowy_escape, 10)
 add_skill(SkillNames.sy_skiing_skill, ExpansionNames.snowy_escape, 10)
 add_skill(SkillNames.sy_snowboarding_skill, ExpansionNames.snowy_escape, 10)
@@ -97,7 +106,7 @@ def add_skill(skill_name: str, expansion: str, max_level: int) -> int:
 add_skill(SkillNames.ebn_apothecary_skill, ExpansionNames.enchanted_by_nature, 10)
 add_skill(SkillNames.ebn_natural_living_skill, ExpansionNames.enchanted_by_nature, 10)
 
-useful_table = {
+useful_table: dict[int, ItemDict] = {
     0x733400FF: {'classification': ItemClassification.useful,
                  'count': 4,
                  'name': UsefulNames.skill_gain_boost,
@@ -106,7 +115,7 @@ def add_skill(skill_name: str, expansion: str, max_level: int) -> int:
 
 }
 
-junk_table = {
+junk_table: dict[int, ItemDict] = {
     0x73340FFF: {'classification': ItemClassification.filler,
                  'count': 0,
                  'name': JunkNames.twothousand_simoleons,

worlds/sims4/Locations.py

@@ -9,10 +9,6 @@
 class Sims4Location(Location):
     game: str = "The Sims 4"
 
-    def __init__(self, player: int, name: str, address: Optional[int], parent):
-        super().__init__(player, name, address, parent)
-        self.event = not address
-
 
 class Sims4LocationDict(TypedDict, total=False):
     name: str
@@ -27,6 +23,7 @@ class Sims4LocationData(NamedTuple):
 
 skill_locations_table: dict[int, Sims4LocationDict] = {}
 
+
 def add_skill_location(skill_name: str, expansion: str, max_level: int) -> int:
     if skill_locations_table:
         start_id = max(skill_locations_table.keys())
@@ -42,6 +39,7 @@ def add_skill_location(skill_name: str, expansion: str, max_level: int) -> int:
         }
     return skill_id
 
+
 add_skill_location(SkillNames.base_skill_comedy, ExpansionNames.base, 10)
 add_skill_location(SkillNames.base_skill_guitar, ExpansionNames.base, 10)
 add_skill_location(SkillNames.base_skill_logic, ExpansionNames.base, 10)
@@ -83,7 +81,7 @@ def add_skill_location(skill_name: str, expansion: str, max_level: int) -> int:
 add_skill_location(SkillNames.du_robotics_skill, ExpansionNames.discover_university, 10)
 add_skill_location(SkillNames.el_fabrication_skill, ExpansionNames.eco_lifestyle, 10)
 add_skill_location(SkillNames.el_juicefizzing_skill, ExpansionNames.eco_lifestyle, 5)
-add_skill_location(SkillNames.nk_knitting_skill,  StuffNames.nifty_knitting, 10)
+add_skill_location(SkillNames.nk_knitting_skill, StuffNames.nifty_knitting, 10)
 add_skill_location(SkillNames.sy_rock_climbing_skill, ExpansionNames.snowy_escape, 10)
 add_skill_location(SkillNames.sy_skiing_skill, ExpansionNames.snowy_escape, 10)
 add_skill_location(SkillNames.sy_snowboarding_skill, ExpansionNames.snowy_escape, 10)
@@ -97,13 +95,13 @@ def add_skill_location(skill_name: str, expansion: str, max_level: int) -> int:
 add_skill_location(SkillNames.lnd_thanatology_skill, ExpansionNames.life_and_death, 5)
 add_skill_location(SkillNames.bnh_pottery_skill, ExpansionNames.business_and_hobbies, 10)
 add_skill_location(SkillNames.bnh_tattooing_skill, ExpansionNames.business_and_hobbies, 10)
-add_skill_location(SkillNames.ebn_apothecary_skill, ExpansionNames.enchanted_by_nature , 10)
-add_skill_location(SkillNames.ebn_natural_living_skill, ExpansionNames.enchanted_by_nature , 10)
+add_skill_location(SkillNames.ebn_apothecary_skill, ExpansionNames.enchanted_by_nature, 10)
+add_skill_location(SkillNames.ebn_natural_living_skill, ExpansionNames.enchanted_by_nature, 10)
 
 del add_skill_location
 
 
-careers_locations_table = {
+careers_locations_table: dict[int, Sims4LocationDict] = {
 
     0x73342001: {"name": f"{CareerNames.base_career_athlete_2}",
                  "category": "Athlete",
@@ -568,7 +566,7 @@ def add_skill_location(skill_name: str, expansion: str, max_level: int) -> int:
 
 }
 
-ptj_locations_table = {
+ptj_locations_table: dict[int, Sims4LocationDict] = {
 
     0x733420A2: {"name": f"{CareerNames.base_ptj_babysitter_2}",
                  "category": "Babysitter",
@@ -606,7 +604,7 @@ def add_skill_location(skill_name: str, expansion: str, max_level: int) -> int:
                  "expansion": "base"},
 }
 
-aspiration_locations_table = {
+aspiration_locations_table: dict[int, Sims4LocationDict] = {
     0x73343000: {"name": f"{AspirationNames.base_aspiration_basic_trainer}",
                  "category": "Aspirations",
                  "expansion": "base"},
@@ -882,7 +880,7 @@ def add_skill_location(skill_name: str, expansion: str, max_level: int) -> int:
                  "expansion": "base"},
 }
 
-location_table = {
+location_table: dict[int, Sims4LocationDict] = {
     **skill_locations_table,
     **careers_locations_table,
     **aspiration_locations_table,

worlds/sims4/Names/EventNames.py

@@ -0,0 +1,36 @@
+bodybuilder = "Completed Bodybuilder Aspiration"
+bodybuilder_item = "Completed Bodybuilder"
+painter_extraordinaire = "Completed Painter Extraordinaire Aspiration"
+painter_extraordinaire_item = "Completed Painter Extraordinaire"
+bestselling_author = "Completed Bestselling Author Aspiration"
+bestselling_author_item = "Completed Bestselling Author"
+musical_genius = "Completed Musical Genius Aspiration"
+musical_genius_item = "Completed Musical Genius"
+chief_of_mischief = "Completed Chief of Mischief Aspiration"
+chief_of_mischief_item = "Completed Chief of Mischief"
+public_enemy = "Completed Public Enemy Aspiration"
+public_enemy_item = "Completed Public Enemy"
+master_chef = "Completed Master Chef Aspiration"
+master_chef_item = "Completed Master Chef"
+master_mixologist = "Completed Master Mixologist Aspiration"
+master_mixologist_item = "Completed Master Mixologist"
+renaissance_sim = "Completed Renaissance Sim Aspiration"
+renaissance_sim_item = "Completed Renaissance Sim"
+nerd_brain = "Completed Nerd Brain Aspiration"
+nerd_brain_item = "Completed Nerd Brain"
+computer_whiz = "Completed Computer Whiz Aspiration"
+computer_whiz_item = "Completed Computer Whiz"
+serial_romantic = "Completed Serial Romantic Aspiration"
+serial_romantic_item = "Completed Serial Romantic"
+freelance_botanist = "Completed Freelance Botanist Aspiration"
+freelance_botanist_item = "Completed Freelance Botanist"
+the_curator = "Completed The Curator Aspiration"
+the_curator_item = "Completed The Curator"
+angling_ace = "Completed Angling Ace Aspiration"
+angling_ace_item = "Completed Angling Ace"
+joke_star = "Completed Joke Star Aspiration"
+joke_star_item = "Completed Joke Star"
+friend_of_the_world = "Completed Friend of the World Aspiration"
+friend_of_the_world_item = "Completed Friend of the World"
+neighborly_advisor = "Completed Neighborly Advisor Aspiration"
+neighborly_advisor_item = "Completed Neighborly Advisor"