General English fixes (#52)

* Speeling fixes

* Speeling/capitalisation

* More speeling

* Label grammar consistency

* Consistency

* Phrasing

* Consistency

* Clarity of const

* Consistency

* Consistency

* Speeling

* Apostrophes: check whether they need escaping

* Capitalisation (more apostrophes need checking)

* Americanisation

* Clarity

* Contraction

* Clarity

* Speeling

Addons/Commands/admin.lua

@@ -8,7 +8,7 @@ Discord: https://discord.gg/r6dC2uK
 ]]
 --Please Only Edit Below This Line-----------------------------------------------------------
 
-commands.add_command('report', 'Reports a player.', {'player','reason',true}, function(event,args)
+commands.add_command('report', 'Reports a player', {'player','reason',true}, function(event,args)
     local _player = Game.get_player(event)
     local player = Game.get_player(args.player)
     local reason = args.reason
@@ -20,7 +20,7 @@ commands.add_command('report', 'Reports a player.', {'player','reason',true}, fu
     Admin.report(player,event.player_index,reason)
 end)
 
-commands.add_command('warn', 'Gives a player a warnings', {'player','reason',true}, function(event,args)
+commands.add_command('warn', 'Gives a player a warning', {'player','reason',true}, function(event,args)
     local player = Game.get_player(args.player)
     local reason = args.reason
     if not player then player_return({'commands.invalid-player',args.player}) return commands.error end
@@ -38,14 +38,14 @@ commands.add_command('jail', 'Jails a player', {'player','reason',true}, functio
     Admin.jail(player,event.player_index,reason)
 end)
 
-commands.add_command('unjail', 'Returns the players old rank', {'player',true}, function(event,args)
+commands.add_command('unjail', 'Returns a player\'s old rank', {'player',true}, function(event,args)
     local player = Game.get_player(args.player)
     if not player then player_return({'commands.invalid-player',args.player}) return commands.error end
     if Admin.is_banned(player) then player_return({'commands.cant-report-ban',args.player}) return commands.error end
     Ranking.revert(player,event.player_index)
 end)
 
-commands.add_command('temp-ban', 'Temporarily ban a player.', {'player','reason',true}, function(event,args)
+commands.add_command('temp-ban', 'Temporarily ban a player', {'player','reason',true}, function(event,args)
     local player = Game.get_player(args.player)
     local reason = args.reason
     if not player then player_return({'commands.invalid-player',args.player}) return commands.error end
@@ -53,28 +53,28 @@ commands.add_command('temp-ban', 'Temporarily ban a player.', {'player','reason'
     Admin.temp_ban(player,event.player_index,reason)
 end)
 
-commands.add_command('clear-inv', 'Clears the player\'s invetory', {'player'}, function(event,args)
+commands.add_command('clear-inv', 'Clears a player\'s invetory', {'player'}, function(event,args)
     local player = Game.get_player(args.player)
     if not player then player_return({'commands.invalid-player',args.player}) return commands.error end
     if Admin.is_banned(player) then player_return({'reports.cant-report-ban',args.player}) return commands.error end
     Admin.move_inventory(player)
 end)
 
-commands.add_command('clear-warnings', 'Clears the warnings on a player.', {'player'}, function(event,args)
+commands.add_command('clear-warnings', 'Clears a player\'s warnings', {'player'}, function(event,args)
     local player = Game.get_player(args.player)
     if not player then player_return({'commands.invalid-player',args.player}) return commands.error end
     if Admin.is_banned(player) then player_return({'reports.cant-report-ban',args.player}) return commands.error end
     Admin.clear_warings(player,event.player_index)
 end)
 
-commands.add_command('clear-reports', 'Clears the reports on a player.', {'player'}, function(event,args)
+commands.add_command('clear-reports', 'Clears a player\'s reports', {'player'}, function(event,args)
     local player = Game.get_player(args.player)
     if not player then player_return({'commands.invalid-player',args.player}) return commands.error end
     if Admin.is_banned(player) then player_return({'reports.cant-report-ban',args.player}) return commands.error end
     Admin.clear_reports(player,event.player_index)
 end)
 
-commands.add_command('clear-all', 'Clears reports and reports and removes temp-ban', {'player'}, function(event,args)
+commands.add_command('clear-all', 'Clears a player of any temp-ban, reports or warnings', {'player'}, function(event,args)
     local player = Game.get_player(args.player)
     if not player then player_return({'commands.invalid-player',args.player}) return commands.error end
     Admin.clear_player(player,event.player_index)

Addons/Commands/cheat-mode.lua

@@ -8,7 +8,7 @@ Discord: https://discord.gg/r6dC2uK
 ]]
 --Please Only Edit Below This Line-----------------------------------------------------------
 
-commands.add_command('cheat-mode', 'Toggles cheat mode for a player.', {'player'}, function(event,args)
+commands.add_command('cheat-mode', 'Toggles cheat mode for a player', {'player'}, function(event,args)
     local player = Game.get_player(args.player)
     if not player then player_return({'commands.invalid-player',args.player}) return commands.error end
     if player.cheat_mode == true then player.cheat_mode = false else player.cheat_mode = true end

Addons/Commands/home.lua

@@ -28,7 +28,7 @@ commands.add_command('home', 'Go to you home position', {}, function(event,args)
     player.teleport(player.surface.find_non_colliding_position('player',_homes()[player.index][1],32,1),player.surface)
 end)
 
-commands.add_command('return', 'Go to where you were before using /home', {}, function(event,args)
+commands.add_command('return', 'Return to your previous position after using /home', {}, function(event,args)
     local player = Game.get_player(event)
     if not _homes()[player.index] then _homes()[player.index] = {player.force.get_spawn_position(player.surface),player.force.get_spawn_position(player.surface)} end
     local _temp = {math.floor(player.position.x),math.floor(player.position.y)}

Addons/Commands/kill.lua

@@ -8,7 +8,7 @@ Discord: https://discord.gg/r6dC2uK
 ]]
 --Please Only Edit Below This Line-----------------------------------------------------------
 
-commands.add_command('kill', 'Kills a player. Must be either yourself (/kill self) or a person of a lower rank.', {'player'}, function(event,args)
+commands.add_command('kill', 'Kills a player. Must be either yourself (/kill self) or a person of a lower rank', {'player'}, function(event,args)
     local _player = Game.get_player(event)
     local player = Game.get_player(args.player)
     if args.player ~= 'self' and not player then player_return({'commands.invalid-player',args.player}) return commands.error end

Addons/Commands/repair.lua

@@ -8,7 +8,7 @@ Discord: https://discord.gg/r6dC2uK
 ]]
 --Please Only Edit Below This Line-----------------------------------------------------------
 
--- these items are not repaired, true means it is blocked
+-- Set an item to true to disallow it from being repaired
 local disallow = {
     ['loader']=true,
     ['fast-loader']=true,
@@ -18,7 +18,7 @@ local disallow = {
 }
 
 local const = 100
--- given const = 100: admin+ has unlimited, admin has 100, mod has 50, member has 20
+-- Given const = 100: admin+ has unlimited, admin has const (100), mod has const / 2 (50), member has const / 5 (20)
 
 commands.add_command('repair', 'Repairs all destoryed and damaged entites in an area.', {'range'}, function(event,args)
     local range = tonumber(args.range)

Addons/Commands/tags.lua

@@ -11,14 +11,14 @@ Discord: https://discord.gg/r6dC2uK
 local const = 20
 -- this is the max lenth of a tag
 
-commands.add_command('tag', 'Give yourself a custom tag. Use /tag-clear self to remove tag.', {'tag',true}, function(event,args)
+commands.add_command('tag', 'Give yourself a custom tag. Use /tag-clear self to remove tag', {'tag',true}, function(event,args)
     local player = Game.get_player(event)
     local rank = Ranking.get_rank(player)
     if string.len(args.tag) > const then player_return({'commands.invalid-length',const}) return commands.error end
     player.tag = rank.tag..' - '..args.tag
 end)
 
-commands.add_command('tag-clear', 'Removes a custom tag. Player can be self (/tag-clear self).', {'player'}, function(event,args)
+commands.add_command('tag-clear', 'Removes a custom tag. Player can be self (/tag-clear self)', {'player'}, function(event,args)
     local _player = Game.get_player(event)
     local _rank = Ranking.get_rank(_player)
     local player = Game.get_player(args.player)

Addons/Commands/tp.lua

@@ -8,13 +8,13 @@ Discord: https://discord.gg/r6dC2uK
 ]]
 --Please Only Edit Below This Line-----------------------------------------------------------
 
-commands.add_command('go-to', 'Go to a player\'s location.', {'player'}, function(event,args)
+commands.add_command('go-to', 'Go to a player\'s location', {'player'}, function(event,args)
     local player = Game.get_player(args.player)
     if not player then player_return({'commands.invalid-player',args.player}) return commands.error end
     Admin.go_to(player,event)
 end)
 
-commands.add_command('bring', 'Bring a player to your location.', {'player'}, function(event,args)
+commands.add_command('bring', 'Bring a player to your location', {'player'}, function(event,args)
     local player = Game.get_player(args.player)
     if not player then player_return({'commands.invalid-player',args.player}) return commands.error end
     Admin.bring(player,event)

Addons/Guis/polls.lua

@@ -8,7 +8,7 @@ Discord: https://discord.gg/r6dC2uK
 ]]
 --Please Only Edit Below This Line-----------------------------------------------------------
 
-local poll_time_out = 90 -- this is in seconds
+local poll_time_out = 90 -- In seconds
 
 local function _polls(reset)
     global.addons = not reset and global.addons or {}
@@ -50,7 +50,7 @@ local function _poll_data(question,answers)
         data={poll_uuid=poll.uuid},
         timeout=poll_time_out*60
     }:on_event('timeout',_poll_end):open()
-    -- this time out is knowen to cause desyncs and so i have moved it to a hard coded function
+    -- This time out is known to cause desyncs and so I have moved it to a hard coded function
     _polls().active[poll.uuid]=poll
     return poll.uuid
 end
@@ -257,4 +257,4 @@ Gui.popup.add{
         elseif Ranking.get_rank(player):allowed('create-poll') then return true
         else return {'polls.no-poll'} end
     end
-}
+}

Addons/load.lua

@@ -7,12 +7,12 @@ Any changes that you may make to the code are yours but that does not make the s
 Discord: https://discord.gg/r6dC2uK
 ]]
 --Please Only Edit Below This Line-----------------------------------------------------------
--- this file will just contain all the diffrent requires
+-- This file just contains all the diffrent requires
 
--- admin dir
+-- Admin dir
 require('Admin/player-info')
-require('Admin/admin') -- used with Guis/admin-gui, but can work without
-require('Admin/reports') -- this adds onto Admin/admin, adds report command and warnings, and temp ban
+require('Admin/admin') -- Used with Guis/admin-gui, but can work without
+require('Admin/reports') -- This adds onto Admin/admin, adds report command and warnings, and temp ban
 require('Admin/discord')
 require('Admin/auto-message')
 require('Admin/tree-decon')
@@ -21,28 +21,28 @@ require('Admin/base-damage')
 require('Admin/afk-kick')
 require('Admin/auto-chat')
 
--- commands dir
+-- Commands dir
 require('Commands/cheat-mode')
 require('Commands/kill')
 require('Commands/repair')
 require('Commands/bonus')
 require('Commands/tags')
 require('Commands/home')
-require('Commands/tp') -- requires Admin/admin
-require('Commands/admin') -- requires Admin/reports
+require('Commands/tp') -- Requires Admin/admin
+require('Commands/admin') -- Requires Admin/reports
 
--- guis dir
+-- GUIs dir
 require('Guis/readme')
 require('Guis/science')
 require('Guis/rockets')
 require('Guis/player-list')
 require('Guis/tasklist')
 require('Guis/warp-system')
-require('Guis/polls') -- too many desyncs
+require('Guis/polls') -- Too many desyncs
 require('Guis/announcements')
 require('Guis/rank-changer')
-require('Guis/admin-gui') -- used with Admin/admin, requires Admin/admin
-require('Guis/reports') -- requires Admin/reports
+require('Guis/admin-gui') -- Used with Admin/admin, requires Admin/admin
+require('Guis/reports') -- Requires Admin/reports
 require('Guis/game-settings')
 
--- other
+-- other

Addons/playerRanks.lua

@@ -10,21 +10,21 @@ Discord: https://discord.gg/r6dC2uK
 
 --[[
     How to use groups:
-name		the name that you can use to refence it.
-disallow	if present then all ranks in this group will have this added to their disallow.
-allow		if present then all ranks in this group will have this added to their allow.
-highest     is asigned by the script to show the highest rank in this group.
-lowest      is asigned by the script to show the lowest rank in this group.
+name		The name that you can use to reference it.
+disallow	If present then all ranks in this group will have this added to their disallow.
+allow		If present then all ranks in this group will have this added to their allow.
+highest     Assigned by the script to show the highest rank in this group.
+lowest      Assigned by the script to show the lowest rank in this group.
 How to add ranks:
-Name		is what will be used in the scripts and is often the best choice for display in text.
-short_hand	is what can be used when short on space but the rank still need to be displayed.
-tag			is the tag the player will gain when moved to the rank, it can be nil.
-time		is used for auto-rank feature where you are moved to the rank after a certain play time in minutes.
-colour		is the RGB value that can be used to emphasise GUI elements based on rank.
-power		is asigned by the script based on their index in ranks, you can insert new ranks between current ones.
-group		is asigned by the script to show the group this rank is in
-disallow	is a list containing input actions that the user can not perform.
-allow		is a list of custom commands and effects that that rank can use, all defined in the sctips.
+Name		What will be used in the scripts and is often the best choice for display in text.
+short_hand	What can be used when short on space but the rank still need to be displayed.
+tag			The tag the player will gain when moved to the rank, it can be nil.
+time		Used for auto-rank feature where you are moved to the rank after a certain play time in minutes.
+colour		The RGB value that can be used to emphasise GUI elements based on rank.
+power		Assigned by the script based on their index in ranks, you can insert new ranks between current ones.
+group		Assigned by the script to show the group this rank is in.
+disallow	A list containing input actions that the user can not perform.
+allow		A list of custom commands and effects that that rank can use, all defined in the scripts.
 
 For allow, add the allow as the key and the value as true
 Example: test for 'server-interface' => allow['server-interface'] = true
@@ -34,7 +34,7 @@ Example: defines.input_action.drop_item -> 'drop_item'
 http://lua-api.factorio.com/latest/defines.html#defines.input_action
 --]]
 
--- see ExpCore/ranks.lua for examples - you add your own and edit pre-made ones here.
+-- See ExpCore/ranks.lua for examples - you add your own and edit pre-made ones here.
 
 local groups = Ranking._groups(true)