games info in series, with platform, genres, release_year, and sub-se…

…ries

src/schemaCheck.py

@@ -7,6 +7,7 @@
 from datetime import date
 from datetime import datetime
 import re
+import traceback
 
 # https://json-schema.org/learn/getting-started-step-by-step#going-deeper-with-properties
 # https://cswr.github.io/JsonSchema/spec/introduction/
@@ -22,6 +23,54 @@
         {"type": "null"}, 
 ]}
 
+genres = {
+    "type": "array",
+    "minItems": 0,
+    "items": {
+        "type": "string",
+        "enum": [
+            "Adventure", "RPG", "Platformer", "Shooter", "Strategy", "Puzzle",
+        ]
+    }
+}
+
+platforms = {
+    "type": "array",
+    "minItems": 0,
+    "items": {
+        "type": "string",
+        "enum": [
+            "PC",
+            "NES", "SNES", "N64", "GameCube", "Wii", "Wii U", "Switch",
+            "GameBoy", "GBA", "DS", "3DS",
+            "Master System", "Genesis", "Saturn", "Dreamcast",
+            "PS1", "PS2", "PS3", "PS4", "PS5",
+            "PSP", "Vita",
+            "Xbox", "Xbox 360", "Xbox One", "Xbox Series",
+            "Arcade", "MSX",
+        ]
+    }
+}
+
+games_schema = {
+    "type": "object",
+    "additionalProperties": {
+        "type": "object",
+        "properties": {
+            "genres": genres,
+            "platforms": platforms,
+            "release_year": {
+                "type": ["number", 'null'],
+                "minimum": 1900,
+                "maximum": datetime.now().year + 1
+            },
+            "sub-series": ValidString
+        },
+        "required": ["genres", "platforms", "release_year"],
+        "additionalProperties": False
+    }
+}
+
 def randomizer_schema(data):
     ret = {
         "type": "object",
@@ -56,6 +105,8 @@ def randomizer_schema(data):
         return ret
     if updated >= date(2024, 6, 19):
         ret['required'].append('opensource')
+    if updated >= date(2024, 7, 1):
+        ret['properties'].pop('sub-series') # deprecated, moved to games_schema
     return ret
 
 def series_schema(data):
@@ -67,6 +118,7 @@ def series_schema(data):
             "sub-series": {
                 "type": ["array", "null"],
             },
+            "games": games_schema,
             "randomizers": {
                 "type": "array",
                 "minItems": 1,
@@ -117,6 +169,7 @@ def validateSeriesConfig(path: Path):
     failures = 0
     #modified = get_modified_time(path) # currently we don't need this expensive check
     writeback = False
+    games = set()
     text = path.read_text()
     data = yaml.load(text, Loader=yaml.CLoader)
 
@@ -132,15 +185,21 @@ def validateSeriesConfig(path: Path):
     except ValidationError as e:
         failures += 1
         print('ERROR in', path, ': series definition -\n', e.path, e.message)
+        #raise # uncomment for bigger error messages
 
     for rando in data['randomizers']:
         try:
             validateRando(rando)
+            for game in rando.get('games', []):
+                if 'games' in data and game not in data['games']:
+                    raise ValidationError('game: ' + game + ' is not defined')
+                games.add(game)
         except ValidationError as e:
             failures += 1
             print('\nIn Randomizer definition:', rando)
             id = str(rando.get('game', ''))  + ' ' + str(rando.get('identifier', ''))
             print('\nERROR in', path, ': randomizer definition', id, '-\n', e.path, e.message)
+            #raise # uncomment for bigger error messages
 
         # update rando data
         if not rando.get('info-updated'):
@@ -150,6 +209,15 @@ def validateSeriesConfig(path: Path):
             writeback = True
             rando['added-date'] = date(2024, 5, 25)
 
+    if 'games' not in data:
+        newdata: dict = data.copy()
+        newdata.pop('randomizers')
+        games = {key: {'genres':[], 'platforms':[], 'release_year': None} for key in sorted(games)}
+        newdata['games'] = games
+        newdata['randomizers'] = data['randomizers']
+        data = newdata
+        writeback=True
+
     if failures == 0 and writeback:
         out = yaml.dump(data, sort_keys=False, indent=4)
         path.write_text(out)
@@ -169,7 +237,9 @@ def validateYamlFiles():
             failures += new_failures
         except Exception as e:
             failures += 1
+            print(traceback.format_exc())
             print('\nERROR in', file, '-\n', e)
+            #raise # uncomment for bigger error messages
 
     print('\n\n')
     assert success > 0

src/series/A_Short_Hike.yml

@@ -1,6 +1,11 @@
 name: A Short Hike
 comment: null
 sub-series: null
+games:
+    A Short Hike:
+        genres: []
+        platforms: []
+        release_year: null
 randomizers:
 -   games:
     - A Short Hike

src/series/ActRaiser.yml

@@ -1,6 +1,11 @@
 name: ActRaiser
 comment: null
 sub-series: null
+games:
+    ActRaiser:
+        genres: []
+        platforms: []
+        release_year: null
 randomizers:
 -   games:
     - ActRaiser

src/series/Adventure.yml

@@ -1,6 +1,11 @@
 name: Adventure
 comment: null
 sub-series: null
+games:
+    Adventure:
+        genres: []
+        platforms: []
+        release_year: null
 randomizers:
 -   games:
     - Adventure

src/series/Adventure_Island.yml

@@ -1,6 +1,15 @@
 name: Adventure Island
 comment: null
 sub-series: null
+games:
+    Adventure Island II:
+        genres: []
+        platforms: []
+        release_year: null
+    Super Adventure Island II:
+        genres: []
+        platforms: []
+        release_year: null
 randomizers:
 -   games:
     - Adventure Island II

src/series/Aerobiz.yml

@@ -1,6 +1,11 @@
 name: Aerobiz
 comment: null
 sub-series: null
+games:
+    Aerobiz Supersonic:
+        genres: []
+        platforms: []
+        release_year: null
 randomizers:
 -   games:
     - Aerobiz Supersonic

src/series/Age_of_Empires.yml

@@ -1,6 +1,19 @@
 name: Age of Empires
 comment: null
 sub-series: null
+games:
+    'Age of Empires II (2013) / Age of Empires II: Definitive Edition':
+        genres: []
+        platforms: []
+        release_year: null
+    'Age of Empires II: The Age of Kings':
+        genres: []
+        platforms: []
+        release_year: null
+    'Age of Mythology: Extended Edition':
+        genres: []
+        platforms: []
+        release_year: null
 randomizers:
 -   games:
     - 'Age of Empires II: The Age of Kings'

src/series/Alien.yml

@@ -1,6 +1,11 @@
 name: Alien
 comment: null
 sub-series: null
+games:
+    'Alien: Isolation':
+        genres: []
+        platforms: []
+        release_year: null
 randomizers:
 -   games:
     - 'Alien: Isolation'

src/series/Alundra.yml

@@ -1,6 +1,11 @@
 name: Alundra
 comment: null
 sub-series: null
+games:
+    Alundra:
+        genres: []
+        platforms: []
+        release_year: null
 randomizers:
 -   games:
     - Alundra

src/series/Americas_Army.yml

@@ -1,6 +1,11 @@
 name: America's Army
 comment: null
 sub-series: null
+games:
+    America's Army:
+        genres: []
+        platforms: []
+        release_year: null
 randomizers:
 -   games:
     - America's Army

src/series/Amnesia.yml

@@ -1,6 +1,11 @@
 name: Amnesia
 comment: null
 sub-series: null
+games:
+    'Amnesia: The Bunker':
+        genres: []
+        platforms: []
+        release_year: null
 randomizers:
 -   games:
     - 'Amnesia: The Bunker'

src/series/An_Untitled_Story.yml

@@ -1,6 +1,11 @@
 name: An Untitled Story
 comment: null
 sub-series: null
+games:
+    An Untitled Story:
+        genres: []
+        platforms: []
+        release_year: null
 randomizers:
 -   games:
     - An Untitled Story

src/series/Axiom_Verge.yml

@@ -1,6 +1,11 @@
 name: Axiom Verge
 comment: null
 sub-series: null
+games:
+    Axiom Verge:
+        genres: []
+        platforms: []
+        release_year: null
 randomizers:
 -   games:
     - Axiom Verge

src/series/Azure_Dreams.yml

@@ -1,6 +1,15 @@
 name: Azure Dreams
 comment: null
 sub-series: null
+games:
+    Azure Dreams:
+        genres: []
+        platforms: []
+        release_year: null
+    Azure Dreams (Game Boy Color):
+        genres: []
+        platforms: []
+        release_year: null
 randomizers:
 -   games:
     - Azure Dreams

src/series/Baldurs_Gate.yml

@@ -1,41 +1,63 @@
 name: Baldur's Gate
 comment: null
 sub-series: null
+games:
+    'Baldur''s Gate - Baldur''s Gate: Enhanced Edition - Baldur''s Gate II: Shadows of Amn':
+        genres: []
+        platforms: []
+        release_year: null
+    'Baldur''s Gate II: Enhanced Edition':
+        genres: []
+        platforms: []
+        release_year: null
+    'Baldur''s Gate II: Shadows of Amn':
+        genres: []
+        platforms: []
+        release_year: null
+    Baldur's Gate Trilogy (mod):
+        genres: []
+        platforms: []
+        release_year: null
+    'Baldur''s Gate: Enhanced Edition Trilogy (mod)':
+        genres: []
+        platforms: []
+        release_year: null
+    EasyTutu (mod):
+        genres: []
+        platforms: []
+        release_year: null
 randomizers:
 -   games:
-    - 'Baldur''s Gate
-    - Baldur''s Gate: Enhanced Edition
-    - Baldur''s Gate II: Shadows of Amn'
+    - 'Baldur''s Gate - Baldur''s Gate: Enhanced Edition - Baldur''s Gate II: Shadows
+        of Amn'
     - 'Baldur''s Gate II: Enhanced Edition'
     - 'Baldur''s Gate: Enhanced Edition Trilogy (mod)'
     identifier: Enemy Randomizer
     url: https://www.gibberlings3.net/files/file/1031-enemy-randomizer/
     added-date: 2024-05-25
     info-updated: 2024-05-25
 -   games:
-    - 'Baldur''s Gate
-    - Baldur''s Gate: Enhanced Edition
-    - Baldur''s Gate II: Shadows of Amn'
+    - 'Baldur''s Gate - Baldur''s Gate: Enhanced Edition - Baldur''s Gate II: Shadows
+        of Amn'
     - 'Baldur''s Gate II: Enhanced Edition'
-    - 'EasyTutu (mod)'
-    - 'Baldur''s Gate Trilogy (mod)'
+    - EasyTutu (mod)
+    - Baldur's Gate Trilogy (mod)
     - 'Baldur''s Gate: Enhanced Edition Trilogy (mod)'
     identifier: Item Randomiser
     url: https://www.gibberlings3.net/mods/items/item_rand/
     added-date: 2024-05-25
     info-updated: 2024-05-25
 -   games:
-    - 'Baldur''s Gate
-    - Baldur''s Gate: Enhanced Edition
-    - Baldur''s Gate II: Shadows of Amn'
+    - 'Baldur''s Gate - Baldur''s Gate: Enhanced Edition - Baldur''s Gate II: Shadows
+        of Amn'
     - 'Baldur''s Gate II: Enhanced Edition'
-    - 'EasyTutu (mod)'
-    - 'Baldur''s Gate Trilogy (mod)'
+    - EasyTutu (mod)
+    - Baldur's Gate Trilogy (mod)
     - 'Baldur''s Gate: Enhanced Edition Trilogy (mod)'
     identifier: Sword Coast Stratagems
     url: https://www.gibberlings3.net/mods/tweaks/scs/
-    comment: 'Mod collection that can randomize the maze in Watcher''s Keep for
-        Baldur''s Gate II'
+    comment: Mod collection that can randomize the maze in Watcher's Keep for Baldur's
+        Gate II
     added-date: 2024-05-25
     info-updated: 2024-05-25
 -   games:

src/series/Banjo-Kazooie.yml

@@ -1,6 +1,11 @@
 name: Banjo-Kazooie
 comment: null
 sub-series: null
+games:
+    Banjo-Kazooie:
+        genres: []
+        platforms: []
+        release_year: null
 randomizers:
 -   games:
     - Banjo-Kazooie