.

exp_scenario/module/commands/_authorities.lua

@@ -1,26 +1,28 @@
 --[[-- Command Authorities - Roles
-Adds a permission authority for exp roles
+Adds a permission authority which checks the clusterio permission for a command
 ]]
 
 local Commands = require("modules/exp_commands")
 local add, allow, deny = Commands.add_permission_authority, Commands.status.success, Commands.status.unauthorised
 
-local Roles = require("modules/exp_legacy/expcore/roles")
-local player_allowed = Roles.player_allowed
+local Roles = require("modules/exp_roles")
+local player_has_permission = Roles.player_has_permission
 
 local authorities = {}
 
---- If a command has the flag "character_only" then the command can only be used outside of remote view
+--- Every command requires the permission `exp_scenario.command.<name>`, with
+--- hyphens replaced by underscores, see permissions.ts for their definitions
 authorities.exp_permission =
     add(function(player, command)
-        if not player_allowed(player, command.flags.exp_permission or ("command/" .. command.name)) then
+        local permission = "exp_scenario.command." .. command.name:gsub("%-", "_")
+        if not player_has_permission(player, permission) then
             return deny{ "exp-commands-authorities_role.deny" }
         else
             return allow()
         end
     end)
 
-Roles.define_flag_trigger("is_system", function(player, state)
+Roles.define_permission_trigger("core.admin", function(player, state)
     if state then
         Commands.unlock_system_commands(player.name)
     else

exp_scenario/module/commands/_rcon.lua

@@ -8,6 +8,6 @@ local add_static, add_dynamic = Commands.add_rcon_static, Commands.add_rcon_dyna
 add_static("Gui", require("modules/exp_gui"))
 
 add_static("Group", require("modules.exp_legacy.expcore.permission_groups"))
-add_static("Roles", require("modules.exp_legacy.expcore.roles"))
+add_static("Roles", require("modules/exp_roles"))
 add_static("Datastore", require("modules.exp_legacy.expcore.datastore"))
 add_static("External", require("modules.exp_legacy.expcore.external"))

exp_scenario/module/commands/_types.lua

@@ -1,4 +1,3 @@
-
 --[[-- Command Types - Roles
 The data types that are used with exp_roles
 A lower role index indicates it is more privileged
@@ -11,28 +10,43 @@ Adds parsers for:
     lower_role_player_alive
 ]]
 
+local ExpUtil = require("modules/exp_util")
+local auto_complete = ExpUtil.auto_complete
+
 local Commands = require("modules/exp_commands")
 local add, parse = Commands.add_data_type, Commands.parse_input
 local valid, invalid = Commands.status.success, Commands.status.invalid_input
 
-local Roles = require("modules.exp_legacy.expcore.roles")
-local highest_role = Roles.get_player_highest_role
+local Roles = require("modules/exp_roles")
+local player_outranks = Roles.player_outranks
+local player_has_permission = Roles.player_has_permission
 
 local types = {} --- @class (partial) Commands.types
 
---- A role defined by exp roles
-types.role = add("role", Commands.types.key_of(Roles.config.roles))
+--- A role known to exp roles, matched on its name
+types.role =
+    add("role", function(input)
+        local names = {}
+        for index, role in ipairs(Roles.get_ordered_roles()) do
+            names[index] = role.name
+        end
+
+        local name = auto_complete(names, input)
+        if name == nil then
+            return invalid{ "exp-commands-parse.string-options", table.concat(names, ", ") }
+        else
+            return valid(Roles.get_role_by_name(name))
+        end
+    end)
 
 --- A role which is lower than the players highest role
 types.lower_role =
     add("lower_role", function(input, player)
         local success, status, result = parse(input, player, types.role)
         if not success then return status, result end
-        --- @cast result any TODO role is not a defined type
+        --- @cast result ExpRoles.Role
 
-        local player_highest = highest_role(player)
-        local is_root = Roles.config.internal.root == player_highest.name
-        if not is_root and player_highest.index >= result.index then
+        if not player_has_permission(player, "core.admin") and not Roles.get_player_highest_role(player):is_higher_than(result) then
             return invalid{ "exp-commands-parse_role.lower-role" }
         else
             return valid(result)
@@ -46,10 +60,7 @@ types.lower_role_player =
         if not success then return status, result end
         --- @cast result LuaPlayer
 
-        local other_highest = highest_role(result)
-        local player_highest = highest_role(player)
-        local is_root = Roles.config.internal.root == player_highest.name
-        if not is_root and player_highest.index >= other_highest.index then
+        if not player_outranks(player, result) then
             return invalid{ "exp-commands-parse_role.lower-role-player" }
         else
             return valid(result)
@@ -63,10 +74,7 @@ types.lower_role_player_online =
         if not success then return status, result end
         --- @cast result LuaPlayer
 
-        local other_highest = highest_role(result)
-        local player_highest = highest_role(player)
-        local is_root = Roles.config.internal.root == player_highest.name
-        if not is_root and player_highest.index >= other_highest.index then
+        if not player_outranks(player, result) then
             return invalid{ "exp-commands-parse_role.lower-role-player" }
         else
             return valid(result)
@@ -80,10 +88,7 @@ types.lower_role_player_alive =
         if not success then return status, result end
         --- @cast result LuaPlayer
 
-        local other_highest = highest_role(result)
-        local player_highest = highest_role(player)
-        local is_root = Roles.config.internal.root == player_highest.name
-        if not is_root and player_highest.index >= other_highest.index then
+        if not player_outranks(player, result) then
             return invalid{ "exp-commands-parse_role.lower-role-player" }
         else
             return valid(result)

exp_scenario/module/commands/kill.lua

@@ -4,8 +4,8 @@ Adds a command that allows players to kill themselves and others
 
 local Commands = require("modules/exp_commands")
 
-local Roles = require("modules.exp_legacy.expcore.roles") --- @dep expcore.roles
-local highest_role = Roles.get_player_highest_role
+local Roles = require("modules/exp_roles")
+local player_outranks = Roles.player_outranks
 
 --- Kills yourself or another player.
 Commands.new("kill", { "exp-commands_kill.description" })
@@ -20,7 +20,7 @@ Commands.new("kill", { "exp-commands_kill.description" })
         if other_player == nil then
             -- Can only be nil if the target is the player and they are already dead
             return Commands.status.error{ "exp-commands_kill.already-dead" }
-        elseif (other_player == player) or (highest_role(player).index < highest_role(other_player).index) then
+        elseif other_player == player or player_outranks(player, other_player) then
             -- You can always kill yourself or can kill lower role players
             if script.active_mods["space-age"] then
                 other_player.surface.create_entity{ name = "lightning", position = { other_player.position.x, other_player.position.y - 16 }, target = other_player.character }

exp_scenario/module/commands/protected_entities.lua

@@ -11,7 +11,7 @@ local expand_area = AABB.expand
 local Commands = require("modules/exp_commands")
 local format_player_name = Commands.format_player_name_locale
 
-local Roles = require("modules.exp_legacy.expcore.roles") --- @dep expcore.roles
+local Roles = require("modules/exp_roles")
 local EntityProtection = require("modules.exp_legacy.modules.control.protection") --- @dep modules.control.protection
 
 local format_string = string.format
@@ -218,13 +218,16 @@ SelectEntities:on_stop(on_player_selection_stop)
 
 --- When there is a repeat offence print it in chat
 local function on_repeat_violation(event)
-    Roles.print_to_roles_higher("Regular", {
-        "exp-commands_entity-protection.repeat-offence",
-        format_player_name(event.player_index),
-        event.entity.localised_name,
-        event.entity.position.x,
-        event.entity.position.y
-    })
+    local regular = Roles.get_role_by_name("Regular")
+    for _, role in ipairs(regular and Roles.get_higher_roles(regular) or {}) do
+        role:print{
+            "exp-commands_entity-protection.repeat-offence",
+            format_player_name(event.player_index),
+            event.entity.localised_name,
+            event.entity.position.x,
+            event.entity.position.y
+        }
+    end
 end
 
 return {

exp_scenario/module/commands/reports.lua

@@ -6,8 +6,8 @@ local Commands = require("modules/exp_commands")
 local format_player_name = Commands.format_player_name_locale
 local parse_input = Commands.parse_input
 
-local Roles = require("modules.exp_legacy.expcore.roles")
-local player_has_flag = Roles.player_has_flag
+local Roles = require("modules/exp_roles")
+local player_has_permission = Roles.player_has_permission
 
 local Reports = require("modules.exp_legacy.modules.control.reports") --- @dep modules.control.reports
 
@@ -20,7 +20,7 @@ local function reportable_player(input, player)
     if not success then return status, result end
     --- @cast result LuaPlayer
 
-    if player_has_flag(input, "report-immune") then
+    if player_has_permission(input, "exp_scenario.bypass.reports") then
         return Commands.status.invalid_input{ "exp-commands_reports.player-immune" }
     elseif player == input then
         return Commands.status.invalid_input{ "exp-commands_reports.self-report" }

exp_scenario/module/commands/roles.lua

@@ -6,8 +6,8 @@ local Commands = require("modules/exp_commands")
 local format_player_name = Commands.format_player_name_locale
 local format_text = Commands.format_rich_text_color_locale
 
-local Roles = require("modules.exp_legacy.expcore.roles") --- @dep expcore.roles
-local get_roles_ordered = Roles.get_roles_ordered
+local Roles = require("modules/exp_roles")
+local get_ordered_roles = Roles.get_ordered_roles
 local get_player_roles = Roles.get_player_roles
 
 --- Assigns a role to a player
@@ -18,8 +18,8 @@ Commands.new("assign-role", { "exp-commands_roles.description-assign" })
     :add_flags{ "admin_only" }
     :register(function(player, other_player, role)
         --- @cast other_player LuaPlayer
-        --- @cast role any -- TODO
-        Roles.assign_player(other_player, role, player.name)
+        --- @cast role ExpRoles.Role
+        role:assign(other_player, { by_player_name = player.name })
     end)
 
 --- Unassigns a role to a player
@@ -30,8 +30,8 @@ Commands.new("unassign-role", { "exp-commands_roles.description-unassign" })
     :add_flags{ "admin_only" }
     :register(function(player, other_player, role)
         --- @cast other_player LuaPlayer
-        --- @cast role any -- TODO
-        Roles.unassign_player(other_player, role, player.name)
+        --- @cast role ExpRoles.Role
+        role:unassign(other_player, { by_player_name = player.name })
     end)
 
 --- Lists all roles in they correct order
@@ -40,17 +40,17 @@ Commands.new("get-roles", { "exp-commands_roles.description-get" })
     :add_aliases{ "roles" }
     :register(function(player, other_player)
         --- @cast other_player LuaPlayer?
-        local roles = get_roles_ordered()
+        local roles = get_ordered_roles()
         local roles_formatted = { "" } --- @type LocalisedString
         local response = { "exp-commands_roles.list-roles", roles_formatted } --[[@as LocalisedString]]
         if other_player then
-            roles = get_player_roles(other_player)
+            roles = Roles.sort_roles(get_player_roles(other_player))
             response[1] = "exp-commands_roles.list-player"
             response[3] = format_player_name(other_player)
         end
 
         for index, role in ipairs(roles) do
-            local role_name = format_text(role.name, role.custom_color or Commands.color.white)
+            local role_name = format_text(role.name, role.color or Commands.color.white)
             roles_formatted[index + 1] = { "exp-commands_roles.list-element", role_name }
         end
 

exp_scenario/module/commands/teleport.lua

@@ -7,8 +7,8 @@ local teleport_player = ExpUtil.teleport_player
 
 local Commands = require("modules/exp_commands")
 
-local Roles = require("modules.exp_legacy.expcore.roles") --- @dep expcore.roles
-local player_allowed = Roles.player_allowed
+local Roles = require("modules/exp_roles")
+local player_has_permission = Roles.player_has_permission
 
 --- @class ExpCommands_Teleport.commands
 local commands = {}
@@ -85,7 +85,7 @@ commands.spawn = Commands.new("spawn", { "exp-commands_teleport.description-spaw
             if not teleport_player(player, game.surfaces.nauvis, { 0, 0 }, "dismount") then
                 return Commands.status.error{ "exp-commands_teleport.unavailable" }
             end
-        elseif player_allowed(player, "command/spawn/always") then
+        elseif player_has_permission(player, "exp_scenario.command.spawn.always") then
             if not teleport_player(other_player, game.surfaces.nauvis, { 0, 0 }, "dismount") then
                 return Commands.status.error{ "exp-commands_teleport.unavailable" }
             end

exp_scenario/module/control.lua

@@ -63,6 +63,7 @@ add(require("modules/exp_scenario/control/pollution_grading"))
 add(require("modules/exp_scenario/control/protection_jail"))
 add(require("modules/exp_scenario/control/report_jail"))
 add(require("modules/exp_scenario/control/research"))
+add(require("modules/exp_scenario/control/roles"))
 add(require("modules/exp_scenario/control/spawn_area"))
 add(require("modules/exp_scenario/control/station_auto_name"))
 

exp_scenario/module/control/bonus.lua

@@ -4,7 +4,7 @@ Various bonus related event handlers
 TODO Refactor this fully, this is temp to get it out of the player bonus gui file
 ]]
 
-local Roles = require("modules/exp_legacy/expcore/roles")
+local Roles = require("modules/exp_roles")
 local config = require("modules/exp_legacy/config/bonus")
 
 --- @param event EventData.on_force_created
@@ -26,7 +26,7 @@ end
 --- @param event EventData.on_player_died
 local function fast_respawn(event)
     local player = assert(game.get_player(event.player_index))
-    if Roles.player_has_flag(player, "instant-respawn") then
+    if Roles.player_has_permission(player, "exp_scenario.player.instant_respawn") then
         player.ticks_to_respawn = 120
     end
 end

exp_scenario/module/control/chat_auto_reply.lua

@@ -2,7 +2,7 @@
 Adds auto replies to chat messages, as well as chat commands
 ]]
 
-local Roles = require("modules.exp_legacy.expcore.roles")
+local Roles = require("modules/exp_roles")
 local config = require("modules.exp_legacy.config.chat_reply")
 local prefix = config.command_prefix
 local prefix_len = string.len(prefix)
@@ -20,7 +20,7 @@ local function on_console_chat(event)
     -- Check if the player can chat commands
     local commands_allowed = true
     if config.command_admin_only and not player.admin then commands_allowed = false end
-    if config.command_permission and not Roles.player_allowed(player, config.command_permission) then commands_allowed = false end
+    if config.command_permission and not Roles.player_has_permission(player, config.command_permission) then commands_allowed = false end
 
     -- Check if a key word appears in the message
     for key_word, reply in pairs(config.messages) do

exp_scenario/module/control/deconstruction_log.lua

@@ -3,7 +3,7 @@ Log certain actions into a file when events are triggered
 ]]
 
 local ExpUtil = require("modules/exp_util")
-local Roles = require("modules.exp_legacy.expcore.roles")
+local Roles = require("modules/exp_roles")
 local config = require("modules.exp_legacy.config.deconlog")
 
 local seconds_time_format = ExpUtil.format_time_factory{ format = "short", hours = true, minutes = true, seconds = true }
@@ -79,7 +79,7 @@ end
 local function get_log_player(event)
     local player = assert(game.get_player(event.player_index))
 
-    if Roles.player_has_flag(player, "deconlog-bypass") then
+    if Roles.player_has_permission(player, "exp_scenario.bypass.deconstruction_log") then
         return nil
     end
 

exp_scenario/module/control/fast_deconstruction.lua

@@ -4,7 +4,7 @@ Makes trees which are marked for decon "decay" quickly to allow faster building
 
 local Gui = require("modules/exp_gui")
 local Async = require("modules/exp_util/async")
-local Roles = require("modules.exp_legacy.expcore.roles")
+local Roles = require("modules/exp_roles")
 
 local PlayerData = require("modules.exp_legacy.expcore.player_data")
 local HasEnabledDecon = PlayerData.Settings:combine("HasEnabledDecon")
@@ -57,9 +57,9 @@ local remove_trees_async =
 --- @param player LuaPlayer
 --- @return "fast" | "allow" | "disallow"
 local function get_permission(player)
-    if Roles.player_allowed(player, "fast-tree-decon") then
+    if Roles.player_has_permission(player, "exp_scenario.decon.fast_trees") then
         return HasEnabledDecon:get(player) and "fast" or "allow"
-    elseif Roles.player_allowed(player, "standard-decon") then
+    elseif Roles.player_has_permission(player, "exp_scenario.decon.standard") then
         return "allow"
     else
         return "disallow"
@@ -101,7 +101,7 @@ Gui.toolbar.create_button{
     tooltip = { "exp_fast-decon.tooltip-main" },
     auto_toggle = true,
     visible = function(player, _)
-        return Roles.player_allowed(player, "fast-tree-decon")
+        return Roles.player_has_permission(player, "exp_scenario.decon.fast_trees")
     end
 }:on_click(function(def, player, element)
     local state = Gui.toolbar.get_button_toggled_state(def, player)

exp_scenario/module/control/nuke_protection.lua

@@ -3,7 +3,7 @@ Disable new players from having certain items in their inventory, most commonly
 ]]
 
 local ExpUtil = require("modules/exp_util")
