Merge pull request #118 from Hamsda:ootr

update to version 3.4.4.0

ootrando_overworldmap_hamsda/README.md

@@ -33,6 +33,7 @@ If you have a dungeon marked as unknown in non-keysanity, some of the checks in
 Some of this functionality might not be immediately obvious:
 
 - Right clicking ![Fairy Ocarina](images/fairyocarina.png "Fairy Ocarina")/![Ocarina of Time](images/ocarina.png "Ocarina of Time") will overlay it with ![Scarecrow](images/overlay_scarecrow.png "Scarecrow") indicating that you have confirmed the scarecrow song or started with free scarecrow. Locations that make use of the scarecrow will not show up unless this is turned on. The location of the scarecrow in Lake Hylia will automatically mark this when cleared first as child and then as adult.
+- Right clicking any of the song icons, e.g. ![Zelda's Lullaby](images/song_zelda.png "Zelda's Lullaby"), will overlay them with a smaller version, e.g. ![Song of Time overlay](images/overlay_song_time.png "Song of Time overlay"), that can be cycled through. This overlay has no logical bearing, but can be used to indicate which song has been found where in non songsanity.
 - ![Triforce Piece](images/triforce_piece.png "Triforce Piece") is used as a counter for Triforce pieces in the Triforce Hunt mode.
 
 ## Settings (for map variants)

ootrando_overworldmap_hamsda/changelog.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 3.4.4.0
+
+- added KZ skip to ER
+- improved song icon right click functionality
+
 ## 3.4.3.0
 
 - improved same-scene interior connections

ootrando_overworldmap_hamsda/items/quest.json

@@ -88,174 +88,6 @@
     "img": "images/rupee.png",
     "codes": "rupee"
   },
