Initial Cube Tracker implementation

Author: veger

changelog.txt

@@ -1,4 +1,8 @@
 ---------------------------------------------------------------------------------------------------
+Version: 2.2.0
+  Features:
+    - Add a new Cube Tracker to track the Ultracube.
+---------------------------------------------------------------------------------------------------
 Version: 2.1.1
 Date: 13-11-2025
   Bugfixes:

control.lua

@@ -3,7 +3,8 @@ local TLBE = {
     Camera = require("scripts.camera"),
     Config = require("scripts.config"),
     GUI = require("scripts.gui"),
-    Tracker = require("scripts.tracker")
+    Tracker = require("scripts.tracker"),
+    Utils = require("scripts.utils")
 }
 
 local function register_sensor()
@@ -64,6 +65,19 @@ local function on_configuration_changed(event)
             init_new_player(index, player)
         end
     end
+
+    local hasUltracube = TLBE.Utils.isUltracubeAvailable()
+    for index, _ in pairs(game.players) do
+        local playerSettings = storage.playerSettings[index]
+        if playerSettings ~= nil and playerSettings.trackers ~= nil then
+            for _, tracker in pairs(playerSettings.trackers) do
+                if tracker.type == "cube" then
+                    tracker.enabled = hasUltracube
+                    tracker.userCanEnable = hasUltracube
+                end
+            end
+        end
+    end
 end
 
 -- A player got created (or joined the game)

info.json

@@ -9,7 +9,8 @@
     "factorio_version": "2.0",
     "dependencies": [
         "base >= 2.0.0",
-        "? StatsGui >= 1.1.0"
+        "? StatsGui >= 1.1.0",
+        "? Ultracube >= 0.5.2"
     ],
     "description": "Takes screenshots of your base at specified intervals."
 }

locale/en/locale.cfg

@@ -16,6 +16,7 @@ tracker-base=Base Tracker
 tracker-player=Player Tracker
 tracker-rocket=Rocket Tracker
 tracker-cityBlock=City Block Tracker
+tracker-cube=Cube Tracker
 
 [gui]
 button-base-recalculate=Recalculate base size
@@ -90,6 +91,7 @@ tracker-cityblock-currentblock-y=The position of the current city block, countin
 tracker-cityblock-blockScale=How many city blocks to zoom out, centered on the current block.
 tracker-cityblock-blockScale-value=A zoom of 3 will capture the current block and all of the neighbors. <enter> to set.
 tracker-cityblock-player=Use player coordinates to select the current city block.
+tracker-cube-not-available=This tracker is not available because Ultracube mod is not loaded.
 
 [controls]
 tlbe-main-window-toggle=Open/Close camera settings

scripts/gui.lua

