diff --git a/config/_file_loader.lua b/config/_file_loader.lua index f6c11fcb..c4a5bba6 100644 --- a/config/_file_loader.lua +++ b/config/_file_loader.lua @@ -1,7 +1,8 @@ ---- This contains a list of all files that will be loaded and the order they are loaded in --- to stop a file from loading add "--" in front of it, remove the "--" to have the file be loaded --- config files should be loaded after all modules are loaded --- core files should be required by modules and not be present in this list +--- This contains a list of all files that will be loaded and the order they are loaded in; +-- to stop a file from loading add "--" in front of it, remove the "--" to have the file be loaded; +-- config files should be loaded after all modules are loaded; +-- core files should be required by modules and not be present in this list; +-- @config File-Loader return { --'example.file_not_loaded', 'modules.factorio-control', -- base factorio free play scenario diff --git a/config/action_buttons.lua b/config/action_buttons.lua index a98208f3..2e2fb9ae 100644 --- a/config/action_buttons.lua +++ b/config/action_buttons.lua @@ -1,17 +1,19 @@ ---- Config for the different action buttons that show on the player list --- each button has the button define(s) given along side an auth function, and optional reason callback --- if a reason callback is used then Store.set(action_name_store,player.name,'BUTTON_NAME') should be called during on_click --- buttons can be removed from the gui by commenting them out of the config at the bottom of this file --- the key used for the name of the button is the permission name used by the role system -local Gui = require 'expcore.gui' -local Roles = require 'expcore.roles' -local Store = require 'expcore.store' -local Game = require 'utils.game' -local Reports = require 'modules.control.reports' -local Warnings = require 'modules.control.warnings' -local Jail = require 'modules.control.jail' -local Colors = require 'resources.color_presets' -local format_chat_player_name = ext_require('expcore.common','format_chat_player_name') +--- Config for the different action buttons that show on the player list; +-- each button has the button define(s) given along side an auth function, and optional reason callback; +-- if a reason callback is used then Store.set(action_name_store,player.name,'BUTTON_NAME') should be called during on_click; +-- buttons can be removed from the gui by commenting them out of the config at the bottom of this file; +-- the key used for the name of the button is the permission name used by the role system; +-- @config Player-List + +local Gui = require 'expcore.gui' --- @dep expcore.gui +local Roles = require 'expcore.roles' --- @dep expcore.roles +local Store = require 'expcore.store' --- @dep expcore.store +local Game = require 'utils.game' --- @dep utils.game +local Reports = require 'modules.control.reports' --- @dep modules.control.reports +local Warnings = require 'modules.control.warnings' --- @dep modules.control.warnings +local Jail = require 'modules.control.jail' --- @dep modules.control.jail +local Colors = require 'resources.color_presets' --- @dep resources.color_presets +local format_chat_player_name = ext_require('expcore.common','format_chat_player_name') --- @dep expcore.common local action_player_store = 'gui.left.player-list.action-player' local action_name_store = 'gui.left.player-list.action-name' @@ -50,7 +52,8 @@ local function teleport(from_player,to_player) return true end --- teleports the user to the action player +--- Teleports the user to the action player +-- @element goto_player local goto_player = Gui.new_button() :set_sprites('utility/export') @@ -66,7 +69,8 @@ Gui.new_button() end end) --- teleports the action player to the user +--- Teleports the action player to the user +-- @element bring_player local bring_player = Gui.new_button() :set_sprites('utility/import') @@ -82,7 +86,8 @@ Gui.new_button() end end) --- kills the action player, if there are alive +--- Kills the action player, if there are alive +-- @element kill_player local kill_player = Gui.new_button() :set_sprites('utility/too_far') @@ -98,7 +103,8 @@ Gui.new_button() end end) --- reports the action player, requires a reason to be given +--- Reports the action player, requires a reason to be given +-- @element report_player local report_player = Gui.new_button() :set_sprites('utility/spawn_flag') @@ -121,7 +127,8 @@ local function report_player_callback(player,reason) Reports.report_player(action_player_name,player.name,reason) end --- gives the action player a warning, requires a reason +--- Gives the action player a warning, requires a reason +-- @element warn_player local warn_player = Gui.new_button() :set_sprites('utility/spawn_flag') @@ -138,7 +145,8 @@ local function warn_player_callback(player,reason) Warnings.add_warning(action_player_name,player.name,reason) end --- jails the action player, requires a reason +--- Jails the action player, requires a reason +-- @element jail_player local jail_player = Gui.new_button() :set_sprites('utility/item_editor_icon') @@ -160,7 +168,8 @@ local function jail_player_callback(player,reason) Jail.jail_player(action_player_name,player.name,reason) end --- temp bans the action player, requires a reason +--- Temp bans the action player, requires a reason +-- @element temp_ban_player local temp_ban_player = Gui.new_button() :set_sprites('utility/clock') @@ -182,7 +191,8 @@ local function temp_ban_player_callback(player,reason) Jail.temp_ban_player(action_player,player.name,reason) end --- kicks the action player, requires a reason +--- Kicks the action player, requires a reason +-- @element kick_player local kick_player = Gui.new_button() :set_sprites('utility/warning_icon') @@ -197,7 +207,8 @@ local function kick_player_callback(player,reason) game.kick_player(action_player,reason) end --- bans the action player, requires a reason +--- Bans the action player, requires a reason +-- @element ban_player local ban_player = Gui.new_button() :set_sprites('utility/danger_icon') diff --git a/config/advanced_start.lua b/config/advanced_start.lua index 586530ad..f490a9cb 100644 --- a/config/advanced_start.lua +++ b/config/advanced_start.lua @@ -1,4 +1,5 @@ --- This file is used to setup the map starting settings and the items players will start with +-- @config Advanced-Start --- These are called factories because they return another function -- use these as a simple methods of adding new items @@ -61,14 +62,14 @@ end ]] return { - skip_intro=true, -- skips the intro given in the default factorio free play scenario - skip_victory=true, -- will skip the victory screen when a rocket is launched - disable_base_game_silo_script=true, -- will not load the silo script at all - research_queue_from_start=true, -- when true the research queue is useible from the start - friendly_fire=false, -- weather players will be able to attack each other on the same force - enemy_expansion=false, -- a catch all for in case the map settings file fails to load - chart_radius=10*32, -- the number of tiles that will be charted when the map starts - items = { -- items and there condition for being given + skip_intro=true, --- @setting skip_intro skips the intro given in the default factorio free play scenario + skip_victory=true, --- @setting skip_victory will skip the victory screen when a rocket is launched + disable_base_game_silo_script=true, --- @setting disable_base_game_silo_script will not load the silo script at all + research_queue_from_start=true, --- @setting research_queue_from_start when true the research queue is useible from the start + friendly_fire=false, --- @setting friendly_fire weather players will be able to attack each other on the same force + enemy_expansion=false, --- @setting enemy_expansion a catch all for in case the map settings file fails to load + chart_radius=10*32, --- @setting chart_radius the number of tiles that will be charted when the map starts + items = { --- @setting items items and there condition for being given -- ['item-name'] = function(amount_made,production_stats,player) return end -- 0 means no items given -- Plates ['iron-plate']=scale_amount_made(100,10,10), diff --git a/config/bonuses.lua b/config/bonuses.lua index d74ddfbf..b96b48a2 100644 --- a/config/bonuses.lua +++ b/config/bonuses.lua @@ -1,4 +1,6 @@ --- Lists all bonuses which can be used, name followed by min max +-- @config Bonuses + return { character_mining_speed_modifier={0,3}, character_crafting_speed_modifier={0,3}, diff --git a/config/chat_reply.lua b/config/chat_reply.lua index db6d38d8..ca7d1700 100644 --- a/config/chat_reply.lua +++ b/config/chat_reply.lua @@ -1,8 +1,11 @@ --- This file defines the different triggers for the chat bot -local format_time = ext_require('expcore.common','format_time') +-- @config Chat-Reply + +local format_time = ext_require('expcore.common','format_time') --- @dep expcore.common + return { - allow_command_prefix_for_messages = true, -- when true any message trigger will print to all player when prefixed - messages = { -- will trigger when ever the word is said + allow_command_prefix_for_messages = true, --- @setting allow_command_prefix_for_messages when true any message trigger will print to all player when prefixed + messages = { --- @setting messages will trigger when ever the word is said ['discord']={'info.discord'}, ['expgaming']={'info.website'}, ['website']={'info.website'}, @@ -39,10 +42,10 @@ return { return {'chat-bot.map-time',format_time(game.tick,{days=true,hours=true,minutes=true,seconds=true,long=true})} end, }, - command_admin_only = false, -- when true will only allow chat commands for admins - command_permission = 'command/chat-bot', -- the permission used to allow command prefixes - command_prefix = '!', -- prefix used for commands below and to print to all players (if enabled above) - commands = { -- will trigger only when command prefix is given + command_admin_only = false, --- @setting command_admin_only when true will only allow chat commands for admins + command_permission = 'command/chat-bot', --- @setting command_permission the permission used to allow command prefixes + command_prefix = '!', --- @setting command_prefix prefix used for commands below and to print to all players (if enabled above) + commands = { --- @setting commands will trigger only when command prefix is given ['dev']={'chat-bot.not-real-dev'}, ['blame']=function(player) local names = {'Cooldude2606','arty714','badgamernl', 'mark9064', 'aldldl', 'Drahc_pro',player.name} diff --git a/config/compilatron.lua b/config/compilatron.lua index 116eb5b6..6b69601d 100644 --- a/config/compilatron.lua +++ b/config/compilatron.lua @@ -1,10 +1,12 @@ --- config file for the compliatrons including where they spawn and what messages they show +--- Config file for the compliatrons including where they spawn and what messages they show +-- @config Compilatron + return { - message_cycle=60*15, -- 15 seconds default, how often (in ticks) the messages will cycle - locations={ -- defines the spawn locations for all compilatrons + message_cycle=60*15, --- @setting message_cycle 15 seconds default, how often (in ticks) the messages will cycle + locations={ --- @setting locations defines the spawn locations for all compilatrons ['Spawn']={x=0,y=0} }, - messages={ -- the messages that each one will say, must be same name as its location + messages={ --- @setting messages the messages that each one will say, must be same name as its location ['Spawn']={ {'info.website'}, {'info.read-readme'}, diff --git a/config/death_logger.lua b/config/death_logger.lua index 7e03c2bb..1c5c578b 100644 --- a/config/death_logger.lua +++ b/config/death_logger.lua @@ -1,12 +1,14 @@ ---- This config controls what happens when a player dies mostly about map markers and item collection --- allow_teleport_to_body_command and allow_collect_bodies_command can be over ridden if command_auth_runtime_disable is present +--- This config controls what happens when a player dies mostly about map markers and item collection; +-- allow_teleport_to_body_command and allow_collect_bodies_command can be over ridden if command_auth_runtime_disable is present; -- if not present then the commands will not be loaded into the game +-- @config Death-Logger + return { - --allow_teleport_to_body_command=false, -- allows use of /return-to-body which teleports you to your last death - --allow_collect_bodies_command=false, -- allows use of /collect-body which returns all your items to you and removes the body - use_chests_as_bodies=false, -- weather items should be moved into a chest when a player dies - auto_collect_bodies=true, -- enables items being returned to the spawn point in chests upon corpse expiring - show_map_markers=true, -- shows markers on the map where bodies are - include_time_of_death=true, -- weather to include the time of death on the map marker - map_icon=nil -- the icon that the map marker shows; nil means no icon; format as a SingleID + --WIP_allow_teleport_to_body_command=false, -- allows use of /return-to-body which teleports you to your last death + --WIP_allow_collect_bodies_command=false, -- allows use of /collect-body which returns all your items to you and removes the body + use_chests_as_bodies=false, --- @setting use_chests_as_bodies weather items should be moved into a chest when a player dies + auto_collect_bodies=true, --- @setting auto_collect_bodies enables items being returned to the spawn point in chests upon corpse expiring + show_map_markers=true, --- @setting show_map_markers shows markers on the map where bodies are + include_time_of_death=true, --- @setting include_time_of_death weather to include the time of death on the map marker + map_icon=nil --- @setting map_icon the icon that the map marker shows; nil means no icon; format as a SingleID } \ No newline at end of file diff --git a/config/discord_alerts.lua b/config/discord_alerts.lua index 2eeb922f..1d2c58d0 100644 --- a/config/discord_alerts.lua +++ b/config/discord_alerts.lua @@ -1,4 +1,6 @@ --- Config file used to enable and disable different push messages for discord +-- @config Discord-Alerts + return { player_reports=true, player_warnings=true, diff --git a/config/expcore-commands/auth_admin.lua b/config/expcore-commands/auth_admin.lua index 19ef9198..5f2b8723 100644 --- a/config/expcore-commands/auth_admin.lua +++ b/config/expcore-commands/auth_admin.lua @@ -1,7 +1,9 @@ ---- This is a very simple config file which adds a admin only auth function --- not much to change here its more so it can be enabled and disabled from ./config/file_loader.lua +--- This is a very simple config file which adds a admin only auth functio; +-- not much to change here its more so it can be enabled and disabled from ./config/file_loader.lua; -- either way you can change the requirements to be "admin" if you wanted to -local Commands = require 'expcore.commands' +-- @config Commands-Auth-Admin + +local Commands = require 'expcore.commands' --- @dep expcore.commands Commands.add_authenticator(function(player,command,tags,reject) if tags.admin_only then diff --git a/config/expcore-commands/auth_roles.lua b/config/expcore-commands/auth_roles.lua index 3011166e..cb7e0db9 100644 --- a/config/expcore-commands/auth_roles.lua +++ b/config/expcore-commands/auth_roles.lua @@ -1,6 +1,8 @@ --- This will make commands only work if the role has been allowed it in the role config -local Commands = require 'expcore.commands' -local Roles = require 'expcore.roles' +-- @config Commands-Auth-Roles + +local Commands = require 'expcore.commands' --- @dep expcore.commands +local Roles = require 'expcore.roles' --- @dep expcore.roles Commands.add_authenticator(function(player,command,tags,reject) if Roles.player_allowed(player,'command/'..command) then diff --git a/config/expcore-commands/auth_runtime_disable.lua b/config/expcore-commands/auth_runtime_disable.lua index 0f4861fb..204869f5 100644 --- a/config/expcore-commands/auth_runtime_disable.lua +++ b/config/expcore-commands/auth_runtime_disable.lua @@ -1,17 +1,23 @@ ---- This config for command auth allows commands to be globally enabled and disabled during runtime +--- This config for command auth allows commands to be globally enabled and disabled during runtime; -- this config adds Commands.disable and Commands.enable to enable and disable commands for all users -local Commands = require 'expcore.commands' -local Global = require 'utils.global' +-- @config Commands-Auth-Runtime-Disable + +local Commands = require 'expcore.commands' --- @dep expcore.commands +local Global = require 'utils.global' --- @dep utils.global local disabled_commands = {} Global.register(disabled_commands,function(tbl) disabled_commands = tbl end) +--- Stops a command from be used by any one +-- @tparam string command_name the name of the command to disable function Commands.disable(command_name) disabled_commands[command_name] = true end +--- Allows a command to be used again after disable was used +-- @tparam string command_name the name of the command to enable function Commands.enable(command_name) disabled_commands[command_name] = nil end diff --git a/config/expcore-commands/parse_general.lua b/config/expcore-commands/parse_general.lua index 513aa845..7b9e282a 100644 --- a/config/expcore-commands/parse_general.lua +++ b/config/expcore-commands/parse_general.lua @@ -1,13 +1,10 @@ ---- This file contains some common command param parse functions --- this file is less of a config and more of a requirement but you may wish to change how some behave --- as such you need to be confident with lua but you edit this config file --- use Commands.add_parse('name',function(input,player,reject) end) to add a parse --- see ./expcore/commands.lua for more details -local Commands = require 'expcore.commands' -local Game = require 'utils.game' - ---[[ ->>>>Adds Parses: +--[[-- This file contains some common command param parse functions; +this file is less of a config and more of a requirement but you may wish to change how some behave; +as such you need to be confident with lua but you edit this config file; +use Commands.add_parse('name',function(input,player,reject) end) to add a parse; +see ./expcore/commands.lua for more details +@config Commands-Parse +@usage Adds Parses: boolean string-options - options: array string-max-length - max_length: number @@ -22,6 +19,11 @@ local Game = require 'utils.game' surface ]] +local Commands = require 'expcore.commands' --- @dep expcore.commands +local Game = require 'utils.game' --- @dep utils.game + + + Commands.add_parse('boolean',function(input,player,reject) if not input then return end -- nil check input = input:lower() diff --git a/config/expcore-commands/parse_roles.lua b/config/expcore-commands/parse_roles.lua index 3d468aaf..20b0d51f 100644 --- a/config/expcore-commands/parse_roles.lua +++ b/config/expcore-commands/parse_roles.lua @@ -1,7 +1,15 @@ ---- Adds some parse functions that can be used with the role system -local Commands = require 'expcore.commands' -local Roles = require 'expcore.roles' -local auto_complete = ext_require('expcore.common','auto_complete') +--[[-- Adds some parse functions that can be used with the role system +@config Commands-Parse-Roles +@usage Adds Parses: + role + player-role + player-role-online + player-role-alive +]] + +local Commands = require 'expcore.commands' --- @dep expcore.commands +local Roles = require 'expcore.roles' --- @dep expcore.roles +local auto_complete = ext_require('expcore.common','auto_complete') --- @dep expcore.common require 'config.expcore-commands.parse_general' Commands.add_parse('role',function(input,player,reject) diff --git a/config/permission_groups.lua b/config/permission_groups.lua index 9b2ac4f1..d3b4930d 100644 --- a/config/permission_groups.lua +++ b/config/permission_groups.lua @@ -1,10 +1,12 @@ ---- Use this file to add new permission groups to the game --- start with Permission_Groups.new_group('name') --- then use either :allow_all() or :disallow_all() to set the default for non specified actions +--- Use this file to add new permission groups to the game; +-- start with Permission_Groups.new_group('name'); +-- then use either :allow_all() or :disallow_all() to set the default for non specified actions; -- then use :allow{} and :disallow{} to specify certain actions to allow/disallow -local Event = require 'utils.event' -local Game = require 'utils.game' -local Permission_Groups = require 'expcore.permission_groups' +-- @config Permission-Groups + +--local Event = require 'utils.event' -- @dep utils.event +--local Game = require 'utils.game' -- @dep utils.game +local Permission_Groups = require 'expcore.permission_groups' --- @dep expcore.permission_groups Permission_Groups.new_group('Admin') :allow_all() diff --git a/config/pollution_grading.lua b/config/pollution_grading.lua index b19fd3ef..fdb73369 100644 --- a/config/pollution_grading.lua +++ b/config/pollution_grading.lua @@ -1,7 +1,9 @@ --- This controls how pollution is viewed on the map +--- This controls how pollution is viewed on the map +-- @config Pollution-Grading + return { - reference_point = {x=0,y=0}, -- where pollution is read from - max_scalar = 0.5, -- the scale between true max and max - min_scalar = 0.17, -- the scale between the lowest max and min - update_delay = 15 -- time in minutes between view updates + reference_point = {x=0,y=0}, --- @setting reference_point where pollution is read from + max_scalar = 0.5, --- @setting max_scalar the scale between true max and max + min_scalar = 0.17, --- @setting min_scalar the scale between the lowest max and min + update_delay = 15 --- @setting update_delay time in minutes between view updates } \ No newline at end of file diff --git a/config/popup_messages.lua b/config/popup_messages.lua index bee5b53c..75db9a47 100644 --- a/config/popup_messages.lua +++ b/config/popup_messages.lua @@ -1,8 +1,10 @@ --- A combination of config settings for different popup values like chat and damage +-- @config Popup-Messages + return { - show_player_messages=true, -- weather a message in chat will make a popup above them - show_player_mentions=true, -- weather a mentioned player will have a popup when mentioned in chat - show_player_damage=true, -- weather to show damage done by players - show_player_health=true, -- weather to show player health when attacked - damage_location_variance=0.8 -- how close to the eade of an entity the popups will appear + show_player_messages=true, --- @setting show_player_messages weather a message in chat will make a popup above them + show_player_mentions=true, --- @setting show_player_mentions weather a mentioned player will have a popup when mentioned in chat + show_player_damage=true, --- @setting show_player_damage weather to show damage done by players + show_player_health=true, --- @setting show_player_health weather to show player health when attacked + damage_location_variance=0.8 --- @setting damage_location_variance how close to the eade of an entity the popups will appear } \ No newline at end of file diff --git a/config/preset_player_colours.lua b/config/preset_player_colours.lua index d10fd64a..37a37792 100644 --- a/config/preset_player_colours.lua +++ b/config/preset_player_colours.lua @@ -1,6 +1,8 @@ --- preset colours that players get when they join the server, if not in the list then will be given a random colour (which isnt disallowed) +--- Preset colours that players get when they join the server, if not in the list then will be given a random colour (which isnt disallowed) +-- @config Preset-Player-Colours + return { - players={ + players={ --- @setting players list of all players and the colour in rgb256 that they will recive upon joining BADgamerNL={r=255,g=20,b=147}, arty714={r=150,g=68,b=161}, Cooldude2606={r=57,g=192,b=207}, @@ -13,7 +15,7 @@ return { cydes={r=82,g=249,b=155}, UUBlueFire={r=0,g=204,b=255} }, - disallow = { -- the value does not matter it is only the key which is checked + disallow = { --- @setting disallow colours which will not given to players; the value does not matter it is only the key which is checked black = {r = 0, g = 0, b = 0}, white = {r = 255, g = 255, b = 255}, jailed = {r = 255, g = 255, b = 255}, diff --git a/config/repair.lua b/config/repair.lua index 7a8e490c..0dbb1224 100644 --- a/config/repair.lua +++ b/config/repair.lua @@ -1,14 +1,16 @@ --- config file for the repair command +--- Config file for the repair command +-- @config Repair + return { - disallow = { -- items in this list will never be repaired + disallow = { --- @setting disallow items in this list will never be repaired ['loader']=true, ['fast-loader']=true, ['express-loader']=true, ['electric-energy-interface']=true, ['infinity-chest']=true }, - max_range=50, -- the max range that can be used with the repair command - allow_blueprint_repair=false, -- when true will allow blueprints (things not destroyed by biters) to be build instantly using the repair command - allow_ghost_revive=true, -- when true will allow ghosts (things destroyed by biters) to be build instantly using the repair command - allow_heal_entities=true -- when true will heal entities to full health that are within range + max_range=50, --- @setting max_range the max range that can be used with the repair command + allow_blueprint_repair=false, --- @setting allow_blueprint_repair when true will allow blueprints (things not destroyed by biters) to be build instantly using the repair command + allow_ghost_revive=true, --- @setting allow_ghost_revive when true will allow ghosts (things destroyed by biters) to be build instantly using the repair command + allow_heal_entities=true --- @setting allow_heal_entities when true will heal entities to full health that are within range } \ No newline at end of file diff --git a/config/rockets.lua b/config/rockets.lua index 3ce8428f..00432a9d 100644 --- a/config/rockets.lua +++ b/config/rockets.lua @@ -1,18 +1,20 @@ --- This file controls what will show in each section of the rocket info gui +-- @config Rockets + return { - stats = { --- The data that will show in the stats section - show_stats=true, -- false will hide this section all together - show_first_rocket = true, -- false will not show when the first rocket was launched - show_last_rocket = true, -- false will not show when the last rocket was launched - show_fastest_rocket = true, -- false will not show the time taken for the fastest rocket - show_total_rockets = true, -- false will not show the total number of rockets launched - show_game_avg = true, -- false will hide the avg across the entire map time - rolling_avg = { -- each number will be one statistic; 5 means the avg time taken for the last 5 rockets + stats = { --- @setting stats The data that will show in the stats section + show_stats=true, --- @setting show_stats false will hide this section all together + show_first_rocket = true, --- @setting show_first_rocket false will not show when the first rocket was launched + show_last_rocket = true, --- @setting show_last_rocket false will not show when the last rocket was launched + show_fastest_rocket = true, --- @setting show_fastest_rocket false will not show the time taken for the fastest rocket + show_total_rockets = true, --- @setting show_total_rockets false will not show the total number of rockets launched + show_game_avg = true, --- @setting show_game_avg false will hide the avg across the entire map time + rolling_avg = { --- @setting rolling_avg each number will be one statistic; 5 means the avg time taken for the last 5 rockets 5,10,25 } }, - milestones = { -- each number will be one statistic; 5 means the time that the 5th rocket was launched - show_milestones=true, -- false will hide this section all together + milestones = { --- @setting milestones each number will be one statistic; 5 means the time that the 5th rocket was launched + show_milestones=true, --- @setting show_milestones false will hide this section all together 1,2,5, 10,20,50, 100,200,500, @@ -20,14 +22,14 @@ return { 3000,3500,4000,4500, 5000 }, - progress = { --- The data and buttons in the build progress section - show_progress = true, -- false will hide this section altogether - allow_zoom_to_map = true, -- false will disable the zoom to map feature - allow_remote_launch = true, -- false removes the remote launch button for all players - remote_launch_admins_only = false, -- true will remove the remote launch button for all non (game) admins - remote_launch_role_permission = 'gui/rocket-info/remote_launch', -- value used by custom permission system to allow or disallow the button - allow_toggle_active = true, -- false removes the remote toggle auto launch button for all players - toggle_active_admins_only = false, -- true will remove the toggle auto launch button for all non (game) admins - toggle_active_role_permission = 'gui/rocket-info/toggle-active' -- value used by custom permission system to allow or disallow the button + progress = { --- @setting progress The data and buttons in the build progress section + show_progress = true, --- @setting show_progress false will hide this section altogether + allow_zoom_to_map = true, --- @setting allow_zoom_to_map false will disable the zoom to map feature + allow_remote_launch = true, --- @setting allow_remote_launch false removes the remote launch button for all players + remote_launch_admins_only = false, --- @setting remote_launch_admins_only true will remove the remote launch button for all non (game) admins + remote_launch_role_permission = 'gui/rocket-info/remote_launch', --- @setting remote_launch_role_permission value used by custom permission system to allow or disallow the button + allow_toggle_active = true, --- @setting allow_toggle_active false removes the remote toggle auto launch button for all players + toggle_active_admins_only = false, --- @setting toggle_active_admins_only true will remove the toggle auto launch button for all non (game) admins + toggle_active_role_permission = 'gui/rocket-info/toggle-active' --- @setting toggle_active_role_permission value used by custom permission system to allow or disallow the button } } \ No newline at end of file diff --git a/config/roles.lua b/config/roles.lua index 93fe875e..d46d08fe 100644 --- a/config/roles.lua +++ b/config/roles.lua @@ -1,5 +1,7 @@ --- This is the main config file for the role system; file includes defines for roles and role flags and default values -local Roles = require 'expcore.roles' +-- @config Roles + +local Roles = require 'expcore.roles' --- @dep expcore.roles -- Use these to adjust for ticks ie game.tick < 5*minutes local seconds, minutes, hours = 60, 3600, 216000 diff --git a/config/science.lua b/config/science.lua index f3ee8939..d9e77d5f 100644 --- a/config/science.lua +++ b/config/science.lua @@ -1,8 +1,10 @@ --- config file for the science info gui +--- Config file for the science info gui +-- @config Science + return { -- list of all science packs to be shown in the gui - show_eta=true, -- when true the eta for research completion will be shown - color_clamp=5, -- the amount required for the text to show as green or red - color_flux=0.1, -- the ammount of flucuation allowed in production before icon change + show_eta=true, --- @setting show_eta when true the eta for research completion will be shown + color_clamp=5, --- @setting color_clamp the amount required for the text to show as green or red + color_flux=0.1, --- @setting color_flux the ammount of flucuation allowed in production before icon change 'automation-science-pack', 'logistic-science-pack', 'military-science-pack', diff --git a/config/scorched_earth.lua b/config/scorched_earth.lua index 1a46e20d..64ab9568 100644 --- a/config/scorched_earth.lua +++ b/config/scorched_earth.lua @@ -1,7 +1,9 @@ --- This file controls the placement/degrading of tiles as players build and walk +-- @config Scorched-Earth + return { - weakness_value=50, -- lower value will make tiles more likely to degrade - strengths={ -- this decides how "strong" a tile is, bigger number means less likely to degrade + weakness_value=50, --- @setting weakness_value lower value will make tiles more likely to degrade + strengths={ --- @setting strengths this decides how "strong" a tile is, bigger number means less likely to degrade -- debug: /interface require('modules.addons.worn-paths')(player.name,true) -- note: tiles are effected by the tiles around them, so player paths will not degrade as fast when made wider -- note: values are relative to the tile with the highest value, recommended to keep highest tile as a "nice" number @@ -42,7 +44,7 @@ return { --["water-shallow"]=90, --["water-mud"]=0, -- last tile, nothing to degrade to }, - degrade_order={ -- when a tile degrades it will turn into the next tile given here + degrade_order={ --- @setting degrade_order when a tile degrades it will turn into the next tile given here ["refined-concrete"]='concrete', ["refined-hazard-concrete-left"]='hazard-concrete-left', ["refined-hazard-concrete-right"]='hazard-concrete-right', @@ -79,7 +81,7 @@ return { --["water-shallow"]='water-mud', --["water-mud"]=0, -- last tile, nothing to degrade to }, - entities={ -- entities in this list will degrade the tiles under them when they are placed + entities={ --- @setting entities entities in this list will degrade the tiles under them when they are placed ['stone-furnace']=true, ['steel-furnace']=true, ['electric-furnace']=true, diff --git a/config/spawn_area.lua b/config/spawn_area.lua index 4d8f8eaf..889fc20e 100644 --- a/config/spawn_area.lua +++ b/config/spawn_area.lua @@ -1,33 +1,35 @@ --- Used to config the spawn generation settings yes there is alot here i know just ignore the long tables at the end (they were generated with a command) +-- @config Spawn-Area + return { - infinite_ammo_turrets = { -- These turrets will have they ammo refilled automatically and can not be looted - enabled=true, -- weather the turrets will be created and refilled - ammo_type='uranium-rounds-magazine', -- the ammo type that will be used - locations={ -- locations of all turrets, this is default it can be changed during runtime + infinite_ammo_turrets = { --- @setting infinite_ammo_turrets These turrets will have they ammo refilled automatically and can not be looted + enabled=true, --- @setting enabled weather the turrets will be created and refilled + ammo_type='uranium-rounds-magazine', --- @setting ammo_type the ammo type that will be used + locations={ --- @setting locations locations of all turrets, this is default it can be changed during runtime {surface=1,position={x=-3,y=-3}}, {surface=1,position={x=3 ,y=-3}}, {surface=1,position={x=-3,y=3 }}, {surface=1,position={x=3 ,y=3 }} } }, - afk_belts = { - enabled=true, -- weather afk belts will be generated - locations={ -- top left connors of any afk belt loops to be added + afk_belts = { --- @setting afk_belts setting relating to afk belts round the spawn point + enabled=true, --- @setting enabled weather afk belts will be generated + locations={ --- @setting locations top left connors of any afk belt loops to be added {x=-5,y=-5}, {x=5, y=-5}, {x=-5,y=5 }, {x=5, y=5 } } }, - corrections = { -- Some settings that have no where else to go - protect_entities=true, - offset = {x=0,y=-2}, -- a global offset value to correct the x and y values of the tables below - deconstruction_radius=20, -- when the spawn is made this area will have all entities removed first - deconstruction_tile='concrete', -- this is the tile that will spawn in the deconstruction radius - pattern_radius = 50, -- this is the radius of the pattern all water in this area will be filled - pattern_tile = 'stone-path' -- the tile that is used for the pattern + corrections = { --- @setting corrections Some settings that have no where else to go + protect_entities=true, --- @setting protect_entities if the spawn entites will be protected + offset = {x=0,y=-2}, --- @setting offset a global offset value to correct the x and y values of the tables below + deconstruction_radius=20, --- @setting deconstruction_radius when the spawn is made this area will have all entities removed first + deconstruction_tile='concrete', --- @setting deconstruction_tile this is the tile that will spawn in the deconstruction radius + pattern_radius = 50, --- @setting pattern_radius this is the radius of the pattern all water in this area will be filled + pattern_tile = 'stone-path' --- @setting pattern_tile the tile that is used for the pattern }, - entities = { -- All entities that will be created as part of spawn {entity-name,x-pos,y-pos} + entities = { --- @setting entities All entities that will be created as part of spawn {entity-name,x-pos,y-pos} {"stone-wall",-10,-6},{"stone-wall",-10,-5},{"stone-wall",-10,-4},{"stone-wall",-10,-3},{"stone-wall",-10,-2},{"stone-wall",-10,-1},{"stone-wall",-10,0},{"stone-wall",-10,3},{"stone-wall",-10,4},{"stone-wall",-10,5}, {"stone-wall",-10,6},{"stone-wall",-10,7},{"stone-wall",-10,8},{"stone-wall",-10,9},{"stone-wall",-8,-8},{"small-lamp",-8,-4},{"small-lamp",-8,-1},{"iron-chest",-8,0},{"iron-chest",-8,3},{"small-lamp",-8,4}, {"small-lamp",-8,7},{"stone-wall",-8,11},{"stone-wall",-7,-8},{"small-electric-pole",-7,-2},{"iron-chest",-7,0},{"iron-chest",-7,3},{"small-electric-pole",-7,5},{"stone-wall",-7,11},{"stone-wall",-6,-8},{"small-lamp",-6,-6}, @@ -43,7 +45,7 @@ return { {"stone-wall",9,-4},{"stone-wall",9,-3},{"stone-wall",9,-2},{"stone-wall",9,-1},{"stone-wall",9,0},{"stone-wall",9,3},{"stone-wall",9,4},{"stone-wall",9,5},{"stone-wall",9,6},{"stone-wall",9,7}, {"stone-wall",9,8},{"stone-wall",9,9} }, - tiles = { -- The location of the "pattern" tiles {x-pos,y-pos} + tiles = { --- @setting tiles The location of the "pattern" tiles {x-pos,y-pos} {-49,-3},{-49,-2},{-49,1},{-49,2},{-49,5},{-49,6},{-48,-4},{-48,-3},{-48,-2},{-48,1},{-48,2},{-48,5},{-48,6},{-48,7},{-47,-7},{-47,-6},{-47,-5},{-47,-4},{-47,-3},{-47,-2},{-47,5},{-47,6},{-47,7},{-47,8},{-47,9},{-47,10},{-46,-8},{-46,-7},{-46,-6},{-46,-5}, {-46,-4},{-46,-3},{-46,-2},{-46,-1},{-46,4},{-46,5},{-46,6},{-46,7},{-46,8},{-46,9},{-46,10},{-46,11},{-45,-17},{-45,-16},{-45,-15},{-45,-14},{-45,-13},{-45,-12},{-45,-9},{-45,-8},{-45,-7},{-45,-2},{-45,-1},{-45,0},{-45,1},{-45,2},{-45,3},{-45,4},{-45,5},{-45,10}, {-45,11},{-45,12},{-45,15},{-45,16},{-45,17},{-45,18},{-45,19},{-45,20},{-44,-18},{-44,-17},{-44,-16},{-44,-15},{-44,-14},{-44,-13},{-44,-12},{-44,-9},{-44,-8},{-44,-1},{-44,0},{-44,1},{-44,2},{-44,3},{-44,4},{-44,11},{-44,12},{-44,15},{-44,16},{-44,17},{-44,18},{-44,19}, diff --git a/config/tasks.lua b/config/tasks.lua index ac39ea40..95165ee0 100644 --- a/config/tasks.lua +++ b/config/tasks.lua @@ -1,7 +1,9 @@ --- config file for the tasks gui +--- Config file for the tasks gui +-- @config Tasks + return { - any_user_can_add_new_task = true, -- when false only people with edit permission can make new reports - user_can_edit_own_tasks = true, -- when false only people with edit permission can edit reports - only_admins_can_edit = false, -- true will hide the edit and delete buttons from non (game) admins - edit_tasks_role_permission = 'gui/task-list/edit' -- value used with custom permission system + any_user_can_add_new_task = true, --- @setting any_user_can_add_new_task when false only people with edit permission can make new reports + user_can_edit_own_tasks = true, --- @setting user_can_edit_own_tasks when false only people with edit permission can edit reports + only_admins_can_edit = false, --- @setting only_admins_can_edit true will hide the edit and delete buttons from non (game) admins + edit_tasks_role_permission = 'gui/task-list/edit' --- @setting edit_tasks_role_permission value used with custom permission system } \ No newline at end of file diff --git a/config/warnings.lua b/config/warnings.lua index 73696544..24f85867 100644 --- a/config/warnings.lua +++ b/config/warnings.lua @@ -1,6 +1,8 @@ --- Config file for the warning system, this is very similar to reports but is for the use of moderators rather than normal users. +-- @config Warnings + return { - actions = { -- what actions are taking at number of warnings + actions = { --- @setting actions what actions are taking at number of warnings -- if a localized string is used then __1__ will by_player_name and __2__ will be the current warning count (auto inserted) {'warnings.received',''}, {'warnings.received',''}, @@ -14,6 +16,6 @@ return { game.ban_player(player,{'warnings.received',by_player_name,number_of_warnings,{'warnings.ban',{'links.website'}}}) end }, - script_warning_cool_down=30, -- time for a script warning (given by script) to be removed (in minutes) - script_warning_limit=5 -- the number of script warnings (given by script) that are allowed before full warnings are given + script_warning_cool_down=30, --- @setting script_warning_cool_down time for a script warning (given by script) to be removed (in minutes) + script_warning_limit=5 --- @setting script_warning_limit the number of script warnings (given by script) that are allowed before full warnings are given } \ No newline at end of file diff --git a/config/warps.lua b/config/warps.lua index db9ace2b..fb620108 100644 --- a/config/warps.lua +++ b/config/warps.lua @@ -1,23 +1,25 @@ --- This file contains all the different settings for the warp system and gui +-- @config Warps + return { - recharge_time = 60, -- The amount of time in seconds that the player must wait between warps, acts as a balance - update_smoothing = 10, -- Higher is better, the amount of smoothing applied to recharge timer and other gui updates, max is 60 - minimum_distance = 100, -- The minimum distance that must be between warp points, creating new ones is blocked when too close - activation_range = 4, -- The distance the player must be to a warp in order to use the warp gui, gui can still be viewed but not used - spawn_activation_range = 20, -- A second activation range which is used for the forces spawn point - default_icon = 'discharge-defense-equipment', -- The default icon which is used by warps; must be an item name - user_can_edit_own_warps = false, -- When true the user can always edit warps which they created regardless of other settings - any_user_can_add_new_warp = false, -- When true any user is able to create new warps, however editing may still be restricted - only_admins_can_edit = false, -- When true only admins can edit warps - edit_warps_role_permission = 'gui/warp-list/edit', -- Role permission used by the role system to allow editing warps - bypass_warp_limits_permission = 'gui/warp-list/no-limit', -- Role permission used by the role system to allow bypassing the time and distance restrictions - entities = { -- The entities which are created for warps + recharge_time = 60, --- @setting recharge_time The amount of time in seconds that the player must wait between warps, acts as a balance + update_smoothing = 10, --- @setting update_smoothing Higher is better, the amount of smoothing applied to recharge timer and other gui updates, max is 60 + minimum_distance = 100, --- @setting minimum_distance The minimum distance that must be between warp points, creating new ones is blocked when too close + activation_range = 4, --- @setting activation_range The distance the player must be to a warp in order to use the warp gui, gui can still be viewed but not used + spawn_activation_range = 20, --- @setting spawn_activation_range A second activation range which is used for the forces spawn point + default_icon = 'discharge-defense-equipment', --- @setting default_icon The default icon which is used by warps; must be an item name + user_can_edit_own_warps = false, --- @setting user_can_edit_own_warps When true the user can always edit warps which they created regardless of other settings + any_user_can_add_new_warp = false, --- @setting any_user_can_add_new_warp When true any user is able to create new warps, however editing may still be restricted + only_admins_can_edit = false, --- @setting only_admins_can_edit When true only admins can edit warps + edit_warps_role_permission = 'gui/warp-list/edit', --- @setting edit_warps_role_permission Role permission used by the role system to allow editing warps + bypass_warp_limits_permission = 'gui/warp-list/no-limit', --- @setting bypass_warp_limits_permission Role permission used by the role system to allow bypassing the time and distance restrictions + entities = { --- @setting entities The entities which are created for warps {'small-lamp',-3,-2},{'small-lamp',-3,2},{'small-lamp',3,-2},{'small-lamp',3,2}, {'small-lamp',-2,-3},{'small-lamp',2,-3},{'small-lamp',-2,3},{'small-lamp',2,3}, {'small-electric-pole',-3,-3},{'small-electric-pole',3,3},{'small-electric-pole',-3,3},{'small-electric-pole',3,-3} }, - base_tile = 'tutorial-grid', -- The tile which is used for the warps - tiles = { -- The tiles which are created for warps + base_tile = 'tutorial-grid', --- @setting base_tile The tile which is used for the warps + tiles = { --- @setting tiles The tiles which are created for warps {-3,-2},{-3,-1},{-3,0},{-3,1},{-3,2},{3,-2},{3,-1},{3,0},{3,1},{3,2}, {-2,-3},{-1,-3},{0,-3},{1,-3},{2,-3},{-2,3},{-1,3},{0,3},{1,3},{2,3} } diff --git a/control.lua b/control.lua index 29d79064..82237d76 100644 --- a/control.lua +++ b/control.lua @@ -18,15 +18,15 @@ require 'utils.print_override' require 'utils.math' -- Global Debug and make sure our version file is registered -Debug = require 'utils.debug' +Debug = require 'utils.debug' --- @dep utils.debug require 'resources.version' -- Global require function used to extract parts of a module, because simply being in common is not good enough -ext_require = require('expcore.common').ext_require +ext_require = require('expcore.common').ext_require --- @dep expcore.common.ext_require -- Please go to config/file_loader.lua to edit the files that are loaded log('[INFO] Getting file loader config') -local files = require 'config._file_loader' +local files = require 'config._file_loader' --- @dep config._file_loader -- Loads all files from the config and logs that they are loaded local total_file_count = string.format('%3d',#files) @@ -50,6 +50,10 @@ for index,path in pairs(files) do end +-- Override the default require; require can no longer load new scripts +log('[INFO] Require Overright! No more requires can be made!') +require 'utils.require_override' + -- Logs all errors again to make it make it easy to find log('[INFO] All files loaded with '..#errors..' errors:') for _,error in pairs(errors) do log(error) end diff --git a/doc/addons/Advanced-Start.html b/doc/addons/Advanced-Start.html new file mode 100644 index 00000000..0b56fc11 --- /dev/null +++ b/doc/addons/Advanced-Start.html @@ -0,0 +1,356 @@ + + + + + + + + Advanced-Start addon + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Advanced-Start addon

+

Adds a better method of player starting items based on production levels.

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + + + + +
utils.event
utils.game
config.advanced_start
+ + +
+ + +

Dependencies

+
+
+
+
+ # + utils.event +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.game +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + config.advanced_start +
+
+
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/addons/Chat-Popups.html b/doc/addons/Chat-Popups.html new file mode 100644 index 00000000..75114dcc --- /dev/null +++ b/doc/addons/Chat-Popups.html @@ -0,0 +1,357 @@ + + + + + + + + Chat-Popups addon + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Chat-Popups addon

+

Creates flying text entities when a player sends a message in chat; + also displays a ping above users who are named in the message

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + + + + +
utils.game
utils.event
config.popup_messages
+ + +
+ + +

Dependencies

+
+
+
+
+ # + utils.game +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.event +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + config.popup_messages +
+
+
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/addons/Chat-Reply.html b/doc/addons/Chat-Reply.html new file mode 100644 index 00000000..be18394a --- /dev/null +++ b/doc/addons/Chat-Reply.html @@ -0,0 +1,384 @@ + + + + + + + + Chat-Reply addon + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Chat-Reply addon

+

Adds auto replies to chat messages; aswell as chat commands

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + + + + + + + +
utils.event
utils.game
expcore.roles
config.chat_reply
+ + +
+ + +

Dependencies

+
+
+
+
+ # + utils.event +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.game +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.roles +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + config.chat_reply +
+
+
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/addons/Compilatron.html b/doc/addons/Compilatron.html new file mode 100644 index 00000000..3ad91922 --- /dev/null +++ b/doc/addons/Compilatron.html @@ -0,0 +1,593 @@ + + + + + + + + Compilatron addon + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Compilatron addon

+

Adds a compilatron that walks around the spawn area; adapted from redmew code

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + + + + + + + + + + + + + +
utils.event
utils.global
utils.game
utils.task
utils.token
config.compilatron
+ + +

Functions

+ + + + + + + + + + + + +
Public.add_compilatron(entity, name)This will add a compilatron to the global and start his message cycle
Public.spawn_compilatron(surface, location)This spawns a new compilatron on a surface with the given location tag (not a position)
+ + +
+ + +

Dependencies

+
+
+
+
+ # + utils.event +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.global +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.game +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.task +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.token +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + config.compilatron +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Functions

+
+
+
+
+ # + Public.add_compilatron(entity, name) +
+
+
+
+ +

This will add a compilatron to the global and start his message cycle

+

+ + + Parameters: + +
    + + + + + +
  • + + entity + + : + + (LuaEntity) + + the compilatron entity that moves around + +
  • + + + + + +
  • + + name + + : + + (string) + + the name of the location that the complitron is at + +
  • + + +
+ + + + + + + + + + + + + +
+
+
+
+ # + Public.spawn_compilatron(surface, location) +
+
+
+
+ +

This spawns a new compilatron on a surface with the given location tag (not a position)

+

+ + + Parameters: + +
    + + + + + +
  • + + surface + + : + + (LuaSurface) + + the surface to spawn the compilatron on + +
  • + + + + + +
  • + + location + + : + + (string) + + the location tag that is in the config file + +
  • + + +
+ + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/addons/Damage-Popups.html b/doc/addons/Damage-Popups.html new file mode 100644 index 00000000..42cd4094 --- /dev/null +++ b/doc/addons/Damage-Popups.html @@ -0,0 +1,357 @@ + + + + + + + + Damage-Popups addon + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Damage-Popups addon

+

Displays the amount of dmg that is done by players to entities; + also shows player health when a player is attacked

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + + + + +
utils.game
utils.event
config.popup_messages
+ + +
+ + +

Dependencies

+
+
+
+
+ # + utils.game +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.event +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + config.popup_messages +
+
+
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/addons/Death-Logger.html b/doc/addons/Death-Logger.html new file mode 100644 index 00000000..01b1f797 --- /dev/null +++ b/doc/addons/Death-Logger.html @@ -0,0 +1,412 @@ + + + + + + + + Death-Logger addon + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Death-Logger addon

+

Makes markers on the map where places have died and reclaims items if not recovered

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + + + + + + + + + + +
utils.event
utils.game
utils.global
config.death_logger
expcore.common
+ + +
+ + +

Dependencies

+
+
+
+
+ # + utils.event +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.game +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.global +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + config.death_logger +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.common +
+
+
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/addons/Discord-Alerts.html b/doc/addons/Discord-Alerts.html new file mode 100644 index 00000000..cce518e8 --- /dev/null +++ b/doc/addons/Discord-Alerts.html @@ -0,0 +1,468 @@ + + + + + + + + Discord-Alerts addon + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Discord-Alerts addon

+

Sends alert messages to our discord server when certain events are triggered

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + + + + + + + + + + + + + + + + +
utils.event
utils.game
resources.color_presets
expcore.common
config.discord_alerts
modules.control.reports
modules.control.warnings
+ + +
+ + +

Dependencies

+
+
+
+
+ # + utils.event +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.game +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + resources.color_presets +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.common +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + config.discord_alerts +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + modules.control.reports +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + modules.control.warnings +
+
+
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/addons/Player-Colours.html b/doc/addons/Player-Colours.html new file mode 100644 index 00000000..d17bb676 --- /dev/null +++ b/doc/addons/Player-Colours.html @@ -0,0 +1,412 @@ + + + + + + + + Player-Colours addon + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Player-Colours addon

+

Gives players random colours when they join, also applies preset colours to those who have them

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + + + + + + + + + + +
resources.color_presets
utils.game
utils.event
config.preset_player_colours
utils.global
+ + +
+ + +

Dependencies

+
+
+
+
+ # + resources.color_presets +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.game +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.event +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + config.preset_player_colours +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.global +
+
+
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/addons/Pollution-Grading.html b/doc/addons/Pollution-Grading.html new file mode 100644 index 00000000..bfc08f0d --- /dev/null +++ b/doc/addons/Pollution-Grading.html @@ -0,0 +1,328 @@ + + + + + + + + Pollution-Grading addon + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Pollution-Grading addon

+

Makes polution look much nice of the map, ie not one big red mess

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + +
utils.event
config.pollution_grading
+ + +
+ + +

Dependencies

+
+
+
+
+ # + utils.event +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + config.pollution_grading +
+
+
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/addons/Scorched-Earth.html b/doc/addons/Scorched-Earth.html new file mode 100644 index 00000000..09d37fe9 --- /dev/null +++ b/doc/addons/Scorched-Earth.html @@ -0,0 +1,412 @@ + + + + + + + + Scorched-Earth addon + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Scorched-Earth addon

+

When a player walks around the tiles under them will degrade over time, the same is true when entites are built

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + + + + + + + + + + +
utils.event
utils.game
utils.global
expcore.common
config.scorched_earth
+ + +
+ + +

Dependencies

+
+
+
+
+ # + utils.event +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.game +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.global +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.common +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + config.scorched_earth +
+
+
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/addons/Spawn-Area.html b/doc/addons/Spawn-Area.html new file mode 100644 index 00000000..3ba5ee0d --- /dev/null +++ b/doc/addons/Spawn-Area.html @@ -0,0 +1,384 @@ + + + + + + + + Spawn-Area addon + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Spawn-Area addon

+

Adds a custom spawn area with chests and afk turrets

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + + + + + + + +
utils.global
utils.event
utils.game
config.spawn_area
+ + +
+ + +

Dependencies

+
+
+
+
+ # + utils.global +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.event +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.game +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + config.spawn_area +
+
+
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/commands/Admin-Chat.html b/doc/commands/Admin-Chat.html new file mode 100644 index 00000000..e8b3303d --- /dev/null +++ b/doc/commands/Admin-Chat.html @@ -0,0 +1,396 @@ + + + + + + + + Admin-Chat commands + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Admin-Chat commands

+

Commands Module - Admin Chat + - Adds a command that allows admins to talk in a private chat

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + +
expcore.commands
expcore.common
+ + +

Commands

+ + + + + + + + +
admin-chatSends a message in chat that only admins can see
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.common +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Commands

+
+
+
+
+ # + admin-chat +
+
+
+
+ +

Sends a message in chat that only admins can see

+

+ + + Command Parameters: + +
    + + + + + +
  • + + message + + : + + (string) + + the message to send in the admin chat + +
  • + + +
+ + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/commands/Bonus.html b/doc/commands/Bonus.html new file mode 100644 index 00000000..4b41076e --- /dev/null +++ b/doc/commands/Bonus.html @@ -0,0 +1,508 @@ + + + + + + + + Bonus commands + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Bonus commands

+

Commands Module - Bonus + - Adds a command that allows players to have increased stats

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + + + + + + + + + + + + + +
expcore.commands
expcore.roles
utils.event
utils.game
expcore.store
config.bonuses
+ + +

Commands

+ + + + + + + + +
bonusChanges the amount of bonus you receive
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.roles +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.event +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.game +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.store +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + config.bonuses +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Commands

+
+
+
+
+ # + bonus +
+
+
+
+ +

Changes the amount of bonus you receive

+

+ + + Command Parameters: + +
    + + + + + +
  • + + amount + + : + + (number) + + range 0-50 the percent increase for your bonus + +
  • + + +
+ + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/commands/Cheat-Mode.html b/doc/commands/Cheat-Mode.html new file mode 100644 index 00000000..cb0d0a09 --- /dev/null +++ b/doc/commands/Cheat-Mode.html @@ -0,0 +1,369 @@ + + + + + + + + Cheat-Mode commands + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Cheat-Mode commands

+

Commands Module - Cheat Mode + - Adds a command that allows players to enter cheat mode

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + +
expcore.commands
+ + +

Commands

+ + + + + + + + +
toggle-cheat-modeToggles cheat mode for your player, or another player.
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Commands

+
+
+
+
+ # + toggle-cheat-mode +
+
+
+
+ +

Toggles cheat mode for your player, or another player.

+

+ + + Command Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + player to toggle chest mode of, can be nil for self + + (default: self) +
  • + + +
+ + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/commands/Clear-Inventory.html b/doc/commands/Clear-Inventory.html new file mode 100644 index 00000000..27f45940 --- /dev/null +++ b/doc/commands/Clear-Inventory.html @@ -0,0 +1,396 @@ + + + + + + + + Clear-Inventory commands + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Clear-Inventory commands

+

Commands Module - Clear Inventory + - Adds a command that allows admins to clear people's inventorys

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + +
expcore.commands
expcore.common
+ + +

Commands

+ + + + + + + + +
clear-inventoryClears a players inventory
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.common +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Commands

+
+
+
+
+ # + clear-inventory +
+
+
+
+ +

Clears a players inventory

+

+ + + Command Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to clear the inventory of + +
  • + + +
+ + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/commands/Debug.html b/doc/commands/Debug.html new file mode 100644 index 00000000..e2f78d24 --- /dev/null +++ b/doc/commands/Debug.html @@ -0,0 +1,373 @@ + + + + + + + + Debug commands + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Debug commands

+

Commands Module - Debug + - Adds a command that opens the debug frame

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + +
modules.gui.debug.main_view
expcore.commands
+ + +

Commands

+ + + + + + + + +
debugOpens the debug pannel for viewing tables.
+ + +
+ + +

Dependencies

+
+
+
+
+ # + modules.gui.debug.main_view +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Commands

+
+
+
+
+ # + debug +
+
+
+
+ +

Opens the debug pannel for viewing tables.

+

+ + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/commands/Find.html b/doc/commands/Find.html new file mode 100644 index 00000000..c727cd0e --- /dev/null +++ b/doc/commands/Find.html @@ -0,0 +1,368 @@ + + + + + + + + Find commands + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Find commands

+

Commands Module - Find + - Adds a command that zooms in on the given player

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + +
expcore.commands
+ + +

Commands

+ + + + + + + + +
find-on-mapFind a player on your map.
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Commands

+
+
+
+
+ # + find-on-map +
+
+
+
+ +

Find a player on your map.

+

+ + + Command Parameters: + +
    + + + + + +
  • + + the + + : + + (LuaPlayer) + + player to find on the map + +
  • + + +
+ + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/commands/Help.html b/doc/commands/Help.html new file mode 100644 index 00000000..d5178346 --- /dev/null +++ b/doc/commands/Help.html @@ -0,0 +1,412 @@ + + + + + + + + Help commands + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Help commands

+

Commands Module - Help + - Adds a better help command that allows searching of descriotions and names

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + +
expcore.commands
utils.global
+ + +

Commands

+ + + + + + + + +
chelpSearches for a keyword in all commands you are allowed to use.
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.global +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Commands

+
+
+
+
+ # + chelp +
+
+
+
+ +

Searches for a keyword in all commands you are allowed to use.

+

+ + + Command Parameters: + +
    + + + + + +
  • + + keyword + + : + + (string) + + the keyword that will be looked for + +
  • + + + + + +
  • + + page + + : + + (number) + + the page of help to view, must be in range of pages + +
  • + + +
+ + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/commands/Home.html b/doc/commands/Home.html new file mode 100644 index 00000000..a1ba8bce --- /dev/null +++ b/doc/commands/Home.html @@ -0,0 +1,466 @@ + + + + + + + + Home commands + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Home commands

+

Commands Module - Home + - Adds a command that allows setting and teleporting to your home position

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + +
expcore.commands
utils.global
+ + +

Commands

+ + + + + + + + + + + + + + + + + + + + +
homeTeleports you to your home location
home-setSets your home location to your current position
home-getReturns your current home location
returnTeleports you to previous location
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.global +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Commands

+
+
+
+
+ # + home +
+
+
+
+ +

Teleports you to your home location

+

+ + + + + + + + + + + + + + +
+
+
+
+ # + home-set +
+
+
+
+ +

Sets your home location to your current position

+

+ + + + + + + + + + + + + + +
+
+
+
+ # + home-get +
+
+
+
+ +

Returns your current home location

+

+ + + + + + + + + + + + + + +
+
+
+
+ # + return +
+
+
+
+ +

Teleports you to previous location

+

+ + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/commands/Interface.html b/doc/commands/Interface.html new file mode 100644 index 00000000..c38850c0 --- /dev/null +++ b/doc/commands/Interface.html @@ -0,0 +1,424 @@ + + + + + + + + Interface commands + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Interface commands

+

Commands Module - Interface + - Adds a command that acts as a direct link to the the active softmod, for debug use

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + + + + +
expcore.commands
utils.global
expcore.common
+ + +

Commands

+ + + + + + + + +
interfaceSends an innovation to be ran and returns the result.
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.global +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.common +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Commands

+
+
+
+
+ # + interface +
+
+
+
+ +

Sends an innovation to be ran and returns the result.

+

+ + + Command Parameters: + +
    + + + + + +
  • + + innovation + + : + + (string) + + the command that will be run + +
  • + + +
+ + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/commands/Jail.html b/doc/commands/Jail.html new file mode 100644 index 00000000..2f087f4c --- /dev/null +++ b/doc/commands/Jail.html @@ -0,0 +1,619 @@ + + + + + + + + Jail commands + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Jail commands

+

Commands Module - Jail + - Adds a commands that allow admins to jail, unjail, and temp ban players

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + + + + +
expcore.commands
modules.control.jail
expcore.common
+ + +

Commands

+ + + + + + + + + + + + + + + + + + + + +
jailPuts a player into jail and removes all other roles.
unjailRemoves a player from jail.
temp-banTemp bans a player until the next reset; this requires a reason; this will clear the players inventory.
clear-temp-banRemoves temp ban from a player; this will not restore their items.
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + modules.control.jail +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.common +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Commands

+
+
+
+
+ # + jail +
+
+
+
+ +

Puts a player into jail and removes all other roles.

+

+ + + Command Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player that will be jailed + +
  • + + + + + +
  • + + reason + + : + + (string) + + the reason why the player is being jailed + + (optional) +
  • + + +
+ + + + + + + + + + + + + +
+
+
+
+ # + unjail +
+
+
+
+ +

Removes a player from jail.

+

+ + + Command Parameters: + +
    + + + + + +
  • + + the + + : + + (LuaPlayer) + + player that will be unjailed + +
  • + + +
+ + + + + + + + + + + + + +
+
+
+
+ # + temp-ban +
+
+
+
+ +

Temp bans a player until the next reset; this requires a reason; this will clear the players inventory.

+

+ + + Command Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player that will be temp banned + +
  • + + + + + +
  • + + reason + + : + + (string) + + the reason that the player is being temp banned + +
  • + + +
+ + + + + + + + + + + + + +
+
+
+
+ # + clear-temp-ban +
+
+
+
+ +

Removes temp ban from a player; this will not restore their items.

+

+ + + Command Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to revoke the temp ban from + +
  • + + +
+ + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/commands/Kill.html b/doc/commands/Kill.html new file mode 100644 index 00000000..33cd787e --- /dev/null +++ b/doc/commands/Kill.html @@ -0,0 +1,397 @@ + + + + + + + + Kill commands + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Kill commands

+

Commands Module - Kill + - Adds a command that allows players to kill them selfs and others

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + +
expcore.commands
expcore.roles
+ + +

Commands

+ + + + + + + + +
killKills yourself or another player.
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.roles +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Commands

+
+
+
+
+ # + kill +
+
+
+
+ +

Kills yourself or another player.

+

+ + + Command Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to kill, must be alive to be valid + + (default: self) +
  • + + +
+ + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/commands/Me.html b/doc/commands/Me.html new file mode 100644 index 00000000..ee42acca --- /dev/null +++ b/doc/commands/Me.html @@ -0,0 +1,368 @@ + + + + + + + + Me commands + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Me commands

+

Commands Module - Me + - Adds a command that adds * around your message in the chat

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + +
expcore.commands
+ + +

Commands

+ + + + + + + + +
meSends an action message in the chat
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Commands

+
+
+
+
+ # + me +
+
+
+
+ +

Sends an action message in the chat

+

+ + + Command Parameters: + +
    + + + + + +
  • + + action + + : + + (string) + + the action that follows your name in chat + +
  • + + +
+ + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/commands/Rainbow.html b/doc/commands/Rainbow.html new file mode 100644 index 00000000..b7f2a851 --- /dev/null +++ b/doc/commands/Rainbow.html @@ -0,0 +1,396 @@ + + + + + + + + Rainbow commands + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Rainbow commands

+

Commands Module - Rainbow + - Adds a command that prints your message in rainbow font

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + +
expcore.commands
expcore.common
+ + +

Commands

+ + + + + + + + +
rainbowSends an rainbow message in the chat
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.common +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Commands

+
+
+
+
+ # + rainbow +
+
+
+
+ +

Sends an rainbow message in the chat

+

+ + + Command Parameters: + +
    + + + + + +
  • + + message + + : + + (string) + + the message that will be printed in chat + +
  • + + +
+ + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/commands/Repair.html b/doc/commands/Repair.html new file mode 100644 index 00000000..19e506ca --- /dev/null +++ b/doc/commands/Repair.html @@ -0,0 +1,329 @@ + + + + + + + + Repair commands + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Repair commands

+

Commands Module - Repair + - Adds a command that allows an admin to repair and revive a large area

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + +
expcore.commands
config.repair
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + config.repair +
+
+
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/commands/Reports.html b/doc/commands/Reports.html new file mode 100644 index 00000000..c0f17772 --- /dev/null +++ b/doc/commands/Reports.html @@ -0,0 +1,593 @@ + + + + + + + + Reports commands + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Reports commands

+

Commands Module - Reports + - Adds a commands that allow players to report other players

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + + + + + + + +
expcore.roles
expcore.commands
modules.control.reports
expcore.common
+ + +

Commands

+ + + + + + + + + + + + + + + + +
reportReports a player and notifies moderators
get-reportsGets a list of all reports that a player has on them.
clear-reportsClears all reports from a player or just the report from one player.
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.roles +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + modules.control.reports +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.common +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Commands

+
+
+
+
+ # + report +
+
+
+
+ +

Reports a player and notifies moderators

+

+ + + Command Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to report, some players are immune + +
  • + + + + + +
  • + + reason + + : + + (string) + + the reason the player is being reported + +
  • + + +
+ + + + + + + + + + + + + +
+
+
+
+ # + get-reports +
+
+
+
+ +

Gets a list of all reports that a player has on them.

+

If no player then lists all players and the number of reports on them.

+ + + Command Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to get the report for + +
  • + + +
+ + + + + + + + + + + + + +
+
+
+
+ # + clear-reports +
+
+
+
+ +

Clears all reports from a player or just the report from one player.

+

+ + + Command Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to clear the report(s) from + +
  • + + + + + +
  • + + from + + : + + (LuaPlayer) + + -player remove only the report made by this player + + (default: all) +
  • + + +
+ + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/commands/Roles.html b/doc/commands/Roles.html new file mode 100644 index 00000000..d9a1f285 --- /dev/null +++ b/doc/commands/Roles.html @@ -0,0 +1,565 @@ + + + + + + + + Roles commands + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Roles commands

+

Commands Module - Roles + - Adds a commands that allow interaction with the role system

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + + + + +
expcore.commands
expcore.roles
resources.color_presets
+ + +

Commands

+ + + + + + + + + + + + + + + + +
assign-roleAssigns a role to a player
unassign-roleUnassigns a role from a player
list-rolesLists all roles in they correct order
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.roles +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + resources.color_presets +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Commands

+
+
+
+
+ # + assign-role +
+
+
+
+ +

Assigns a role to a player

+

+ + + Command Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to assign the role to + +
  • + + + + + +
  • + + role + + : + + (string) + + the name of the role to assign to the player, supports auto complete after enter + +
  • + + +
+ + + + + + + + + + + + + +
+
+
+
+ # + unassign-role +
+
+
+
+ +

Unassigns a role from a player

+

+ + + Command Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to unassign the role from + +
  • + + + + + +
  • + + role + + : + + (string) + + the name of the role to unassign from the player, supports auto complete after enter + +
  • + + +
+ + + + + + + + + + + + + +
+
+
+
+ # + list-roles +
+
+
+
+ +

Lists all roles in they correct order

+

+ + + Command Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + list only the roles which this player has + + (default: all) +
  • + + +
+ + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/commands/Spawn.html b/doc/commands/Spawn.html new file mode 100644 index 00000000..bb58d8a9 --- /dev/null +++ b/doc/commands/Spawn.html @@ -0,0 +1,397 @@ + + + + + + + + Spawn commands + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Spawn commands

+

Commands Module - Spawn + - Adds a command that allows players to teleport to their spawn point

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + +
expcore.commands
expcore.roles
+ + +

Commands

+ + + + + + + + +
go-to-spawnTeleport to spawn
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.roles +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Commands

+
+
+
+
+ # + go-to-spawn +
+
+
+
+ +

Teleport to spawn

+

+ + + Command Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to teleport to their spawn point + + (default: self) +
  • + + +
+ + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/commands/Tag.html b/doc/commands/Tag.html new file mode 100644 index 00000000..43fab495 --- /dev/null +++ b/doc/commands/Tag.html @@ -0,0 +1,451 @@ + + + + + + + + Tag commands + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Tag commands

+

Commands Module - Tag + - Adds a command that allows players to have a custom tag after their name

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + +
expcore.commands
expcore.roles
+ + +

Commands

+ + + + + + + + + + + + +
tagSets your player tag.
tag-clearClears your tag.
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.roles +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Commands

+
+
+
+
+ # + tag +
+
+
+
+ +

Sets your player tag.

+

+ + + Command Parameters: + +
    + + + + + +
  • + + tag + + : + + (string) + + the tag that will be after the name, there is a max length + +
  • + + +
+ + + + + + + + + + + + + +
+
+
+
+ # + tag-clear +
+
+
+
+ +

Clears your tag.

+

Or another player if you are admin.

+ + + Command Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to remove the tag from, nil will apply to self + + (default: self) +
  • + + +
+ + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/commands/Teleport.html b/doc/commands/Teleport.html new file mode 100644 index 00000000..42089cc1 --- /dev/null +++ b/doc/commands/Teleport.html @@ -0,0 +1,492 @@ + + + + + + + + Teleport commands + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Teleport commands

+

Commands Module - Teleport + - Adds a command that allows players to teleport to other players

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + +
expcore.commands
+ + +

Commands

+ + + + + + + + + + + + + + + + +
teleportTeleports a player to another player.
bringTeleports a player to you.
gotoTeleports you to a player.
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Commands

+
+
+
+
+ # + teleport +
+
+
+
+ +

Teleports a player to another player.

+

+ + + Command Parameters: + +
    + + + + + +
  • + + from_player + + : + + (LuaPlayer) + + the player that will be teleported, must be alive + +
  • + + + + + +
  • + + to_player + + : + + (LuaPlayer) + + the player to teleport to, must be online (if dead goes to where they died) + +
  • + + +
+ + + + + + + + + + + + + +
+
+
+
+ # + bring +
+
+
+
+ +

Teleports a player to you.

+

+ + + Command Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player that will be teleported, must be alive + +
  • + + +
+ + + + + + + + + + + + + +
+
+
+
+ # + goto +
+
+
+
+ +

Teleports you to a player.

+

+ + + Command Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to teleport to, must be online (if dead goes to where they died) + +
  • + + +
+ + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/commands/Warnings.html b/doc/commands/Warnings.html new file mode 100644 index 00000000..0bb7d855 --- /dev/null +++ b/doc/commands/Warnings.html @@ -0,0 +1,577 @@ + + + + + + + + Warnings commands + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Warnings commands

+

Commands Module - Warnings + - Adds a commands that allow admins to warn other players

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + + + + + + + +
expcore.commands
modules.control.warnings
expcore.common
config.warnings
+ + +

Commands

+ + + + + + + + + + + + + + + + +
give-warningGives a warning to a player; may lead to automatic script action.
get-warningsGets the number of warnings a player has.
clear-warningsClears all warnings (and script warnings) from a player
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + modules.control.warnings +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.common +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + config.warnings +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Commands

+
+
+
+
+ # + give-warning +
+
+
+
+ +

Gives a warning to a player; may lead to automatic script action.

+

+ + + Command Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player the will recive a warning + +
  • + + + + + +
  • + + reason + + : + + (string) + + the reason the player is being given a warning + +
  • + + +
+ + + + + + + + + + + + + +
+
+
+
+ # + get-warnings +
+
+
+
+ +

Gets the number of warnings a player has.

+

If no player then lists all players and the number of warnings they have.

+ + + Command Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to get the warning for, if nil all players are listed + + (default: list) +
  • + + +
+ + + + + + + + + + + + + +
+
+
+
+ # + clear-warnings +
+
+
+
+ +

Clears all warnings (and script warnings) from a player

+

+ + + Command Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to clear the warnings from + +
  • + + +
+ + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/config.ld b/doc/config.ld index 79ac9eed..f5a7a308 100644 --- a/doc/config.ld +++ b/doc/config.ld @@ -13,15 +13,18 @@ topics = {"../README.md", "../LICENSE"} style = '../doc' template = '../doc' no_space_before_args = true +merge=true new_type("core", "Core", true) new_type("addon", "Addons", true) new_type("commands", "Commands", true) new_type("control", "Control", true) new_type("gui", "Guis", true) -new_type("config", "Configs", true) +new_type("config", "Configs", true, "Settings") new_type("dep", "Dependencies", false) +new_type("element", "Elements", false) +new_type("setting", "Settings", false) new_type("event", "Events", false, "Event Parameters") new_type("command", "Commands", false, "Command Parameters") diff --git a/doc/configs/Advanced-Start.html b/doc/configs/Advanced-Start.html new file mode 100644 index 00000000..46ef69a1 --- /dev/null +++ b/doc/configs/Advanced-Start.html @@ -0,0 +1,514 @@ + + + + + + + + Advanced-Start config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Advanced-Start config

+

This file is used to setup the map starting settings and the items players will start with

+

+ + + + + + + + + + + + + +

Settings

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
skip_intro
skip_victory
disable_base_game_silo_script
research_queue_from_start
friendly_fire
enemy_expansion
chart_radius
items
+ + +
+ + +

Settings

+
+
+
+
+ # + skip_intro +
+
+
+
+ +

+

skips the intro given in the default factorio free play scenario

+ + + + + + + + + + + + + + +
+
+
+
+ # + skip_victory +
+
+
+
+ +

+

will skip the victory screen when a rocket is launched

+ + + + + + + + + + + + + + +
+
+
+
+ # + disable_base_game_silo_script +
+
+
+
+ +

+

will not load the silo script at all

+ + + + + + + + + + + + + + +
+
+
+
+ # + research_queue_from_start +
+
+
+
+ +

+

when true the research queue is useible from the start

+ + + + + + + + + + + + + + +
+
+
+
+ # + friendly_fire +
+
+
+
+ +

+

weather players will be able to attack each other on the same force

+ + + + + + + + + + + + + + +
+
+
+
+ # + enemy_expansion +
+
+
+
+ +

+

a catch all for in case the map settings file fails to load

+ + + + + + + + + + + + + + +
+
+
+
+ # + chart_radius +
+
+
+
+ +

+

the number of tiles that will be charted when the map starts

+ + + + + + + + + + + + + + +
+
+
+
+ # + items +
+
+
+
+ +

+

items and there condition for being given + ['item-name'] = function(amount_made,production_stats,player) return end -- 0 means no items given + Plates

+ + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Bonuses.html b/doc/configs/Bonuses.html new file mode 100644 index 00000000..e1806bce --- /dev/null +++ b/doc/configs/Bonuses.html @@ -0,0 +1,245 @@ + + + + + + + + Bonuses config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Bonuses config

+

Lists all bonuses which can be used, name followed by min max

+

+ + + + + + + + + + + + + +
+ + + + + +
+
+
+ + + + diff --git a/doc/configs/Chat-Reply.html b/doc/configs/Chat-Reply.html new file mode 100644 index 00000000..c8ef6dfa --- /dev/null +++ b/doc/configs/Chat-Reply.html @@ -0,0 +1,493 @@ + + + + + + + + Chat-Reply config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Chat-Reply config

+

This file defines the different triggers for the chat bot

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + +
expcore.common
+ + +

Settings

+ + + + + + + + + + + + + + + + + + + + + + +
allow_command_prefix_for_messages
messages
command_admin_only
command_permission
command_prefix
commands
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.common +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Settings

+
+
+
+
+ # + allow_command_prefix_for_messages +
+
+
+
+ +

+

when true any message trigger will print to all player when prefixed

+ + + + + + + + + + + + + + +
+
+
+
+ # + messages +
+
+
+
+ +

+

will trigger when ever the word is said

+ + + + + + + + + + + + + + +
+
+
+
+ # + command_admin_only +
+
+
+
+ +

+

when true will only allow chat commands for admins

+ + + + + + + + + + + + + + +
+
+
+
+ # + command_permission +
+
+
+
+ +

+

the permission used to allow command prefixes

+ + + + + + + + + + + + + + +
+
+
+
+ # + command_prefix +
+
+
+
+ +

+

prefix used for commands below and to print to all players (if enabled above)

+ + + + + + + + + + + + + + +
+
+
+
+ # + commands +
+
+
+
+ +

+

will trigger only when command prefix is given

+ + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Commands-Auth-Admin.html b/doc/configs/Commands-Auth-Admin.html new file mode 100644 index 00000000..ffc290aa --- /dev/null +++ b/doc/configs/Commands-Auth-Admin.html @@ -0,0 +1,302 @@ + + + + + + + + Commands-Auth-Admin config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Commands-Auth-Admin config

+

This is a very simple config file which adds a admin only auth functio; + not much to change here its more so it can be enabled and disabled from ./config/file_loader.lua; + either way you can change the requirements to be "admin" if you wanted to

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + +
expcore.commands
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Commands-Auth-Roles.html b/doc/configs/Commands-Auth-Roles.html new file mode 100644 index 00000000..1f3c18d9 --- /dev/null +++ b/doc/configs/Commands-Auth-Roles.html @@ -0,0 +1,328 @@ + + + + + + + + Commands-Auth-Roles config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Commands-Auth-Roles config

+

This will make commands only work if the role has been allowed it in the role config

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + +
expcore.commands
expcore.roles
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.roles +
+
+
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Commands-Auth-Runtime-Disable.html b/doc/configs/Commands-Auth-Runtime-Disable.html new file mode 100644 index 00000000..f68dc361 --- /dev/null +++ b/doc/configs/Commands-Auth-Runtime-Disable.html @@ -0,0 +1,450 @@ + + + + + + + + Commands-Auth-Runtime-Disable config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Commands-Auth-Runtime-Disable config

+

This config for command auth allows commands to be globally enabled and disabled during runtime; + this config adds Commands.disable and Commands.enable to enable and disable commands for all users

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + +
expcore.commands
utils.global
+ + +

Functions

+ + + + + + + + + + + + +
Commands.disable(command_name)Stops a command from be used by any one
Commands.enable(command_name)Allows a command to be used again after disable was used
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.global +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Functions

+
+
+
+
+ # + Commands.disable(command_name) +
+
+
+
+ +

Stops a command from be used by any one

+

+ + + Parameters: + +
    + + + + + +
  • + + command_name + + : + + (string) + + the name of the command to disable + +
  • + + +
+ + + + + + + + + + + + + +
+
+
+
+ # + Commands.enable(command_name) +
+
+
+
+ +

Allows a command to be used again after disable was used

+

+ + + Parameters: + +
    + + + + + +
  • + + command_name + + : + + (string) + + the name of the command to enable + +
  • + + +
+ + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Commands-Parse-Roles.html b/doc/configs/Commands-Parse-Roles.html new file mode 100644 index 00000000..d18424fa --- /dev/null +++ b/doc/configs/Commands-Parse-Roles.html @@ -0,0 +1,362 @@ + + + + + + + + Commands-Parse-Roles config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Commands-Parse-Roles config

+

Adds some parse functions that can be used with the role system

+

+ + + + + + +

Usage

+
 Adds Parses:
+    role
+    player-role
+    player-role-online
+    player-role-alive
+ + + + + + + +

Dependencies

+ + + + + + + + + + + + + +
expcore.commands
expcore.roles
expcore.common
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.roles +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.common +
+
+
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Commands-Parse.html b/doc/configs/Commands-Parse.html new file mode 100644 index 00000000..2f413722 --- /dev/null +++ b/doc/configs/Commands-Parse.html @@ -0,0 +1,346 @@ + + + + + + + + Commands-Parse config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Commands-Parse config

+

This file contains some common command param parse functions; +this file is less of a config and more of a requirement but you may wish to change how some behave; +as such you need to be confident with lua but you edit this config file; +use Commands.add_parse('name',function(input,player,reject) end) to add a parse; +see ./expcore/commands.lua for more details

+

+ + + + + + +

Usage

+
 Adds Parses:
+    boolean
+    string-options - options: array
+    string-max-length - max_length: number
+    number
+    integer
+    number-range - range_min: number, range_max: number
+    integer-range - range_min: number, range_max: number
+    player
+    player-online
+    player-alive
+    force
+    surface
+ + + + + + + +

Dependencies

+ + + + + + + + + + +
expcore.commands
utils.game
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.game +
+
+
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Commands.auth_admin.html b/doc/configs/Commands.auth_admin.html new file mode 100644 index 00000000..b63055ce --- /dev/null +++ b/doc/configs/Commands.auth_admin.html @@ -0,0 +1,289 @@ + + + + + + + + Commands.auth_admin config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Commands.auth_admin config

+

This is a very simple config file which adds a admin only auth functio + not much to change here its more so it can be enabled and disabled from ./config/file_loader.lua + either way you can change the requirements to be "admin" if you wanted to

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + +
expcore.commands
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Commands.auth_roles.html b/doc/configs/Commands.auth_roles.html new file mode 100644 index 00000000..c25d1e43 --- /dev/null +++ b/doc/configs/Commands.auth_roles.html @@ -0,0 +1,315 @@ + + + + + + + + Commands.auth_roles config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Commands.auth_roles config

+

This will make commands only work if the role has been allowed it in the role config

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + +
expcore.commands
expcore.roles
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.roles +
+
+
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Commands.auth_runtime_disable.html b/doc/configs/Commands.auth_runtime_disable.html new file mode 100644 index 00000000..e146ff0e --- /dev/null +++ b/doc/configs/Commands.auth_runtime_disable.html @@ -0,0 +1,437 @@ + + + + + + + + Commands.auth_runtime_disable config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Commands.auth_runtime_disable config

+

This config for command auth allows commands to be globally enabled and disabled during runtime + this config adds Commands.disable and Commands.enable to enable and disable commands for all users

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + +
expcore.commands
utils.global
+ + +

Functions

+ + + + + + + + + + + + +
Commands.disable(command_name)Stops a command from be used by any one
Commands.enable(command_name)Allows a command to be used again after disable was used
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.global +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Functions

+
+
+
+
+ # + Commands.disable(command_name) +
+
+
+
+ +

Stops a command from be used by any one

+

+ + + Parameters: + +
    + + + + + +
  • + + command_name + + : + + (string) + + the name of the command to disable + +
  • + + +
+ + + + + + + + + + + + + +
+
+
+
+ # + Commands.enable(command_name) +
+
+
+
+ +

Allows a command to be used again after disable was used

+

+ + + Parameters: + +
    + + + + + +
  • + + command_name + + : + + (string) + + the name of the command to enable + +
  • + + +
+ + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Commands.parse_general.html b/doc/configs/Commands.parse_general.html new file mode 100644 index 00000000..49dd695d --- /dev/null +++ b/doc/configs/Commands.parse_general.html @@ -0,0 +1,333 @@ + + + + + + + + Commands.parse_general config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Commands.parse_general config

+

This file contains some common command param parse functions +this file is less of a config and more of a requirement but you may wish to change how some behave +as such you need to be confident with lua but you edit this config file +use Commands.add_parse('name',function(input,player,reject) end) to add a parse +see ./expcore/commands.lua for more details

+

+ + + + + + +

Usage

+
 Adds Parses:
+    boolean
+    string-options - options: array
+    string-max-length - max_length: number
+    number
+    integer
+    number-range - range_min: number, range_max: number
+    integer-range - range_min: number, range_max: number
+    player
+    player-online
+    player-alive
+    force
+    surface
+ + + + + + + +

Dependencies

+ + + + + + + + + + +
expcore.commands
utils.game
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.game +
+
+
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Commands.parse_roles.html b/doc/configs/Commands.parse_roles.html new file mode 100644 index 00000000..76e5c918 --- /dev/null +++ b/doc/configs/Commands.parse_roles.html @@ -0,0 +1,349 @@ + + + + + + + + Commands.parse_roles config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Commands.parse_roles config

+

Adds some parse functions that can be used with the role system

+

+ + + + + + +

Usage

+
 Adds Parses:
+    role
+    player-role
+    player-role-online
+    player-role-alive
+ + + + + + + +

Dependencies

+ + + + + + + + + + + + + +
expcore.commands
expcore.roles
expcore.common
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.commands +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.roles +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.common +
+
+
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Compilatron.html b/doc/configs/Compilatron.html new file mode 100644 index 00000000..5bf4b1ba --- /dev/null +++ b/doc/configs/Compilatron.html @@ -0,0 +1,362 @@ + + + + + + + + Compilatron config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Compilatron config

+

Config file for the compliatrons including where they spawn and what messages they show

+

+ + + + + + + + + + + + + +

Settings

+ + + + + + + + + + + + + +
message_cycle
locations
messages
+ + +
+ + +

Settings

+
+
+
+
+ # + message_cycle +
+
+
+
+ +

+

15 seconds default, how often (in ticks) the messages will cycle

+ + + + + + + + + + + + + + +
+
+
+
+ # + locations +
+
+
+
+ +

+

defines the spawn locations for all compilatrons

+ + + + + + + + + + + + + + +
+
+
+
+ # + messages +
+
+
+
+ +

+

the messages that each one will say, must be same name as its location

+ + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Death-Logger.html b/doc/configs/Death-Logger.html new file mode 100644 index 00000000..76aec8f5 --- /dev/null +++ b/doc/configs/Death-Logger.html @@ -0,0 +1,424 @@ + + + + + + + + Death-Logger config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Death-Logger config

+

This config controls what happens when a player dies mostly about map markers and item collection; + allow_teleport_to_body_command and allow_collect_bodies_command can be over ridden if command_auth_runtime_disable is present; + if not present then the commands will not be loaded into the game

+

+ + + + + + + + + + + + + +

Settings

+ + + + + + + + + + + + + + + + + + + +
use_chests_as_bodies
auto_collect_bodies
show_map_markers
include_time_of_death
map_icon
+ + +
+ + +

Settings

+
+
+
+
+ # + use_chests_as_bodies +
+
+
+
+ +

+

weather items should be moved into a chest when a player dies

+ + + + + + + + + + + + + + +
+
+
+
+ # + auto_collect_bodies +
+
+
+
+ +

+

enables items being returned to the spawn point in chests upon corpse expiring

+ + + + + + + + + + + + + + +
+
+
+
+ # + show_map_markers +
+
+
+
+ +

+

shows markers on the map where bodies are

+ + + + + + + + + + + + + + +
+
+
+
+ # + include_time_of_death +
+
+
+
+ +

+

weather to include the time of death on the map marker

+ + + + + + + + + + + + + + +
+
+
+
+ # + map_icon +
+
+
+
+ +

+

the icon that the map marker shows; nil means no icon; format as a SingleID

+ + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Discord-Alerts.html b/doc/configs/Discord-Alerts.html new file mode 100644 index 00000000..03ca2c6d --- /dev/null +++ b/doc/configs/Discord-Alerts.html @@ -0,0 +1,245 @@ + + + + + + + + Discord-Alerts config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Discord-Alerts config

+

Config file used to enable and disable different push messages for discord

+

+ + + + + + + + + + + + + +
+ + + + + +
+
+
+ + + + diff --git a/doc/configs/File-Loader.html b/doc/configs/File-Loader.html new file mode 100644 index 00000000..58c755b1 --- /dev/null +++ b/doc/configs/File-Loader.html @@ -0,0 +1,248 @@ + + + + + + + + File-Loader config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

File-Loader config

+

This contains a list of all files that will be loaded and the order they are loaded in; + to stop a file from loading add "--" in front of it, remove the "--" to have the file be loaded; + config files should be loaded after all modules are loaded; + core files should be required by modules and not be present in this list;

+

+ + + + + + + + + + + + + +
+ + + + + +
+
+
+ + + + diff --git a/doc/configs/Permission-Groups.html b/doc/configs/Permission-Groups.html new file mode 100644 index 00000000..7043ae72 --- /dev/null +++ b/doc/configs/Permission-Groups.html @@ -0,0 +1,303 @@ + + + + + + + + Permission-Groups config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Permission-Groups config

+

Use this file to add new permission groups to the game; + start with Permission_Groups.new_group('name'); + then use either :allow_all() or :disallow_all() to set the default for non specified actions; + then use :allow{} and :disallow{} to specify certain actions to allow/disallow

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + +
expcore.permission_groups
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.permission_groups +
+
+
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Player-List.html b/doc/configs/Player-List.html new file mode 100644 index 00000000..c6e1c748 --- /dev/null +++ b/doc/configs/Player-List.html @@ -0,0 +1,820 @@ + + + + + + + + Player-List config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Player-List config

+

Config for the different action buttons that show on the player list; + each button has the button define(s) given along side an auth function, and optional reason callback; + if a reason callback is used then Store.set(action_name_store,player.name,'BUTTON_NAME') should be called during on_click; + buttons can be removed from the gui by commenting them out of the config at the bottom of this file; + the key used for the name of the button is the permission name used by the role system;

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
expcore.gui
expcore.roles
expcore.store
utils.game
modules.control.reports
modules.control.warnings
modules.control.jail
resources.color_presets
expcore.common
+ + +

Elements

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
goto_playerTeleports the user to the action player
bring_playerTeleports the action player to the user
kill_playerKills the action player, if there are alive
report_playerReports the action player, requires a reason to be given
warn_playerGives the action player a warning, requires a reason
jail_playerJails the action player, requires a reason
temp_ban_playerTemp bans the action player, requires a reason
kick_playerKicks the action player, requires a reason
ban_playerBans the action player, requires a reason
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.gui +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.roles +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.store +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + utils.game +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + modules.control.reports +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + modules.control.warnings +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + modules.control.jail +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + resources.color_presets +
+
+
+
+ + + + + + + + + + + + + + + +
+
+
+
+ # + expcore.common +
+
+
+
+ + + + + + + + + + + + + + + +
+
+

Elements

+
+
+
+
+ # + goto_player +
+
+
+
+ +

Teleports the user to the action player

+

+ + + + + + + + + + + + + + +
+
+
+
+ # + bring_player +
+
+
+
+ +

Teleports the action player to the user

+

+ + + + + + + + + + + + + + +
+
+
+
+ # + kill_player +
+
+
+
+ +

Kills the action player, if there are alive

+

+ + + + + + + + + + + + + + +
+
+
+
+ # + report_player +
+
+
+
+ +

Reports the action player, requires a reason to be given

+

+ + + + + + + + + + + + + + +
+
+
+
+ # + warn_player +
+
+
+
+ +

Gives the action player a warning, requires a reason

+

+ + + + + + + + + + + + + + +
+
+
+
+ # + jail_player +
+
+
+
+ +

Jails the action player, requires a reason

+

+ + + + + + + + + + + + + + +
+
+
+
+ # + temp_ban_player +
+
+
+
+ +

Temp bans the action player, requires a reason

+

+ + + + + + + + + + + + + + +
+
+
+
+ # + kick_player +
+
+
+
+ +

Kicks the action player, requires a reason

+

+ + + + + + + + + + + + + + +
+
+
+
+ # + ban_player +
+
+
+
+ +

Bans the action player, requires a reason

+

+ + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Pollution-Grading.html b/doc/configs/Pollution-Grading.html new file mode 100644 index 00000000..9eb9892f --- /dev/null +++ b/doc/configs/Pollution-Grading.html @@ -0,0 +1,392 @@ + + + + + + + + Pollution-Grading config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Pollution-Grading config

+

This controls how pollution is viewed on the map

+

+ + + + + + + + + + + + + +

Settings

+ + + + + + + + + + + + + + + + +
reference_point
max_scalar
min_scalar
update_delay
+ + +
+ + +

Settings

+
+
+
+
+ # + reference_point +
+
+
+
+ +

+

where pollution is read from

+ + + + + + + + + + + + + + +
+
+
+
+ # + max_scalar +
+
+
+
+ +

+

the scale between true max and max

+ + + + + + + + + + + + + + +
+
+
+
+ # + min_scalar +
+
+
+
+ +

+

the scale between the lowest max and min

+ + + + + + + + + + + + + + +
+
+
+
+ # + update_delay +
+
+
+
+ +

+

time in minutes between view updates

+ + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Popup-Messages.html b/doc/configs/Popup-Messages.html new file mode 100644 index 00000000..39690dd2 --- /dev/null +++ b/doc/configs/Popup-Messages.html @@ -0,0 +1,422 @@ + + + + + + + + Popup-Messages config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Popup-Messages config

+

A combination of config settings for different popup values like chat and damage

+

+ + + + + + + + + + + + + +

Settings

+ + + + + + + + + + + + + + + + + + + +
show_player_messages
show_player_mentions
show_player_damage
show_player_health
damage_location_variance
+ + +
+ + +

Settings

+
+
+
+
+ # + show_player_messages +
+
+
+
+ +

+

weather a message in chat will make a popup above them

+ + + + + + + + + + + + + + +
+
+
+
+ # + show_player_mentions +
+
+
+
+ +

+

weather a mentioned player will have a popup when mentioned in chat

+ + + + + + + + + + + + + + +
+
+
+
+ # + show_player_damage +
+
+
+
+ +

+

weather to show damage done by players

+ + + + + + + + + + + + + + +
+
+
+
+ # + show_player_health +
+
+
+
+ +

+

weather to show player health when attacked

+ + + + + + + + + + + + + + +
+
+
+
+ # + damage_location_variance +
+
+
+
+ +

+

how close to the eade of an entity the popups will appear

+ + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Preset-Player-Colours.html b/doc/configs/Preset-Player-Colours.html new file mode 100644 index 00000000..9d37a9a8 --- /dev/null +++ b/doc/configs/Preset-Player-Colours.html @@ -0,0 +1,332 @@ + + + + + + + + Preset-Player-Colours config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Preset-Player-Colours config

+

Preset colours that players get when they join the server, if not in the list then will be given a random colour (which isnt disallowed)

+

+ + + + + + + + + + + + + +

Settings

+ + + + + + + + + + +
players
disallow
+ + +
+ + +

Settings

+
+
+
+
+ # + players +
+
+
+
+ +

+

list of all players and the colour in rgb256 that they will recive upon joining

+ + + + + + + + + + + + + + +
+
+
+
+ # + disallow +
+
+
+
+ +

+

colours which will not given to players; the value does not matter it is only the key which is checked

+ + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Repair.html b/doc/configs/Repair.html new file mode 100644 index 00000000..8625da88 --- /dev/null +++ b/doc/configs/Repair.html @@ -0,0 +1,422 @@ + + + + + + + + Repair config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Repair config

+

Config file for the repair command

+

+ + + + + + + + + + + + + +

Settings

+ + + + + + + + + + + + + + + + + + + +
disallow
max_range
allow_blueprint_repair
allow_ghost_revive
allow_heal_entities
+ + +
+ + +

Settings

+
+
+
+
+ # + disallow +
+
+
+
+ +

+

items in this list will never be repaired

+ + + + + + + + + + + + + + +
+
+
+
+ # + max_range +
+
+
+
+ +

+

the max range that can be used with the repair command

+ + + + + + + + + + + + + + +
+
+
+
+ # + allow_blueprint_repair +
+
+
+
+ +

+

when true will allow blueprints (things not destroyed by biters) to be build instantly using the repair command

+ + + + + + + + + + + + + + +
+
+
+
+ # + allow_ghost_revive +
+
+
+
+ +

+

when true will allow ghosts (things destroyed by biters) to be build instantly using the repair command

+ + + + + + + + + + + + + + +
+
+
+
+ # + allow_heal_entities +
+
+
+
+ +

+

when true will heal entities to full health that are within range

+ + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Rockets.html b/doc/configs/Rockets.html new file mode 100644 index 00000000..9be2580d --- /dev/null +++ b/doc/configs/Rockets.html @@ -0,0 +1,842 @@ + + + + + + + + Rockets config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Rockets config

+

This file controls what will show in each section of the rocket info gui

+

+ + + + + + + + + + + + + +

Settings

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
stats
show_stats
show_first_rocket
show_last_rocket
show_fastest_rocket
show_total_rockets
show_game_avg
rolling_avg
milestones
show_milestones
progress
show_progress
allow_zoom_to_map
allow_remote_launch
remote_launch_admins_only
remote_launch_role_permission
allow_toggle_active
toggle_active_admins_only
toggle_active_role_permission
+ + +
+ + +

Settings

+
+
+
+
+ # + stats +
+
+
+
+ +

+

The data that will show in the stats section

+ + + + + + + + + + + + + + +
+
+
+
+ # + show_stats +
+
+
+
+ +

+

false will hide this section all together

+ + + + + + + + + + + + + + +
+
+
+
+ # + show_first_rocket +
+
+
+
+ +

+

false will not show when the first rocket was launched

+ + + + + + + + + + + + + + +
+
+
+
+ # + show_last_rocket +
+
+
+
+ +

+

false will not show when the last rocket was launched

+ + + + + + + + + + + + + + +
+
+
+
+ # + show_fastest_rocket +
+
+
+
+ +

+

false will not show the time taken for the fastest rocket

+ + + + + + + + + + + + + + +
+
+
+
+ # + show_total_rockets +
+
+
+
+ +

+

false will not show the total number of rockets launched

+ + + + + + + + + + + + + + +
+
+
+
+ # + show_game_avg +
+
+
+
+ +

+

false will hide the avg across the entire map time

+ + + + + + + + + + + + + + +
+
+
+
+ # + rolling_avg +
+
+
+
+ +

+

each number will be one statistic; 5 means the avg time taken for the last 5 rockets

+ + + + + + + + + + + + + + +
+
+
+
+ # + milestones +
+
+
+
+ +

+

each number will be one statistic; 5 means the time that the 5th rocket was launched

+ + + + + + + + + + + + + + +
+
+
+
+ # + show_milestones +
+
+
+
+ +

+

false will hide this section all together

+ + + + + + + + + + + + + + +
+
+
+
+ # + progress +
+
+
+
+ +

+

The data and buttons in the build progress section

+ + + + + + + + + + + + + + +
+
+
+
+ # + show_progress +
+
+
+
+ +

+

false will hide this section altogether

+ + + + + + + + + + + + + + +
+
+
+
+ # + allow_zoom_to_map +
+
+
+
+ +

+

false will disable the zoom to map feature

+ + + + + + + + + + + + + + +
+
+
+
+ # + allow_remote_launch +
+
+
+
+ +

+

false removes the remote launch button for all players

+ + + + + + + + + + + + + + +
+
+
+
+ # + remote_launch_admins_only +
+
+
+
+ +

+

true will remove the remote launch button for all non (game) admins

+ + + + + + + + + + + + + + +
+
+
+
+ # + remote_launch_role_permission +
+
+
+
+ +

+

value used by custom permission system to allow or disallow the button

+ + + + + + + + + + + + + + +
+
+
+
+ # + allow_toggle_active +
+
+
+
+ +

+

false removes the remote toggle auto launch button for all players

+ + + + + + + + + + + + + + +
+
+
+
+ # + toggle_active_admins_only +
+
+
+
+ +

+

true will remove the toggle auto launch button for all non (game) admins

+ + + + + + + + + + + + + + +
+
+
+
+ # + toggle_active_role_permission +
+
+
+
+ +

+

value used by custom permission system to allow or disallow the button

+ + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Roles.html b/doc/configs/Roles.html new file mode 100644 index 00000000..c1aebec6 --- /dev/null +++ b/doc/configs/Roles.html @@ -0,0 +1,300 @@ + + + + + + + + Roles config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Roles config

+

This is the main config file for the role system; file includes defines for roles and role flags and default values

+

+ + + + + + + + + + + + + +

Dependencies

+ + + + + + + +
expcore.roles
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.roles +
+
+
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Science.html b/doc/configs/Science.html new file mode 100644 index 00000000..d279267e --- /dev/null +++ b/doc/configs/Science.html @@ -0,0 +1,362 @@ + + + + + + + + Science config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Science config

+

Config file for the science info gui

+

+ + + + + + + + + + + + + +

Settings

+ + + + + + + + + + + + + +
show_eta
color_clamp
color_flux
+ + +
+ + +

Settings

+
+
+
+
+ # + show_eta +
+
+
+
+ +

+

when true the eta for research completion will be shown

+ + + + + + + + + + + + + + +
+
+
+
+ # + color_clamp +
+
+
+
+ +

+

the amount required for the text to show as green or red

+ + + + + + + + + + + + + + +
+
+
+
+ # + color_flux +
+
+
+
+ +

+

the ammount of flucuation allowed in production before icon change

+ + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Scorched-Earth.html b/doc/configs/Scorched-Earth.html new file mode 100644 index 00000000..508bde53 --- /dev/null +++ b/doc/configs/Scorched-Earth.html @@ -0,0 +1,396 @@ + + + + + + + + Scorched-Earth config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Scorched-Earth config

+

This file controls the placement/degrading of tiles as players build and walk

+

+ + + + + + + + + + + + + +

Settings

+ + + + + + + + + + + + + + + + +
weakness_value
strengths
degrade_order
entities
+ + +
+ + +

Settings

+
+
+
+
+ # + weakness_value +
+
+
+
+ +

+

lower value will make tiles more likely to degrade

+ + + + + + + + + + + + + + +
+
+
+
+ # + strengths +
+
+
+
+ +

+

this decides how "strong" a tile is, bigger number means less likely to degrade + debug: /interface require('modules.addons.worn-paths')(player.name,true) + note: tiles are effected by the tiles around them, so player paths will not degrade as fast when made wider + note: values are relative to the tile with the highest value, recommended to keep highest tile as a "nice" number + note: tiles not in list will never degrade under any conditions (which is why some are omitted such as water)

+ + + + + + + + + + + + + + +
+
+
+
+ # + degrade_order +
+
+
+
+ +

+

when a tile degrades it will turn into the next tile given here

+ + + + + + + + + + + + + + +
+
+
+
+ # + entities +
+
+
+
+ +

+

entities in this list will degrade the tiles under them when they are placed

+ + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Spawn-Area.html b/doc/configs/Spawn-Area.html new file mode 100644 index 00000000..9b9a9a5a --- /dev/null +++ b/doc/configs/Spawn-Area.html @@ -0,0 +1,752 @@ + + + + + + + + Spawn-Area config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Spawn-Area config

+

Used to config the spawn generation settings yes there is alot here i know just ignore the long tables at the end (they were generated with a command)

+

+ + + + + + + + + + + + + +

Settings

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
infinite_ammo_turrets
enabled
ammo_type
locations
afk_belts
enabled
locations
corrections
protect_entities
offset
deconstruction_radius
deconstruction_tile
pattern_radius
pattern_tile
entities
tiles
+ + +
+ + +

Settings

+
+
+
+
+ # + infinite_ammo_turrets +
+
+
+
+ +

+

These turrets will have they ammo refilled automatically and can not be looted

+ + + + + + + + + + + + + + +
+
+
+
+ # + enabled +
+
+
+
+ +

+

weather the turrets will be created and refilled

+ + + + + + + + + + + + + + +
+
+
+
+ # + ammo_type +
+
+
+
+ +

+

the ammo type that will be used

+ + + + + + + + + + + + + + +
+
+
+
+ # + locations +
+
+
+
+ +

+

locations of all turrets, this is default it can be changed during runtime

+ + + + + + + + + + + + + + +
+
+
+
+ # + afk_belts +
+
+
+
+ +

+

setting relating to afk belts round the spawn point

+ + + + + + + + + + + + + + +
+
+
+
+ # + enabled +
+
+
+
+ +

+

weather afk belts will be generated

+ + + + + + + + + + + + + + +
+
+
+
+ # + locations +
+
+
+
+ +

+

top left connors of any afk belt loops to be added

+ + + + + + + + + + + + + + +
+
+
+
+ # + corrections +
+
+
+
+ +

+

Some settings that have no where else to go

+ + + + + + + + + + + + + + +
+
+
+
+ # + protect_entities +
+
+
+
+ +

+

if the spawn entites will be protected

+ + + + + + + + + + + + + + +
+
+
+
+ # + offset +
+
+
+
+ +

+

a global offset value to correct the x and y values of the tables below

+ + + + + + + + + + + + + + +
+
+
+
+ # + deconstruction_radius +
+
+
+
+ +

+

when the spawn is made this area will have all entities removed first

+ + + + + + + + + + + + + + +
+
+
+
+ # + deconstruction_tile +
+
+
+
+ +

+

this is the tile that will spawn in the deconstruction radius

+ + + + + + + + + + + + + + +
+
+
+
+ # + pattern_radius +
+
+
+
+ +

+

this is the radius of the pattern all water in this area will be filled

+ + + + + + + + + + + + + + +
+
+
+
+ # + pattern_tile +
+
+
+
+ +

+

the tile that is used for the pattern

+ + + + + + + + + + + + + + +
+
+
+
+ # + entities +
+
+
+
+ +

+

All entities that will be created as part of spawn {entity-name,x-pos,y-pos}

+ + + + + + + + + + + + + + +
+
+
+
+ # + tiles +
+
+
+
+ +

+

The location of the "pattern" tiles {x-pos,y-pos}

+ + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Tasks.html b/doc/configs/Tasks.html new file mode 100644 index 00000000..6072ae03 --- /dev/null +++ b/doc/configs/Tasks.html @@ -0,0 +1,392 @@ + + + + + + + + Tasks config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Tasks config

+

Config file for the tasks gui

+

+ + + + + + + + + + + + + +

Settings

+ + + + + + + + + + + + + + + + +
any_user_can_add_new_task
user_can_edit_own_tasks
only_admins_can_edit
edit_tasks_role_permission
+ + +
+ + +

Settings

+
+
+
+
+ # + any_user_can_add_new_task +
+
+
+
+ +

+

when false only people with edit permission can make new reports

+ + + + + + + + + + + + + + +
+
+
+
+ # + user_can_edit_own_tasks +
+
+
+
+ +

+

when false only people with edit permission can edit reports

+ + + + + + + + + + + + + + +
+
+
+
+ # + only_admins_can_edit +
+
+
+
+ +

+

true will hide the edit and delete buttons from non (game) admins

+ + + + + + + + + + + + + + +
+
+
+
+ # + edit_tasks_role_permission +
+
+
+
+ +

+

value used with custom permission system

+ + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Warnings.html b/doc/configs/Warnings.html new file mode 100644 index 00000000..f3edf5aa --- /dev/null +++ b/doc/configs/Warnings.html @@ -0,0 +1,363 @@ + + + + + + + + Warnings config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Warnings config

+

Config file for the warning system, this is very similar to reports but is for the use of moderators rather than normal users.

+

+ + + + + + + + + + + + + +

Settings

+ + + + + + + + + + + + + +
actions
script_warning_cool_down
script_warning_limit
+ + +
+ + +

Settings

+
+
+
+
+ # + actions +
+
+
+
+ +

+

what actions are taking at number of warnings + if a localized string is used then __1__ will by_player_name and __2__ will be the current warning count (auto inserted)

+ + + + + + + + + + + + + + +
+
+
+
+ # + script_warning_cool_down +
+
+
+
+ +

+

time for a script warning (given by script) to be removed (in minutes)

+ + + + + + + + + + + + + + +
+
+
+
+ # + script_warning_limit +
+
+
+
+ +

+

the number of script warnings (given by script) that are allowed before full warnings are given

+ + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/configs/Warps.html b/doc/configs/Warps.html new file mode 100644 index 00000000..8800c822 --- /dev/null +++ b/doc/configs/Warps.html @@ -0,0 +1,692 @@ + + + + + + + + Warps config + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Warps config

+

This file contains all the different settings for the warp system and gui

+

+ + + + + + + + + + + + + +

Settings

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
recharge_time
update_smoothing
minimum_distance
activation_range
spawn_activation_range
default_icon
user_can_edit_own_warps
any_user_can_add_new_warp
only_admins_can_edit
edit_warps_role_permission
bypass_warp_limits_permission
entities
base_tile
tiles
+ + +
+ + +

Settings

+
+
+
+
+ # + recharge_time +
+
+
+
+ +

+

The amount of time in seconds that the player must wait between warps, acts as a balance

+ + + + + + + + + + + + + + +
+
+
+
+ # + update_smoothing +
+
+
+
+ +

+

Higher is better, the amount of smoothing applied to recharge timer and other gui updates, max is 60

+ + + + + + + + + + + + + + +
+
+
+
+ # + minimum_distance +
+
+
+
+ +

+

The minimum distance that must be between warp points, creating new ones is blocked when too close

+ + + + + + + + + + + + + + +
+
+
+
+ # + activation_range +
+
+
+
+ +

+

The distance the player must be to a warp in order to use the warp gui, gui can still be viewed but not used

+ + + + + + + + + + + + + + +
+
+
+
+ # + spawn_activation_range +
+
+
+
+ +

+

A second activation range which is used for the forces spawn point

+ + + + + + + + + + + + + + +
+
+
+
+ # + default_icon +
+
+
+
+ +

+

The default icon which is used by warps; must be an item name

+ + + + + + + + + + + + + + +
+
+
+
+ # + user_can_edit_own_warps +
+
+
+
+ +

+

When true the user can always edit warps which they created regardless of other settings

+ + + + + + + + + + + + + + +
+
+
+
+ # + any_user_can_add_new_warp +
+
+
+
+ +

+

When true any user is able to create new warps, however editing may still be restricted

+ + + + + + + + + + + + + + +
+
+
+
+ # + only_admins_can_edit +
+
+
+
+ +

+

When true only admins can edit warps

+ + + + + + + + + + + + + + +
+
+
+
+ # + edit_warps_role_permission +
+
+
+
+ +

+

Role permission used by the role system to allow editing warps

+ + + + + + + + + + + + + + +
+
+
+
+ # + bypass_warp_limits_permission +
+
+
+
+ +

+

Role permission used by the role system to allow bypassing the time and distance restrictions

+ + + + + + + + + + + + + + +
+
+
+
+ # + entities +
+
+
+
+ +

+

The entities which are created for warps

+ + + + + + + + + + + + + + +
+
+
+
+ # + base_tile +
+
+
+
+ +

+

The tile which is used for the warps

+ + + + + + + + + + + + + + +
+
+
+
+ # + tiles +
+
+
+
+ +

+

The tiles which are created for warps

+ + + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/control/Jail.html b/doc/control/Jail.html index d4e42066..5f68c34b 100644 --- a/doc/control/Jail.html +++ b/doc/control/Jail.html @@ -64,61 +64,117 @@ + + + + +