-  {
-    "name": "Zelda's Lullaby",
-    "type": "toggle",
-    "loop": true,
-    "img": "images/zelda_colored.png",
-    "codes": "lullaby,zl"
-  },
-  {
-    "name": "Zelda's Lullaby w/ check",
-    "type": "toggle_badged",
-    "base_item": "lullaby",
-    "img": "images/check.png",
-    "codes": "lullabycheck,zlcheck"
-  },
-  {
-    "name": "Saria's Song",
-    "type": "toggle",
-    "loop": true,
-    "img": "images/saria_colored.png",
-    "codes": "saria"
-  },
-  {
-    "name": "Saria's Song w/ check",
-    "type": "toggle_badged",
-    "base_item": "saria",
-    "img": "images/check.png",
-    "codes": "sariacheck"
-  },
-  {
-    "name": "Epona's Song",
-    "type": "toggle",
-    "loop": true,
-    "img": "images/epona_colored.png",
-    "codes": "epona"
-  },
-  {
-    "name": "Epona's Song w/ check",
-    "type": "toggle_badged",
-    "base_item": "epona",
-    "img": "images/check.png",
-    "codes": "eponacheck"
-  },
-  {
-    "name": "Sun's Song",
-    "type": "toggle",
-    "loop": true,
-    "img": "images/sun_colored.png",
-    "codes": "sun"
-  },
-  {
-    "name": "Sun's Song w/ check",
-    "type": "toggle_badged",
-    "base_item": "sun",
-    "img": "images/check.png",
-    "codes": "suncheck"
-  },
-  {
-    "name": "Song of Time",
-    "type": "toggle",
-    "loop": true,
-    "img": "images/time_colored.png",
-    "codes": "time,sot"
-  },
-  {
-    "name": "Song of Time w/ check",
-    "type": "toggle_badged",
-    "base_item": "time",
-    "img": "images/check.png",
-    "codes": "timecheck,sotcheck"
-  },
-  {
-    "name": "Song of Storms",
-    "type": "toggle",
-    "loop": true,
-    "img": "images/storms_colored.png",
-    "codes": "storm,sos"
-  },
-  {
-    "name": "Song of Storms w/ check",
-    "type": "toggle_badged",
-    "base_item": "storm",
-    "img": "images/check.png",
-    "codes": "stormcheck,soscheck"
-  },
-  {
-    "name": "Minuet of Forest",
-    "type": "toggle",
-    "loop": true,
-    "img": "images/minuet.png",
-    "codes": "minuet,mof"
-  },
-  {
-    "name": "Minuet of Forest w/ check",
-    "type": "toggle_badged",
-    "base_item": "minuet",
-    "img": "images/check.png",
-    "codes": "minuetcheck,mofcheck"
-  },
-  {
-    "name": "Bolero of Fire",
-    "type": "toggle",
-    "loop": true,
-    "img": "images/bolero.png",
-    "codes": "bolero,bof"
-  },
-  {
-    "name": "Bolero of Fire w/ check",
-    "type": "toggle_badged",
-    "base_item": "bolero",
-    "img": "images/check.png",
-    "codes": "bolerocheck,bofcheck"
-  },
-  {
-    "name": "Serenade of Water",
-    "type": "toggle",
-    "loop": true,
-    "img": "images/serenade.png",
-    "codes": "serenade,sow"
-  },
-  {
-    "name": "Serenade of Water w/ check",
-    "type": "toggle_badged",
-    "base_item": "serenade",
-    "img": "images/check.png",
-    "codes": "serenadecheck,sowcheck"
-  },
-  {
-    "name": "Requiem of Spirit",
-    "type": "toggle",
-    "loop": true,
-    "img": "images/requiem.png",
-    "codes": "requiem,ros"
-  },
-  {
-    "name": "Requiem of Spirit w/ check",
-    "type": "toggle_badged",
-    "base_item": "requiem",
-    "img": "images/check.png",
-    "codes": "requiemcheck,roscheck"
-  },
-  {
-    "name": "Nocturne of Shadow",
-    "type": "toggle",
-    "loop": true,
-    "img": "images/nocturne.png",
-    "codes": "nocturne,nos"
-  },
-  {
-    "name": "Nocturne of Shadow w/ check",
-    "type": "toggle_badged",
-    "base_item": "nocturne",
-    "img": "images/check.png",
-    "codes": "nocturnecheck,noscheck"
-  },
-  {
-    "name": "Prelude of Light",
-    "type": "toggle",
-    "loop": true,
-    "img": "images/prelude.png",
-    "codes": "prelude,pol"
-  },
-  {
-    "name": "Prelude of Light w/ check",
-    "type": "toggle_badged",
-    "base_item": "prelude",
-    "img": "images/check.png",
-    "codes": "preludecheck,polcheck"
-  },
   {
     "name": "Forest Medallion",
     "type": "toggle",

ootrando_overworldmap_hamsda/layouts/item_grids.json

@@ -65,20 +65,20 @@
             "skulltula"
           ],
           [
-            "lullabycheck",
-            "eponacheck",
-            "sariacheck",
-            "suncheck",
-            "timecheck",
-            "stormcheck"
-          ],
-          [
-            "minuetcheck",
-            "bolerocheck",
-            "serenadecheck",
-            "requiemcheck",
-            "nocturnecheck",
-            "preludecheck"
+            "lullaby",
+            "epona",
+            "saria",
+            "sun",
+            "time",
+            "storm"
+          ],
+          [
+            "minuet",
+            "bolero",
+            "serenade",
+            "requiem",
+            "nocturne",
+            "prelude"
           ]
         ]
       },
