Addons

modules/addons/advanced-start.lua

@@ -1,4 +1,6 @@
 --- Adds a better method of player starting items based on production levels.
+-- @addon Advanced-Start
+
 local Event = require 'utils.event' --- @dep utils.event
 local Game = require 'utils.game' --- @dep utils.game
 local config = require 'config.advanced_start' --- @dep config.advanced_start

modules/addons/chat-popups.lua

@@ -1,5 +1,7 @@
---- Creates flying text entities when a player sends a message in chat
+--- Creates flying text entities when a player sends a message in chat;
 -- also displays a ping above users who are named in the message
+-- @addon Chat-Popups
+
 local Game = require 'utils.game' --- @dep utils.game
 local Event = require 'utils.event' --- @dep utils.event
 local config = require 'config.popup_messages' --- @dep config.popup_messages

modules/addons/chat-reply.lua

@@ -1,3 +1,6 @@
+--- Adds auto replies to chat messages; aswell as chat commands
+-- @addon Chat-Reply
+
 local Event = require 'utils.event' --- @dep utils.event
 local Game = require 'utils.game' --- @dep utils.game
 local Roles = require 'expcore.roles' --- @dep expcore.roles

modules/addons/compilatron.lua

@@ -1,3 +1,6 @@
+--- Adds a compilatron that walks around the spawn area; adapted from redmew code
+-- @addon Compilatron
+
 local Event = require 'utils.event' --- @dep utils.event
 local Global = require 'utils.global' --- @dep utils.global
 local Game = require 'utils.game' --- @dep utils.game
@@ -62,7 +65,7 @@ end
 Event.on_nth_tick(config.message_cycle, circle_messages)
 
 --- This will add a compilatron to the global and start his message cycle
--- @tparam entity LuaEntity the compilatron entity that moves around
+-- @tparam LuaEntity entity the compilatron entity that moves around
 -- @tparam string name the name of the location that the complitron is at
 function Public.add_compilatron(entity, name)
     if not entity and not entity.valid then

modules/addons/damage-popups.lua

@@ -1,5 +1,7 @@
---- Displays the amount of dmg that is done by players to entities
+--- Displays the amount of dmg that is done by players to entities;
 -- also shows player health when a player is attacked
+-- @addon Damage-Popups
+
 local Game = require 'utils.game' --- @dep utils.game
 local Event = require 'utils.event' --- @dep utils.event
 local config = require 'config.popup_messages' --- @dep config.popup_messages

modules/addons/death-logger.lua

@@ -1,3 +1,6 @@
+--- Makes markers on the map where places have died and reclaims items if not recovered
+-- @addon Death-Logger
+
 local Event = require 'utils.event' --- @dep utils.event
 local Game = require 'utils.game' --- @dep utils.game
 local Global = require 'utils.global' --- @dep utils.global

modules/addons/discord-alerts.lua

@@ -1,3 +1,6 @@
+--- Sends alert messages to our discord server when certain events are triggered
+-- @addon Discord-Alerts
+
 local Event = require 'utils.event' --- @dep utils.event
 local Game = require 'utils.game' --- @dep utils.game
 local Colors = require 'resources.color_presets' --- @dep resources.color_presets

modules/addons/pollution-grading.lua

@@ -1,3 +1,6 @@
+--- Makes polution look much nice of the map, ie not one big red mess
+-- @addon Pollution-Grading
+
 local Event = require 'utils.event' --- @dep utils.event
 local config = require 'config.pollution_grading' --- @dep config.pollution_grading
 

modules/addons/random-player-colours.lua

@@ -1,3 +1,6 @@
+--- Gives players random colours when they join, also applies preset colours to those who have them
+-- @addon Player-Colours
+
 local Colours = require 'resources.color_presets' --- @dep resources.color_presets
 local Game = require 'utils.game' --- @dep utils.game
 local Event = require 'utils.event' --- @dep utils.event

modules/addons/scorched-earth.lua

@@ -1,3 +1,6 @@
+--- When a player walks around the tiles under them will degrade over time, the same is true when entites are built
+-- @addon Scorched-Earth
+
 local Event = require 'utils.event' --- @dep utils.event
 local Game = require 'utils.game' --- @dep utils.game
 local Global = require 'utils.global' --- @dep utils.global

modules/addons/spawn-area.lua

@@ -1,3 +1,6 @@
+--- Adds a custom spawn area with chests and afk turrets
+-- @addon Spawn-Area
+
 local Global = require 'utils.global' --- @dep utils.global
 local Event = require 'utils.event' --- @dep utils.event
 local Game = require 'utils.game' --- @dep utils.game