-local Roles = require("modules.exp_legacy.expcore.roles")
+local Roles = require("modules/exp_roles")
 local config = require("modules.exp_legacy.config.nukeprotect")
 
 --- Check all items in the given inventory
@@ -12,14 +12,14 @@ local config = require("modules.exp_legacy.config.nukeprotect")
 --- @param banned_items string[]
 local function check_items(player, type, banned_items)
     -- If the player has perms to be ignored, then they should be
-    if config.ignore_permission and Roles.player_allowed(player, config.ignore_permission) then return end
+    if config.ignore_permission and Roles.player_has_permission(player, config.ignore_permission) then return end
     if config.ignore_admins and player.admin then return end
 
     local items = {} --- @type LuaItemStack[]
     local inventory = assert(player.get_inventory(type))
     -- Check what items the player has
     for i = 1, #inventory do
-        local item = inventory[i]
+        local item = inventory[i --[[@as uint]]]
         if item.valid_for_read and banned_items[item.name] then
             player.print{ "exp_nuke-protection.chat-found", item.prototype.localised_name }
             items[#items + 1] = item

exp_scenario/module/control/roles.lua

@@ -0,0 +1,21 @@
+--[[-- Control - Roles
+Applies the in game effects of the player permissions defined by the scenario
+]]
+
+local Gui = require("modules/exp_gui")
+local Roles = require("modules/exp_roles")
+
+Roles.define_permission_trigger("exp_scenario.player.admin", function(player, state)
+    player.admin = state
+end)
+
+Roles.define_permission_trigger("exp_scenario.player.spectator", function(player, state)
+    player.spectator = state
+end)
+
+return {
+    events = {
+        --- @diagnostic disable-next-line: access-invisible
+        [Roles.events.on_player_roles_changed] = Gui._ensure_consistency,
+    }
+}

exp_scenario/module/control/spawn_area.lua

@@ -5,8 +5,8 @@ Adds a custom spawn area with chests and afk turrets
 local config = require("modules.exp_legacy.config.spawn_area")
 
 --- Apply an offset to a LuaPosition
---- @param position MapPosition
---- @param offset MapPosition
+--- @param position MapPosition.struct
+--- @param offset MapPosition.struct
 --- @return MapPosition.struct
 local function apply_offset(position, offset)
     return {
@@ -17,7 +17,7 @@ end
 
 --- Apply offset to an array of positions
 --- @param positions table
---- @param offset MapPosition
+--- @param offset MapPosition.struct
 --- @param x_index number
 --- @param y_index number
 local function apply_offset_to_array(positions, offset, x_index, y_index)
@@ -97,14 +97,19 @@ local belt_details = {
 
 --- Makes a 2x2 afk belt at the locations in the config
 --- @param surface LuaSurface
---- @param offset MapPosition
+--- @param offset MapPosition.struct
 local function create_belts(surface, offset)
     local belt_type = config.afk_belts.belt_type
 
+    local entity_pos = { x = 0, y = 0 }
+    local group_offset = { x = 0, y = 0 }
     for _, position in pairs(config.afk_belts.locations) do
-        position = apply_offset(position, offset)
+        group_offset.x = position[1] + offset.x
+        group_offset.y = position[2] + offset.y
         for _, belt in pairs(belt_details) do
-            local pos = apply_offset(position, belt)
+            entity_pos.x = belt[1]
+            entity_pos.y = belt[2]
+            local pos = apply_offset(entity_pos, group_offset)
             local entity = surface.create_entity{ name = belt_type, position = pos, force = "neutral", direction = belt[3] }
             if entity and config.afk_belts.protected then
                 protect_entity(entity)
@@ -115,13 +120,16 @@ end
 
 -- Generates extra tiles in a set pattern as defined in the config
 --- @param surface LuaSurface
---- @param offset MapPosition
+--- @param offset MapPosition.struct
 local function create_pattern_tiles(surface, offset)
     local tiles_to_make = {}
     local pattern_tile = config.pattern.pattern_tile
 
+    local tile_pos = { x = 0, y = 0 }
     for index, position in pairs(config.pattern.locations) do
-        tiles_to_make[index] = { name = pattern_tile, position = apply_offset(position, offset) }
+        tile_pos.x = position[1]
+        tile_pos.y = position[2]
+        tiles_to_make[index] = { name = pattern_tile, position = apply_offset(tile_pos, offset) }
     end
 
     surface.set_tiles(tiles_to_make)
@@ -129,13 +137,16 @@ end
 
 -- Generates extra water as defined in the config
 --- @param surface LuaSurface
---- @param offset MapPosition
+--- @param offset MapPosition.struct
 local function create_water_tiles(surface, offset)
     local tiles_to_make = {}
     local water_tile = config.water.water_tile
 
+    local tile_pos = { x = 0, y = 0 }
     for _, position in pairs(config.water.locations) do
-        table.insert(tiles_to_make, { name = water_tile, position = apply_offset(position, offset) })
+        tile_pos.x = position[1]
+        tile_pos.y = position[2]
+        table.insert(tiles_to_make, { name = water_tile, position = apply_offset(tile_pos, offset) })
     end
 
     surface.set_tiles(tiles_to_make)
@@ -143,11 +154,17 @@ end
 
 --- Generates the entities that are in the config
 --- @param surface LuaSurface
---- @param offset MapPosition
+--- @param offset MapPosition.struct
 local function create_entities(surface, offset)
+    local entity_pos = { x = 0, y = 0 }
     for _, entity_details in pairs(config.entities.locations) do
-        local pos = apply_offset({ entity_details[2], entity_details[3] }, offset)
-        local entity = surface.create_entity{ name = entity_details[1], position = pos, force = "neutral" }
+        entity_pos.x = entity_details[2]
+        entity_pos.y = entity_details[3]
+        local entity = surface.create_entity{
+            name = entity_details[1],
+            position = apply_offset(entity_pos, offset),
+            force = "neutral"
+        }
 
         if entity then
             if config.entities.protected then
@@ -161,7 +178,7 @@ end
 
 --- Generates an area with no water or entities, no water area is larger
 --- @param surface LuaSurface
---- @param offset MapPosition
+--- @param offset MapPosition.struct
 local function clear_spawn_area(surface, offset)
     local get_tile = surface.get_tile
 
@@ -182,7 +199,7 @@ local function clear_spawn_area(surface, offset)
         for y = -fill_radius, fill_radius do -- loop over y
             local y_sqr = (y + 0.5) ^ 2
             local dst = x_sqr + y_sqr
-            local pos = apply_offset({ x, y }, offset)
+            local pos = apply_offset({ x = x, y = y }, offset)
             if dst < tile_radius_sqr then
                 -- If it is inside the decon radius always set the tile
                 tiles_to_make[#tiles_to_make + 1] = { name = decon_tile, position = pos }
@@ -204,14 +221,14 @@ end
 
 --- Spawn the resource tiles
 --- @param surface LuaSurface
---- @param offset MapPosition
+--- @param offset MapPosition.struct
 local function create_resources_tiles(surface, offset)
     for _, resource in ipairs(config.resource_tiles.resources) do
         if resource.enabled then
             local pos = apply_offset(resource.offset, offset)
             for x = pos.x, pos.x + resource.size[1] do
                 for y = pos.y, pos.y + resource.size[2] do
-                    surface.create_entity{ name = resource.name, amount = resource.amount, position = { x, y } }
+                    surface.create_entity{ name = resource.name, amount = resource.amount, position = { x = x, y = y } }
                 end
             end
         end
@@ -220,7 +237,7 @@ end
 
 --- Spawn the resource entities
 --- @param surface LuaSurface
---- @param offset MapPosition
+--- @param offset MapPosition.struct
 local function create_resource_patches(surface, offset)
     for _, resource in ipairs(config.resource_patches.resources) do
         if resource.enabled then

exp_scenario/module/gui/autofill.lua

@@ -3,7 +3,7 @@ Adds a config menu for setting autofill of placed entities
 ]]
 
 local Gui = require("modules/exp_gui")
-local Roles = require("modules.exp_legacy.expcore.roles")
+local Roles = require("modules/exp_roles")
 local config = require("modules.exp_legacy.config.gui.autofill")
 local FlyingText = require("modules/exp_util/flying_text")
 
@@ -330,7 +330,7 @@ Gui.toolbar.create_button{
     sprite = config.icon,
     tooltip = { "exp-gui_autofill.tooltip-main" },
     visible = function(player, element)
-        return Roles.player_allowed(player, "gui/autofill")
+        return Roles.player_has_permission(player, "exp_scenario.gui.autofill")
     end
 }
 

exp_scenario/module/gui/module_inserter.lua

@@ -4,7 +4,7 @@ Adds a Gui which creates an selection planner to insert modules into buildings
 
 local Gui = require("modules/exp_gui")
 local AABB = require("modules/exp_util/aabb")
-local Roles = require("modules/exp_legacy/expcore/roles")
+local Roles = require("modules/exp_roles")
 
 local Selection = require("modules/exp_util/selection")
 local SelectArea = Selection.connect("ModuleArea")
@@ -259,7 +259,7 @@ Gui.toolbar.create_button{
     sprite = "item/productivity-module-3",
     tooltip = { "exp-gui_module-inserter.tooltip-main" },
     visible = function(player, element)
-        return Roles.player_allowed(player, "gui/module")
+        return Roles.player_has_permission(player, "exp_scenario.gui.module")
     end
 }
 
@@ -459,7 +459,7 @@ local function on_entity_settings_pasted(event)
         -- Get the modules and add them to the planner
         local all_modules = {}
         for i = 1, #module_inventory do
-            local slot = module_inventory[i]
+            local slot = module_inventory[i --[[@as uint]]]
             if slot.valid_for_read and slot.count > 0 then
                 all_modules[i] = { name = slot.name, quality = slot.quality.name }
             else

exp_scenario/module/gui/player_bonus.lua

@@ -3,7 +3,7 @@ Adds a gui that allows players to apply various bonuses
 ]]
 
 local Gui = require("modules/exp_gui")
