Say what each file is for

khonkhortisan · Nov 17, 2018 · f8c4d4a · f8c4d4a
1 parent b0db804
commit f8c4d4a
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 0 deletions.
diff --git a/init.lua b/init.lua
@@ -1,3 +1,4 @@
+-- This file declares the mod. See Game.lua for the first file to take effect.
 -- Multiplayer Hack
 -- tome-multiplayer/init.lua
 

diff --git a/overload/mod/ai/party.lua b/overload/mod/ai/party.lua
@@ -1,3 +1,5 @@
+-- This file hands off control/items/autoexplore status to a player on their turn. See PlayerRun.lua, PlayerRest.lua
+
 local base_party_member_fct = function(self)
 --newAI("party_member", function(self)
 	local anchor = self.ai_state.tactic_leash_anchor

diff --git a/superload/engine/interface/PlayerRest.lua b/superload/engine/interface/PlayerRest.lua
@@ -1,3 +1,5 @@
+-- This file helps with handing over autoexplore status on player control switch. See PlayerRun.lua, party.lua
+
 local _M = loadPrevious(...)
 
 local base_restStop = _M.restStop

diff --git a/superload/engine/interface/PlayerRun.lua b/superload/engine/interface/PlayerRun.lua
@@ -1,3 +1,5 @@
+-- This file helps with handing over autoexplore status on player control switch. See PlayerRest.lua, party.lua
+
 local _M = loadPrevious(...)
 
 --local base_restStop = _M.restStop

diff --git a/superload/mod/class/Game.lua b/superload/mod/class/Game.lua
@@ -1,3 +1,5 @@
+-- This file manages adding extra players, saving, and has an attempt at fair transmogrification. See Birther.lua, party.lua
+
 local Party = require "mod.class.Party"
 local Player = require "mod.class.Player"
 local GameState = require "mod.class.GameState"

diff --git a/superload/mod/class/Object.lua b/superload/mod/class/Object.lua
@@ -1,3 +1,5 @@
+-- This file fixes only player1 allowed to autopickup items
+
 local _M = loadPrevious(...)
 local base_on_prepickup = _M.on_prepickup
 

diff --git a/superload/mod/class/Party.lua b/superload/mod/class/Party.lua
@@ -1,3 +1,5 @@
+-- -- This file is part of an attempt to manage deaths sanely in multiplayer. See DeathDialog.lua
+
 local Map = require "engine.Map"
 
 local _M = loadPrevious(...)

diff --git a/superload/mod/dialogs/Birther.lua b/superload/mod/dialogs/Birther.lua
@@ -1,3 +1,5 @@
+-- This file is an easter egg for creating a character wrong. See Game.lua
+
 local _M = loadPrevious(...)
 
 --mess with base dialog

diff --git a/superload/mod/dialogs/DeathDialog.lua b/superload/mod/dialogs/DeathDialog.lua
@@ -1,3 +1,5 @@
+-- This file is part of an attempt to manage deaths sanely in multiplayer. See Party.lua
+
 local _M = loadPrevious(...)
 
 --- Send the party to the Eidolon Plane