@@ -142,23 +142,23 @@
             "hoverboots"
           ],
           [
-            "lullabycheck",
-            "eponacheck",
-            "sariacheck",
-            "suncheck",
-            "timecheck",
-            "stormcheck",
+            "lullaby",
+            "epona",
+            "saria",
+            "sun",
+            "time",
+            "storm",
             "wallet1",
             "magic",
             "skulltula"
           ],
           [
-            "minuetcheck",
-            "bolerocheck",
-            "serenadecheck",
-            "requiemcheck",
-            "nocturnecheck",
-            "preludecheck",
+            "minuet",
+            "bolero",
+            "serenade",
+            "requiem",
+            "nocturne",
+            "prelude",
             "card",
             "agony",
             "triforce"
@@ -206,20 +206,20 @@
             "bottleminimal"
           ],
           [
-            "lullabycheck",
-            "eponacheck",
-            "sariacheck",
-            "suncheck",
-            "timecheck",
-            "stormcheck"
+            "lullaby",
+            "epona",
+            "saria",
+            "sun",
+            "time",
+            "storm"
           ],
           [
-            "minuetcheck",
-            "bolerocheck",
-            "serenadecheck",
-            "requiemcheck",
-            "nocturnecheck",
-            "preludecheck"
+            "minuet",
+            "bolero",
+            "serenade",
+            "requiem",
+            "nocturne",
+            "prelude"
           ]
         ]
       },

ootrando_overworldmap_hamsda/manifest.json

@@ -1,7 +1,7 @@
 {
   "name": "OoT Randomizer - Map and Item Tracker",
   "game_name": "Ocarina of Time Randomizer",
-  "package_version": "3.4.3.0",
+  "package_version": "3.4.4.0",
   "package_uid": "ootrando_overworldmap_hamsda",
   "author": "Hamsda",
   "variants": {

ootrando_overworldmap_hamsda/scripts/custom_prog_badge.lua

@@ -0,0 +1,78 @@
+ProgBadgeItem = CustomItem:extend()
+
+function ProgBadgeItem:init(name, code, imagePath, badges)
+  self:createItem(name)
+  self.code = code
+  self.badges = badges
+  self:setProperty("active", false)
+  self:setProperty("badgeNum", 0)
+  self.imageBase = ImageReference:FromPackRelativePath(imagePath)
+  self.ItemInstance.PotentialIcon = self.imageBase
+  self:updateIcon()
+end
+
+function ProgBadgeItem:updateIcon()
+  local img_mod = ""
+  if self:getProperty("badgeNum") and self:getProperty("badgeNum") > 0 then
+    img_mod = "overlay|"..self.badges[self:getProperty("badgeNum")]
+  end
+  if not self:getProperty("active") then
+    img_mod = img_mod..",@disabled"
+  end
+  self.ItemInstance.Icon = ImageReference:FromImageReference(self.imageBase, img_mod)
+end
+
+function ProgBadgeItem:onLeftClick()
+  self:setProperty("active", not self:getProperty("active"))
+end
+
+function ProgBadgeItem:onRightClick()
+  if self:getProperty("badgeNum") then
+    if self:getProperty("badgeNum") == #self.badges then
+      self:setProperty("badgeNum", 0)
+    else
+      self:setProperty("badgeNum", self:getProperty("badgeNum") + 1)
+    end
+  end
+end
+
+function ProgBadgeItem:canProvideCode(code)
+  if self.code and self.code == code then
+    return true
+  end
+  return false
+end
+
+function ProgBadgeItem:providesCode(code)
+  if self:getProperty("active") and self:canProvideCode(code) then
+    return 1
+  end
+  return 0
+end
+
+function ProgBadgeItem:advanceToCode(code)
+  if code == nil or self:canProvideCode(code) then
+    self:setProperty("active", true)
+  end
+end
+
+function ProgBadgeItem:save()
+  local saveData = {}
+  saveData["active"] = self:getProperty("active")
+  saveData["badgeNum"] = self:getProperty("badgeNum")
+  return saveData
+end
+
+function ProgBadgeItem:load(data)
+  if data["active"] ~= nil then
+    self:setProperty("active", data["active"])
+  end
+  if data["badgeNum"] ~= nil then
+    self:setProperty("badgeNum", data["badgeNum"])
+  end
+  return true
+end
+
+function ProgBadgeItem:propertyChanged(key, value)
+  self:updateIcon()
+end