Merge pull request #206 from ComfyFactory/server_connect

Add the ability to connect to other servers via ingame gui

comfy_panel/server_select.lua

@@ -0,0 +1,225 @@
+local Event = require 'utils.event'
+local Global = require 'utils.global'
+local Gui = require 'utils.gui'
+local Server = require 'utils.server'
+
+local this = {
+    server_select = {
+        instances = {}
+    }
+}
+
+local main_frame_name = Gui.uid_name()
+local main_button_name = Gui.uid_name()
+local discard_button_name = Gui.uid_name()
+local instance_id_name = Gui.uid_name()
+local insert = table.insert
+local sort = table.sort
+
+Global.register(
+    this,
+    function(t)
+        this = t
+    end
+)
+
+local function get_instance()
+    local server_instances = Server.get_instances()
+    local id = Server.get_server_id()
+    if server_instances and server_instances[id] then
+        return server_instances[id]
+    else
+        return {name = 'Offline', id = id, status = 'offline', version = game.active_mods.base}
+    end
+end
+
+local function apply_button_style(button)
+    local button_style = button.style
+    button_style.font = 'default-semibold'
+    button_style.height = 26
+    button_style.minimal_width = 26
+    button_style.top_padding = 0
+    button_style.bottom_padding = 0
+    button_style.left_padding = 2
+    button_style.right_padding = 2
+end
+
+local function draw_main_frame(player)
+    local instance = get_instance()
+    local left = player.gui.left
+
+    local frame = left.add {type = 'frame', name = main_frame_name, caption = 'Comfy Servers', direction = 'vertical'}
+
+    local inside_frame =
+        frame.add {
+        type = 'frame',
+        style = 'deep_frame_in_shallow_frame'
+    }
+    local inside_frame_style = inside_frame.style
+    inside_frame_style.padding = 0
+    inside_frame_style.maximal_height = 800
+
+    local viewer_top_flow = inside_frame.add {type = 'table', column_count = 5}
+    viewer_top_flow.style.horizontal_spacing = 0
+
+    local viewer_content = inside_frame.add {type = 'scroll-pane'}
+    viewer_content.style.maximal_height = 480
+    viewer_content.style.width = 250
+
+    player.opened = frame
+
+    local instances = {}
+    local server_instances = Server.get_instances()
+    for _, i in pairs(server_instances) do
+        insert(instances, i)
+    end
+
+    local viewer_table = viewer_content.add {type = 'table', column_count = 3}
+    viewer_table.style.cell_padding = 4
+
+    sort(
+        instances,
+        function(a, b)
+            return a.id < b.id
+        end
+    )
+
+    if #instances <= 1 then
+        viewer_table.add {
+            type = 'label',
+            caption = 'No other instances online'
+        }
+    else
+        for _, i in ipairs(instances) do
+            viewer_table.add {
+                type = 'label',
+                caption = 'Name: ' .. i.name,
+                style = 'caption_label'
+            }
+            local flow = viewer_table.add {type = 'flow'}
+            flow.style.horizontal_align = 'right'
+            flow.style.horizontally_stretchable = true
+            local empty_flow = viewer_table.add {type = 'flow'}
+            local button =
+                empty_flow.add {
+                type = 'button',
+                caption = 'Connect',
+                tooltip = 'Click to connect to this server.',
+                name = instance_id_name
+            }
+            Gui.set_data(button, i.id)
+            apply_button_style(button)
+
+            if i.id == instance.id then
+                button.enabled = false
+                button.tooltip = 'You are here'
+            elseif i.status == 'unknown' then
+                button.enabled = i.game_port ~= nil
+                button.style.font_color = {r = 0.65}
+                button.style.hovered_font_color = {r = 0.65}
+                button.style.clicked_font_color = {r = 0.65}
+                button.style.disabled_font_color = {r = 0.75, g = 0.1, b = 0.1}
+                button.tooltip = 'Unknown status for this server'
+            elseif i.status ~= 'running' then
+                button.enabled = false
+                button.tooltip = 'This server is offline'
+            elseif i.version ~= instance.version then
+                button.enabled = false
+                button.style = 'red_button'
+                button.tooltip = 'On Factorio version ' .. i.version
+            end
+        end
+    end
+
+    local bottom_flow = frame.add {type = 'flow', direction = 'horizontal'}
+
+    local left_flow = bottom_flow.add {type = 'flow'}
+    left_flow.style.horizontal_align = 'left'
+    left_flow.style.horizontally_stretchable = true
+
+    local close_button = left_flow.add {type = 'button', name = discard_button_name, caption = 'Close'}
+    apply_button_style(close_button)
+
+    local right_flow = bottom_flow.add {type = 'flow'}
+    right_flow.style.horizontal_align = 'right'
+end
+
+local function toggle(player)
+    local left = player.gui.left
+    local frame = left[main_frame_name]
+    if not player or not player.valid or not player.character then
+        return
+    end
+    if frame and frame.valid then
+        Gui.remove_data_recursively(frame)
+        frame.destroy()
+    else
+        draw_main_frame(player)
+    end
+end
+
+local function create_main_button(event)
+    local player = game.get_player(event.player_index)
+    local b =
+        player.gui.top.add(
+        {
+            type = 'sprite-button',
+            sprite = 'utility/surface_editor_icon',
+            name = main_button_name
+        }
+    )
+    b.style.font_color = {r = 0.11, g = 0.8, b = 0.44}
+    b.style.font = 'heading-1'
+    b.style.minimal_height = 40
+    b.style.maximal_width = 40
+    b.style.minimal_width = 38
+    b.style.maximal_height = 38
+    b.style.padding = 1
+    b.style.margin = 0
+end
+
+Gui.on_click(
+    main_button_name,
+    function(event)
+        local player = event.player
+        if not player or not player.valid or not player.character then
+            return
+        end
+        toggle(player)
+    end
+)
+
+Gui.on_click(
+    discard_button_name,
+    function(event)
+        local player = event.player
+        if not player or not player.valid or not player.character then
+            return
+        end
+        toggle(player)
+    end
+)
+
+Gui.on_click(
+    instance_id_name,
+    function(event)
+        local player = event.player
+        if not player or not player.valid or not player.character then
+            return
+        end
+        local id = Gui.get_data(event.element)
+        local instance_id = tostring(id)
+        local server_instances = Server.get_instances()
+        local instance = server_instances[instance_id]
+
+        if instance and instance.game_port and instance.public_address then
+            player.connect_to_server {
+                address = instance.public_address .. ':' .. instance.game_port,
+                name = instance.name
+            }
+            toggle(player)
+        end
+    end
+)
+
+Event.add(defines.events.on_player_joined_game, create_main_button)

