Move item data to JSON files (#1)

* Move game items to json files for live editing

* Attempt to fix specfile for json data

* Remove conversion script

* Try to fix replacement file loading for frozen bundles

Author: maikelwever

.gitignore

@@ -179,3 +179,5 @@ tags
 .vscode
 .venv
 imgui.ini
+
+/game/*.json

MANIFEST.in

@@ -0,0 +1,2 @@
+include slimseditor/game/*.json
+

readme.md

@@ -69,3 +69,20 @@ env/bin/pip install -r requirements.txt
 env/bin/python setup.py develop
 env/bin/python -m slimseditor
 ```
+
+
+Adding savegame items
+---------------------
+
+Savegame item positions are defined by `.json` files in `slimseditor/game`.
+For prebuilt editions, these files are bundled with the application data.
+
+To submit new items, or change existing item definitions, 
+simply edit the appropriate lines in the `.json` files.
+The editor will re-read the `.json` files every time you open a savegame or click a `refresh` button.
+
+If you are working with a prebuilt edition, 
+you can create a folder called `game` in the directory `slimseditor.exe` is in.
+The editor will then search for game files in this directory instead.
+To get started with this, download the `.json` file for the game you're editing from GitHub,
+and put it in your new `game` folder. 

setup.py

@@ -18,4 +18,5 @@
     url='https://github.com/maikelwever/slimseditor/',
     packages=['slimseditor'],
     ext_modules=[slimscbindings],
+    include_package_data=True,
 )

slimseditor/game/__init__.py

@@ -1,13 +1,23 @@
+import json
+import os
+import pkgutil
+import sys
+
 from enum import Enum
 
-from slimseditor.game.acit import get_acit_items
-from slimseditor.game.dl import get_dl_items
-from slimseditor.game.gc import get_gc_items
-from slimseditor.game.nexus import get_nexus_items
-from slimseditor.game.qfb import get_qfb_items
-from slimseditor.game.rac import get_rac_items
-from slimseditor.game.tod import get_tod_items
-from slimseditor.game.uya import get_uya_items
+from slimseditor.saveentry import RangedInteger, Integer, Boolean
+
+
+ITEM_CLASSES = {
+    'RangedInteger': RangedInteger,
+    'Integer': Integer,
+    'Boolean': Boolean,
+}
+
+if getattr(sys, 'frozen', False):
+    APP_PATH = sys._MEIPASS
+else:
+    APP_PATH = os.path.dirname(os.path.abspath(__file__))
 
 
 class Game(Enum):
@@ -22,12 +32,32 @@ class Game(Enum):
     NEXUS = "Ratchet and Clank : Into the Nexus"
 
     def get_items(self):
-        if self == Game.RAC: return get_rac_items()
-        if self == Game.GC: return get_gc_items()
-        if self == Game.UYA: return get_uya_items()
-        if self == Game.DL: return get_dl_items()
-        if self == Game.TOD: return get_tod_items()
-        if self == Game.QFB: return get_qfb_items()
-        if self == Game.ACIT: return get_acit_items()
-        if self == Game.NEXUS: return get_nexus_items()
-        return dict()
+        return get_game_items(self)
+
+
+def get_game_file(game: Game):
+    game_filename = '{0}.json'.format(str(game.name).lower())
+    possible_game_folder = os.path.join(APP_PATH, 'game')
+    if os.path.exists(possible_game_folder) and os.path.isdir(possible_game_folder):
+        possible_filename = os.path.join(possible_game_folder, game_filename)
+        if os.path.exists(possible_filename):
+            with open(possible_filename, 'r') as f:
+                return f.read()
+
+    return pkgutil.get_data('slimseditor.game', game_filename).decode('utf-8')
+
+
+def get_game_items(game: Game):
+    json_data = get_game_file(game)
+    parsed_data = json.loads(json_data)
+    items = dict()
+    for key, value in parsed_data.items():
+        item_list = []
+        for item in value:
+            copied_item = item
+            item_type = copied_item.pop('type')
+            item_list.append(ITEM_CLASSES[item_type](**copied_item))
+
+        items[key] = item_list
+
+    return items

slimseditor/game/acit.json

@@ -0,0 +1,3 @@
+{
+    "Bolt counts": []
+}

slimseditor/game/acit.py

@@ -0,0 +1,3 @@
+{
+    "Bolt counts": []
+}