-local Roles = require("modules/exp_legacy/expcore/roles")
+local Roles = require("modules/exp_roles")
 local config = require("modules/exp_legacy/config/bonus")
 local vlayer = require("modules/exp_legacy/modules/control/vlayer")
 local format_number = require("util").format_number
@@ -68,7 +68,11 @@ do local _points_limit = {} --- @type table<number, number>
     --- @param player LuaPlayer
     --- @return number
     function Elements.bonus_used._calculate_points_limit(player)
-        local role_diff = Roles.get_role_by_name(config.points.role_name).index - Roles.get_player_highest_role(player).index
+        local roles = Roles.get_roles()
+        local positions = {}
+        for index, role in ipairs(roles) do positions[role.id] = index end
+        local role = assert(Roles.get_role_by_name(config.points.role_name), "Bonus points role does not exist")
+        local role_diff = positions[role.id] - positions[Roles.get_player_highest_role(player).id]
         local points_limit = math.floor(config.points.base * (1 + config.points.increase_percentage_per_role_level * role_diff))
         _points_limit[player.index] = points_limit
         return points_limit
@@ -458,19 +462,19 @@ Gui.toolbar.create_button{
     sprite = "item/exoskeleton-equipment",
     tooltip = { "exp-gui_player-bonus.tooltip-main" },
     visible = function(player, element)
-        return Roles.player_allowed(player, "gui/bonus")
+        return Roles.player_has_permission(player, "exp_scenario.gui.bonus")
     end
 }
 
 --- Recalculate and apply the bonus for a player
 local function recalculate_bonus(event)
     local player = Gui.get_player(event)