control.lua

@@ -36,6 +36,7 @@ require 'comfy_panel.group'
 require 'comfy_panel.poll'
 require 'comfy_panel.score'
 require 'comfy_panel.config'
+require 'comfy_panel.server_select'
 
 ---------------- !ENABLE MODULES HERE ----------------
 --require 'modules.admins_operate_biters'

utils/server.lua

@@ -28,6 +28,9 @@ local Public = {}
 local server_time = {secs = nil, tick = 0}
 local server_ups = {ups = 60}
 local start_data = {server_id = nil, server_name = nil, start_time = nil}
+local instances = {
+    data = {}
+}
 local requests = {}
 
 Global.register(
@@ -35,13 +38,15 @@ Global.register(
         server_time = server_time,
         server_ups = server_ups,
         start_data = start_data,
-        requests = requests
+        requests = requests,
+        instances = instances
     },
     function(tbl)
         server_time = tbl.server_time
         server_ups = tbl.server_ups
         start_data = tbl.start_data
         requests = tbl.requests
+        instances = tbl.instances
     end
 )
 
@@ -494,6 +499,26 @@ function Public.ping(func_token)
     raw_print(message)
 end
 
+--- The backend sets instances with data so a player
+-- can easily connect to another one via in-game.
+-- @param  data<table>
+function Public.set_instances(data)
+    if not data then
+        return
+    end
+    if not type(data) == 'table' then
+        return
+    end
+    for id, tbl in pairs(data) do
+        instances.data[id] = tbl
+    end
+end
+
+--- Gets each available/non-available instance
+function Public.get_instances()
+    return instances.data
+end
+
 local function double_escape(str)
     -- Excessive escaping because the data is serialized twice.
     return str:gsub('\\', '\\\\\\\\'):gsub('"', '\\\\\\"'):gsub('\n', '\\\\n')

utils/server_commands.lua

@@ -29,6 +29,7 @@ ServerCommands.set_ups = Server.set_ups
 ServerCommands.get_ups = Server.get_ups
 ServerCommands.export_stats = Server.export_stats
 ServerCommands.set_start_data = Server.set_start_data
+ServerCommands.set_instances = Server.set_instances
 ServerCommands.query_online_players = Server.query_online_players
 
 local SC_Interface = {