@@ -1,10 +1,18 @@
 local GUI = {
-    allTrackers = { "area", "base", "cityblock", "player", "rocket" },
-    allTrackersLabels = { { "tracker-area" }, { "tracker-base" }, { "tracker-cityBlock" }, { "tracker-player" }, { "tracker-rocket" } },
+    allTrackers = { "area", "base", "cityblock", "cube", "player", "rocket" },
+    allTrackersLabels = {
+        { "tracker-area" },
+        { "tracker-base" },
+        { "tracker-cityBlock" },
+        { "tracker-cube" },
+        { "tracker-player" },
+        { "tracker-rocket" },
+    },
     allTrackersLabelsMap = {
         area = { "tracker-area" },
         base = { "tracker-base" },
         cityBlock = { "tracker-cityBlock" },
+        cube = { "tracker-cube" },
         player = { "tracker-player" },
         rocket = { "tracker-rocket" },
     }
@@ -15,6 +23,21 @@ local Main = require("scripts.main")
 local Tracker = require("scripts.tracker")
 local Utils = require("scripts.utils")
 
+local function getAvailableTrackerTypes()
+    local trackerTypes = {}
+    local trackerLabels = {}
+
+    local ultracubeAvailable = Utils.isUltracubeAvailable()
+    for index, trackerType in ipairs(GUI.allTrackers) do
+        if trackerType ~= "cube" or ultracubeAvailable then
+            table.insert(trackerTypes, trackerType)
+            table.insert(trackerLabels, GUI.allTrackersLabels[index])
+        end
+    end
+
+    return trackerTypes, trackerLabels
+end
+
 local ticks_per_half_second = 30
 
 local function getWindowPlayButtonStyle(selected)
@@ -448,7 +471,9 @@ function GUI.onSelected(event)
         end
         event.element.selected_index = 1
 
-        local newTracker = Tracker.newTracker(player, GUI.allTrackers[trackerIndex], playerSettings.trackers)
+        local availableTrackerTypes = getAvailableTrackerTypes()
+        local trackerType = availableTrackerTypes[trackerIndex]
+        local newTracker = Tracker.newTracker(player, trackerType, playerSettings.trackers)
         table.insert(playerSettings.trackers, newTracker)
         playerSettings.guiPersist.selectedTracker = #playerSettings.trackers
 
@@ -1111,11 +1136,13 @@ function GUI.createTrackerSettings(parent, playerGUI, guiPersist, cameras, track
     local trackersFlow = flow.add { type = "flow", direction = "vertical", style = "tlbe_fancy_list_parent" }
 
     -- New tracker GUI
+    local availableTrackerTypes, availableTrackerLabels = getAvailableTrackerTypes()
+    playerGUI.availableTrackerTypes = availableTrackerTypes
     trackersFlow.add {
         type = "drop-down",
         selected_index = 1,
         name = "tlbe-tracker-add",
-        items = { { "gui.item-new-tracker" }, table.unpack(GUI.allTrackersLabels) },
+        items = { { "gui.item-new-tracker" }, table.unpack(availableTrackerLabels) },
         style = "tlbe_tracker_add_dropdown"
     }
 
@@ -1235,7 +1262,7 @@ function GUI.addCameraTrackerButtons(index, selectedCamera, _, trackers, tracker
         style = "tlbe_tracker_remove_button"
     }
 
-    if isActiveTracker then
+    if isActiveTracker and tracker.enabled then
         trackerRow.add {
             type = "sprite",
             sprite = "utility/play",
@@ -1248,6 +1275,13 @@ function GUI.addCameraTrackerButtons(index, selectedCamera, _, trackers, tracker
             style = "tlbe_fancy_list_box_image_reduce_size",
             tooltip = { "tooltip.tracker-wrong-surface" }
         }
+    elseif tracker.type == "cube" and not Utils.isUltracubeAvailable() then
+        trackerRow.add {
+            type = "sprite",
+            sprite = "utility/warning_icon",
+            style = "tlbe_fancy_list_box_image_reduce_size",
+            tooltip = { "tooltip.tracker-cube-not-available" }
+        }
     else
         trackerRow.add {
             type = "empty-widget",

scripts/tracker.lua

@@ -77,6 +77,10 @@ function Tracker.newTracker(player, trackerType, trackerList)
         newTracker.userCanEnable = false
         newTracker.enabled = false
         newTracker.realtimeCamera = true
+    elseif trackerType == "cube" then
+        newTracker.size = { x = 1, y = 1 }
+        newTracker.enabled = Utils.isUltracubeAvailable()
+        newTracker.userCanEnable = Utils.isUltracubeAvailable()
     elseif trackerType == "cityblock" then
         -- cityblock-specific data
         newTracker.cityBlock = Tracker.cityBlock:new()
@@ -165,6 +169,55 @@ function Tracker.tick(tracker, player)
             x = player.position.x,
             y = player.position.y
         }
+    elseif tracker.type == "cube" then
+        local ok, info = pcall(remote.call, "Ultracube", "cube_info")
+        if ok and info ~= nil then
+            local minPos = info.min_position
+            local maxPos = info.max_position
+            local centerPos
+            local size
+
+            if minPos ~= nil and maxPos ~= nil then
+                local sizeX = maxPos.x - minPos.x
+                local sizeY = maxPos.y - minPos.y
+
+                if sizeX == 0 then
+                    sizeX = 1
+                end
+                if sizeY == 0 then
+                    sizeY = 1
+                end
+
+                size = {
+                    x = sizeX,
+                    y = sizeY
+                }
+                centerPos = {
+                    x = minPos.x + size.x / 2,
+                    y = minPos.y + size.y / 2
+                }
+            elseif info.position ~= nil then
+                centerPos = {
+                    x = info.position.x,
+                    y = info.position.y
+                }
+                size = tracker.size or { x = 1, y = 1 }
+            else
+                return
+            end
+
+            if tracker.centerPos == nil or tracker.size == nil or
+                centerPos.x ~= tracker.centerPos.x or
+                centerPos.y ~= tracker.centerPos.y or
+                size.x ~= tracker.size.x or
+                size.y ~= tracker.size.y
+            then
+                Tracker.changed(tracker)
+            end
+
+            tracker.centerPos = centerPos
+            tracker.size = size
+        end
     end
 end
 

scripts/utils.lua

@@ -68,4 +68,8 @@ function Utils.clamp(min, value, max)
     return math.max(min, math.min(max, value))
 end
 
+function Utils.isUltracubeAvailable()
+    return script.active_mods["Ultracube"] ~= nil
+end
+
 return Utils