Merge branch 'gui-improvements-update' into ci-dev

source/classes/SpriteSelector.py

@@ -1,4 +1,4 @@
-from tkinter import filedialog, messagebox, Button, Canvas, Label, LabelFrame, Frame, PhotoImage, Scrollbar, Toplevel, ALL, NSEW, LEFT, BOTTOM, X, RIGHT, TOP, HORIZONTAL, EW, NS
+from tkinter import filedialog, messagebox, Button, Canvas, Label, LabelFrame, Frame, PhotoImage, Scrollbar, Toplevel, ALL, LEFT, BOTTOM, X, RIGHT, TOP, EW, NS
 from glob import glob
 import json
 import os
@@ -34,6 +34,7 @@ class SpriteSelector(object):
         def open_unofficial_sprite_dir(_evt):
             open_file(self.unofficial_sprite_dir)
 
+        # Open SpriteSomething directory for Link sprites
         def open_spritesomething_listing(_evt):
             webbrowser.open("https://artheau.github.io/SpriteSomething/?mode=zelda3/link")
 #            webbrowser.open("https://artheau.github.io/SpriteSomething/resources/app/snes/zelda3/link/sprites.html")
@@ -51,6 +52,7 @@ class SpriteSelector(object):
         unofficial_title_text.pack(side=LEFT)
         unofficial_title_link.pack(side=LEFT)
         unofficial_title_link.bind("<Button-1>", open_unofficial_sprite_dir)
+        # Include hyperlink to SpriteSomething directory for Link sprites
         spritesomething_title_link = Label(unofficial_frametitle, text="(SpriteSomething)", fg="blue", cursor="hand2")
         spritesomething_title_link.pack(side=LEFT)
         spritesomething_title_link.bind("<Button-1>", open_spritesomething_listing)

source/classes/constants.py

@@ -1,3 +1,4 @@
+# Ordered list of items in Custom Item Pool page and Starting Inventory page
 CUSTOMITEMS = [
   "bow",                "progressivebow",   "boomerang",          "redmerang",        "hookshot",
   "mushroom",           "powder",           "firerod",            "icerod",           "bombos",
@@ -20,11 +21,13 @@ CUSTOMITEMS = [
   "rupoorcost"
 ]
 
+# These can't be in the Starting Inventory page
 CANTSTARTWITH = [
   "triforcepiecesgoal", "triforce", "rupoor",
   "rupoorcost"
 ]
 
+# In the same order as CUSTOMITEMS, these are Pretty Labels for each option
 CUSTOMITEMLABELS = [
   "Bow", "Progressive Bow", "Blue Boomerang", "Red Boomerang", "Hookshot",
   "Mushroom", "Magic Powder", "Fire Rod", "Ice Rod", "Bombos",
@@ -47,6 +50,8 @@ CUSTOMITEMLABELS = [
   "Rupoor Cost"
 ]
 
+# Stuff on each page to save, according to internal names as defined by the widgets definitions
+#  and how it eventually translates to YAML/JSON weight files
 SETTINGSTOPROCESS = {
   "randomizer": {
     "item": {