-    if event.name == Roles.events.on_role_assigned or event.name == Roles.events.on_role_unassigned then
+    if event.name == Roles.events.on_player_roles_changed then
         -- If the player's roles changed then we will need to recalculate their limit
         Elements.bonus_used._clear_points_limit_cache(player)
         local bonus_cost = Elements.container.calculate_cost(player)
         local within_limit = Elements.bonus_used.refresh_player(player, bonus_cost)
-        if not within_limit or not Roles.player_allowed(player, "gui/bonus") then
+        if not within_limit or not Roles.player_has_permission(player, "exp_scenario.gui.bonus") then
             Elements.container.clear_player_bonus(player)
             return
         end
@@ -512,7 +516,7 @@ end
 --- Apply the periodic bonus to all players
 local function apply_periodic_bonus_online()
     for _, player in pairs(game.connected_players) do
-        if player.character and Roles.player_allowed(player, "gui/bonus") then
+        if player.character and Roles.player_has_permission(player, "exp_scenario.gui.bonus") then
             apply_personal_battery_recharge(player)
         end
     end
@@ -524,8 +528,7 @@ return {
     elements = Elements,
     events = {
         [e.on_player_respawned] = recalculate_bonus,
-        [Roles.events.on_role_assigned] = recalculate_bonus,
-        [Roles.events.on_role_unassigned] = recalculate_bonus,
+        [Roles.events.on_player_roles_changed] = recalculate_bonus,
     },
     on_nth_tick = {
         [config.periodic_bonus_rate] = apply_periodic_bonus_online,

exp_scenario/module/gui/player_list.lua

@@ -4,7 +4,7 @@ Adds a player list to show names and play time; also includes action buttons whi
 
 local ExpUtil = require("modules/exp_util")
 local Gui = require("modules/exp_gui")
-local Roles = require("modules/exp_legacy/expcore/roles")
+local Roles = require("modules/exp_roles")
 local config = require("modules/exp_legacy/config/gui/player_list_actions")
 
 --- @class ExpGui_PlayerList.elements
@@ -203,7 +203,8 @@ function Elements.player_table.calculate_row_data()
     -- Flatten the roles into a single ordered list
     local count = 0
     local row_data = {}
-    for _, role_name in pairs(Roles.config.order) do
+    for _, role in ipairs(Roles.get_ordered_roles()) do
+        local role_name = role.name
         if players[role_name] then
             for _, player in pairs(players[role_name]) do
                 count = count + 1
@@ -360,7 +361,7 @@ function Elements.action_bar.refresh(action_bar, player, selected_player)
         if buttons.auth and not buttons.auth(player, selected_player) then
             flow.visible = false
         else
-            flow.visible = Roles.player_allowed(player, action_name)
+            flow.visible = Roles.player_has_permission(player, action_name)
         end
     end
 end
@@ -492,7 +493,7 @@ Gui.toolbar.create_button{
     sprite = "entity/character",
     tooltip = { "exp-gui_player-list.main-tooltip" },
     visible = function(player, element)
-        return Roles.player_allowed(player, "gui/player-list")
+        return Roles.player_has_permission(player, "exp_scenario.gui.player_list")
     end
 }
 
@@ -534,8 +535,7 @@ return {
     events = {
         [e.on_player_joined_game] = redraw_player_list,
         [e.on_player_left_game] = on_player_left_game,
-        [Roles.events.on_role_assigned] = redraw_player_list,
-        [Roles.events.on_role_unassigned] = redraw_player_list,
+        [Roles.events.on_player_roles_changed] = redraw_player_list,
     },
     on_nth_tick = {
         [1800] = refresh_player_times,

exp_scenario/module/gui/player_stats.lua

@@ -5,7 +5,7 @@ Displays the player data for a player
 local ExpUtil = require("modules/exp_util")
 local Gui = require("modules/exp_gui")
 local ElementsExtra = require("modules/exp_scenario/gui/elements")
-local Roles = require("modules/exp_legacy/expcore/roles")
+local Roles = require("modules/exp_roles")
 
 require("modules/exp_legacy/modules/data/statistics")
 local PlayerData = require("modules/exp_legacy/expcore/player_data")
@@ -214,7 +214,7 @@ Gui.toolbar.create_button{
     tooltip = { "exp-gui_player-stats.tooltip-main" },
     left_element = Elements.container,
     visible = function(player, element)
-        return Roles.player_allowed(player, "gui/playerdata")
+        return Roles.player_has_permission(player, "exp_scenario.gui.playerdata")
     end
 }
 

exp_scenario/module/gui/production_stats.lua

@@ -3,7 +3,7 @@ Adds a Gui for displaying item production stats
 ]]
 
 local Gui = require("modules/exp_gui")
-local Roles = require("modules/exp_legacy/expcore/roles")
+local Roles = require("modules/exp_roles")
 
 --- @class ExpGui_ProductionStats.elements
 local Elements = {}
@@ -250,7 +250,7 @@ Gui.toolbar.create_button{
     sprite = "entity/assembling-machine-3",
     tooltip = { "exp-gui_production-stats.tooltip-main" },
     visible = function(player, element)
-        return Roles.player_allowed(player, "gui/production")
+        return Roles.player_has_permission(player, "exp_scenario.gui.production")
     end
 }
 

exp_scenario/module/gui/quick_actions.lua

@@ -4,7 +4,7 @@ Adds a few buttons for common actions
 
 local Gui = require("modules/exp_gui")
 local Commands = require("modules/exp_commands")
-local Roles = require("modules/exp_legacy/expcore/roles")
+local Roles = require("modules/exp_roles")
 
 local addon_artillery = require("modules/exp_scenario/commands/artillery")
 local addon_trains = require("modules/exp_scenario/commands/trains")
@@ -116,7 +116,7 @@ Gui.toolbar.create_button{
     sprite = "item/repair-pack",
     tooltip = { "exp-gui_quick-actions.tooltip-main" },
     visible = function(player, element)
-        return Roles.player_allowed(player, "gui/tool")
+        return Roles.player_has_permission(player, "exp_scenario.gui.tool")
     end
 }
 
@@ -129,7 +129,6 @@ end
 return {
     elements = Elements,
     events = {
-        [Roles.events.on_role_assigned] = on_role_changed,
-        [Roles.events.on_role_unassigned] = on_role_changed,
+        [Roles.events.on_player_roles_changed] = on_role_changed,
     }
 }

exp_scenario/module/gui/readme.lua

@@ -4,7 +4,7 @@ Adds a main gui that contains important information about the server.
 
 local ExpUtil = require("modules/exp_util")
 local Gui = require("modules/exp_gui")
-local Roles = require("modules.exp_legacy.expcore.roles")
+local Roles = require("modules/exp_roles")
 local Commands = require("modules/exp_commands")
 local PlayerData = require("modules.exp_legacy.expcore.player_data")
 local External = require("modules.exp_legacy.expcore.external")
@@ -214,7 +214,7 @@ define_tab(
         container.add{ type = "flow" }.style.height = 4
 
         local role_names = {}
-        for i, role in ipairs(Roles.get_player_roles(player)) do
+        for i, role in ipairs(Roles.sort_roles(Roles.get_player_roles(player))) do
             role_names[i] = role.name
         end
 
@@ -392,14 +392,16 @@ define_tab(
 
         local done = {}
 
-        -- Fill groups from configured roles
-        for player_name, player_roles in pairs(Roles.config.players) do
-            for _, group in ipairs(groups) do
-                for _, role_name in ipairs(group.roles) do
-                    if table.contains(player_roles, role_name) then
+        -- Fill groups from the players who hold the roles, a player can be in more than one group
+        for _, group in ipairs(groups) do
+            local seen = {}
+            for _, role_name in ipairs(group.roles) do
+                local role = Roles.get_role_by_name(role_name)
+                for _, player_name in ipairs(role and role:get_player_names() or {}) do
+                    if not seen[player_name] then
+                        seen[player_name] = true
                         done[player_name] = true
                         group.players[#group.players + 1] = player_name
-                        break
                     end
                 end
             end
@@ -463,7 +465,7 @@ local function render_data_category(opts)
     for name, child in pairs(opts.children) do
         local metadata = child.metadata
 
-        if not metadata.permission or Roles.player_allowed(opts.player, metadata.permission) then
+        if not metadata.permission or Roles.player_has_permission(opts.player, metadata.permission) then
             local value = child:get(opts.player_name)
 
             if value ~= nil or metadata.show_always then
@@ -663,7 +665,7 @@ Elements.toggle_button = Gui.toolbar.create_button{
         sprite = "virtual-signal/signal-info",
         tooltip = { "exp-gui_readme.main-tooltip" },
         visible = function(player)
-            return Roles.player_allowed(player, "gui/readme")
+            return Roles.player_has_permission(player, "exp_scenario.gui.readme")
         end,
     }
     :on_click(function(_, player)

exp_scenario/module/gui/research_milestones.lua

@@ -4,7 +4,7 @@ Adds a gui for tracking research milestones
 
 local ExpUtil = require("modules/exp_util")
 local Gui = require("modules/exp_gui")
-local Roles = require("modules/exp_legacy/expcore/roles")
+local Roles = require("modules/exp_roles")
 local config = require("modules/exp_legacy/config/research")
 
 local table_to_json = helpers.table_to_json
@@ -294,9 +294,9 @@ end
 --- Get the achieved time for a force
 --- @param force LuaForce
 --- @param research_index number
---- @return number
+--- @return number?
 function Elements.container.get_achieved_time(force, research_index)
-    return assert(Elements.container.data[force][research_index])
+    return assert(Elements.container.data[force])[research_index]
 end
 
 --- Calculate the starting research index for a force
@@ -339,7 +339,7 @@ Gui.toolbar.create_button{
     sprite = "item/space-science-pack",
     tooltip = { "exp-gui_research-milestones.tooltip-main" },
     visible = function(player, element)
-        return Roles.player_allowed(player, "gui/research")
+        return Roles.player_has_permission(player, "exp_scenario.gui.research")
     end
 }
 

exp_scenario/module/gui/rocket_info.lua

@@ -4,7 +4,7 @@ Adds a rocket information gui which shows general stats, milestones and build pr
 
 local ExpUtil = require("modules/exp_util")
 local Gui = require("modules/exp_gui")
-local Roles = require("modules/exp_legacy/expcore/roles")
+local Roles = require("modules/exp_roles")
 local config = require("modules/exp_legacy/config/gui/rockets")
 
 --- @class ExpGui_RocketInfo.elements
@@ -651,7 +651,7 @@ Gui.toolbar.create_button{
     sprite = "item/rocket-silo",
     tooltip = { "exp-gui_rocket-info.tooltip-main" },
     visible = function(player, element)
-        return Roles.player_allowed(player, "gui/rocket-info")
+        return Roles.player_has_permission(player, "exp_scenario.gui.rocket_info")
     end
 }
 

exp_scenario/module/gui/science_production.lua

@@ -5,7 +5,7 @@ Adds a science info gui that shows production usage and net for the different sc
 local ExpUtil = require("modules/exp_util")
 local Gui = require("modules/exp_gui")
 local Colors = require("modules/exp_util/include/color")
-local Roles = require("modules/exp_legacy/expcore/roles")
+local Roles = require("modules/exp_roles")
 local config = require("modules/exp_legacy/config/gui/science")
 local _format_number = require("util").format_number
 
@@ -571,7 +571,7 @@ Gui.toolbar.create_button{
     sprite = "entity/lab",
     tooltip = { "exp-gui_science-production.tooltip-main" },
     visible = function(player, element)
-        return Roles.player_allowed(player, "gui/science-info")
+        return Roles.player_has_permission(player, "exp_scenario.gui.science_info")
     end
 }
 

exp_scenario/module/gui/surveillance.lua

@@ -4,7 +4,7 @@ Adds cameras which can be used to view players and locations
 
 local Gui = require("modules/exp_gui")
 local ElementsExtra = require("modules/exp_scenario/gui/elements")
-local Roles = require("modules/exp_legacy/expcore/roles")
+local Roles = require("modules/exp_roles")
 
 --- @class ExpGui_Surveillance.elements
 local Elements = {}
@@ -234,7 +234,7 @@ Gui.toolbar.create_button{
     sprite = "entity/radar",
     tooltip = { "exp-gui_surveillance.tooltip-main" },
     visible = function(player, element)
-        return Roles.player_allowed(player, "gui/surveillance")
+        return Roles.player_has_permission(player, "exp_scenario.gui.surveillance")
     end
 }:on_click(function(def, player, element, event)
     Elements.container(player.gui.screen)

exp_scenario/module/gui/task_list.lua

@@ -3,7 +3,7 @@ Adds a task list to the game which players can add, remove and edit items on
 ]]
 
 local Gui = require("modules/exp_gui")
-local Roles = require("modules.exp_legacy.expcore.roles")
+local Roles = require("modules/exp_roles")
 local config = require("modules.exp_legacy.config.gui.tasks")
 
 local ExpUtil = require("modules/exp_util")
@@ -43,8 +43,8 @@ local function has_permission_create_task(player)
         return true
     elseif allow_add_task == "admin" then
         return player.admin
-    elseif allow_add_task == "expcore.roles" then
-        return Roles.player_allowed(player, config.expcore_roles_allow_add_task)
+    elseif allow_add_task == "exp_roles" then
+        return Roles.player_has_permission(player, config.exp_roles_allow_add_task)
     end
 
     return false
@@ -67,8 +67,8 @@ local function has_permission_edit_task(player, task)
         return true
     elseif allow_edit_task == "admin" then
         return player.admin
-    elseif allow_edit_task == "expcore.roles" then
-        return Roles.player_allowed(player, config.expcore_roles_allow_edit_task)
+    elseif allow_edit_task == "exp_roles" then
+        return Roles.player_has_permission(player, config.exp_roles_allow_edit_task)
     end
 
     return false
@@ -922,7 +922,7 @@ Gui.toolbar.create_button{
     sprite = "utility/not_enough_repair_packs_icon",
     tooltip = { "exp-gui_task-list.tooltip-main" },
     visible = function(player, element)
-        return Roles.player_allowed(player, "gui/task-list")
+        return Roles.player_has_permission(player, "exp_scenario.gui.task_list")
     end
 }
 
@@ -950,7 +950,6 @@ return {
     events = {
         [e.on_player_joined_game] = refresh_player_tasks,
         [e.on_player_changed_force] = refresh_player_tasks,
-        [Roles.events.on_role_assigned] = refresh_player_permissions,
-        [Roles.events.on_role_unassigned] = refresh_player_permissions,
+        [Roles.events.on_player_roles_changed] = refresh_player_permissions,
     }
 }

exp_scenario/module/module.json

@@ -8,6 +8,7 @@
 	"dependencies": {
 		"clusterio": "*",
 		"exp_util": "*",
+		"exp_roles": "*",
 		"exp_gui": "*",
 		"exp_commands": "*"
 	}