Added a Border Crystals support + fixes (#7)

* Update MethHelper.lua

- Fixed some Bugs
- Works now on Border Crystals

* Update README.md

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Fixed a Few bugs and added a Menu

README.md

@@ -3,7 +3,7 @@ A mod for PAYDAY 2 which notifies the player as to which meth ingredient is to b
 
 Mod will print the current required ingredient to the host of the mod (that's you) and nobody else. All messages from MethHelper will be preceeded by the tag "[MethHelper]".
 
-Works with Cook Off, Rats day 1, Hotline Miami day 1, and Bomb Dockyard.
+Works with Cook Off, Rats day 1, Hotline Miami day 1, Border Crystal and Bomb Dockyard.
 
 # How to install
 In order to install this mod, follow the outlined steps below:

lua/MethHelper.lua

@@ -1,77 +1,187 @@
+_G.MethHelper = _G.MethHelper or {}
+MethHelper._path = ModPath
+MethHelper._data_path = SavePath .. 'Meth_helper.txt'
+MethHelper._data = {}
+
+function MethHelper:Save()
+    local file = io.open(self._data_path, 'w+')
+    if file then
+        file:write(json.encode(self._data))
+        file:close()
+    end
+end
+
+function MethHelper:Load()
+    local file = io.open(self._data_path, 'r')
+    if file then
+        for k, v in pairs(json.decode(file:read('*all')) or {}) do
+            self._data[k] = v
+        end
+        file:close()
+    else
+        MethHelper._data.silent_toggle = false
+        MethHelper._data.active_toggle = true
+    end
+end
+
+Hooks:Add(
+    'LocalizationManagerPostInit',
+    'LocalizationManagerPostInit_MethHelper',
+    function(loc)
+        loc:load_localization_file(MethHelper._path .. 'menu/' .. 'lang.json')
+    end
+)
+
+Hooks:Add(
+    'MenuManagerInitialize',
+    'MenuManagerInitialize_MethHelper',
+    function(menu_manager)
+        --[[
+		Setup our callbacks as defined in our item callback keys, and perform our logic on the data retrieved.
+	]]
+        MenuCallbackHandler.callback_meth_helper_active = function(self, item)
+            MethHelper._data.meth_helper_active_value = (item:value() == 'on' and true or false)
+            MethHelper._data.active_toggle = item:value()
+            MethHelper:Save()
+        end
+
+        MenuCallbackHandler.callback_meth_helper_silent = function(self, item)
+            MethHelper._data.meth_helper_silent_value = (item:value() == 'on' and true or false)
+            MethHelper._data.silent_toggle = item:value()
+            MethHelper:Save()
+        end
+
+        --[[
+		Load our previously saved data from our save file.
+	]]
+        MethHelper:Load()
+
+        --[[
+		Load our menu json file and pass it to our MenuHelper so that it can build our in-game menu for us.
+		We pass our parent mod table as the second argument so that any keybind functions can be found and called
+			as necessary.
+		We also pass our data table as the third argument so that our saved values can be loaded from it.
+	]]
+        MenuHelper:LoadFromJsonFile(MethHelper._path .. 'menu/menu.json', MethHelper, MethHelper._data)
+    end
+)
+
 -- Dialogue event codes
-local RatsFinishedID = "pln_rat_stage1_28"
-local RatsAddedID = "pln_rat_stage1_12"
-local CookoffFinishedID = "pln_rt1_28"
-local CookoffAddedID = "pln_rt1_12"
+local RatsFinishedID = 'pln_rat_stage1_28'
+local RatsAddedID = 'pln_rat_stage1_12'
+local CookoffFinishedID = 'pln_rt1_28'
+local CookoffAddedID = 'pln_rt1_12'
+local BorderCrystalFinsishedID = 'Play_loc_mex_cook_17'
+local BorderCrystalFinsishedID2 = 'Play_loc_mex_cook_13'
+local BorderCrystalAddedID = 'Play_loc_mex_cook_22'
 
 -- Dictionary mapping dialogue codes to plain text ingredients
 local ingredient_dialog = {}
-ingredient_dialog["pln_rt1_20"] = "Muriatic Acid"
-ingredient_dialog["pln_rt1_22"] = "Caustic Soda"
-ingredient_dialog["pln_rt1_24"] = "Hydrogen Chloride"
-ingredient_dialog["pln_rat_stage1_20"] = "Muriatic Acid"
-ingredient_dialog["pln_rat_stage1_22"] = "Caustic Soda"
-ingredient_dialog["pln_rat_stage1_24"] = "Hydrogen Chloride"
+ingredient_dialog['pln_rt1_20'] = 'Muriatic Acid'
+ingredient_dialog['pln_rt1_22'] = 'Caustic Soda'
+ingredient_dialog['pln_rt1_24'] = 'Hydrogen Chloride'
+ingredient_dialog['pln_rat_stage1_20'] = 'Muriatic Acid'
+ingredient_dialog['pln_rat_stage1_22'] = 'Caustic Soda'
+ingredient_dialog['pln_rat_stage1_24'] = 'Hydrogen Chloride'
+ingredient_dialog['Play_loc_mex_cook_03'] = 'Muriatic Acid'
+ingredient_dialog['Play_loc_mex_cook_04'] = 'Caustic Soda'
+ingredient_dialog['Play_loc_mex_cook_05'] = 'Hydrogen Chloride'
 -- Round about hacky way to trigger by both ingredients and recipe state dialogue
-ingredient_dialog [RatsFinishedID] = true
-ingredient_dialog [RatsAddedID] = true
-ingredient_dialog [CookoffFinishedID] = true
-ingredient_dialog [CookoffAddedID] = true
+ingredient_dialog[RatsFinishedID] = true
+ingredient_dialog[RatsAddedID] = true
+ingredient_dialog[CookoffFinishedID] = true
+ingredient_dialog[CookoffAddedID] = true
+ingredient_dialog[BorderCrystalFinsishedID] = true
+ingredient_dialog[BorderCrystalFinsishedID2] = true
+ingredient_dialog[BorderCrystalAddedID] = true
 
--- Track number of ingredients in current meth recipe 
-local currentRecipe = 1
 -- Track total number of bags made
 local totalBags = 0
 -- Track current recipe state
 local currentRecipeList = {}
-currentRecipeList ["Muriatic Acid"] = false
-currentRecipeList ["Caustic Soda"] = false
-currentRecipeList ["Hydrogen Chloride"] = false
-
--- Math.Clamp
-function clampCeiling (val, vMax)
-	if val > vMax then
-		val = vMax
-	end
-
-	return val
-
+currentRecipeList['Muriatic Acid'] = false
+currentRecipeList['Caustic Soda'] = false
+currentRecipeList['Hydrogen Chloride'] = false
+
+IngredientCount = 0
+OldIngredientCount = 0
+
+function countAddedIngredients(Table)
+    local count = 0
+    for i, v in pairs(Table) do
+        if v == true then
+            count = count + 1
+        end
+    end
+    return count
+end
+
 -- Trigger this every time there is dialogue
 local _queue_dialog_orig = DialogManager.queue_dialog
 function DialogManager:queue_dialog(id, ...)
-	
+
     -- If dialogue code is found in dict
-    if ingredient_dialog[id] then
-		-- If "batch finished" dialogue is played
-		if id == CookoffFinishedID or id == RatsFinishedID then
-			currentRecipe = 1
-			totalBags = totalBags + 1
-			-- Reset recipe state
-			currentRecipeList ["Muriatic Acid"] = false
-			currentRecipeList ["Caustic Soda"] = false
-			currentRecipeList ["Hydrogen Chloride"] = false
-
-			managers.chat:_receive_message (1, "[MethMagic]", "Total bags: [" .. totalBags .. "]", Color.green)
-
-		-- If "ingredient added" dialogue is played
-		elseif (id == CookoffAddedID or id == RatsAddedID) and (currentRecipe ["Muriatic Acid"] == true and currentRecipeList ["Caustic Soda"] == true and currentRecipeList ["Hydrogen Chloride"] ==  true) then
-			currentRecipe = clampCeiling (currentRecipe + 1, 3)
-
-		-- Else ID is for ingredient
-		else
-			-- Check to make sure that the ingredient is not already being echoed
-			if currentRecipeList [ingredient_dialog [id]] == false then
-				-- Flip the flag
-				currentRecipeList [ingredient_dialog [id]] = true
-
-				-- Print text
-				managers.chat:_receive_message (1, "[MethMagic]", "[" .. currentRecipe .. "/3] [" .. ingredient_dialog[id] .. "]", Color.green)
-			end
-		end
-	end
-
+    if ingredient_dialog[id] and MethHelper._data.active_toggle == true or MethHelper._data.active_toggle == 'on' then
+        -- If "batch finished" dialogue is played
+        if id == CookoffFinishedID or id == RatsFinishedID or id == BorderCrystalFinsishedID or id == BorderCrystalFinsishedID2 then
+            -- If "ingredient added" dialogue is played
+            OldIngredientCount = 0
+            totalBags = totalBags + 1
+            -- Reset recipe state
+            currentRecipeList['Muriatic Acid'] = false
+            currentRecipeList['Caustic Soda'] = false
+            currentRecipeList['Hydrogen Chloride'] = false
+            -- check menu options
+            if MethHelper._data.silent_toggle == true or MethHelper._data.silent_toggle == 'on' then
+                managers.chat:_receive_message(1, '[SilentMethMagic]', 'Total bags: [' .. totalBags .. ']', Color.green)
+            else
+                managers.chat:send_message(1, '[SilentMethMagic]', 'Total bags: [' .. totalBags .. ']', Color.green)
+            end
+        elseif
+            (id == CookoffAddedID or id == RatsAddedID or id == BorderCrystalAddedID) and ((currentRecipeList['Muriatic Acid'] == true and currentRecipeList['Caustic Soda'] == true and currentRecipeList['Hydrogen Chloride'] == true) == false) and
+                ((currentRecipeList['Muriatic Acid'] == false and currentRecipeList['Caustic Soda'] == false and currentRecipeList['Hydrogen Chloride'] == false) == false)
+         then
+            IngredientCount = countAddedIngredients(currentRecipeList)
+            if IngredientCount > OldIngredientCount then
+                OldIngredientCount = IngredientCount
+                if MethHelper._data.silent_toggle == true or MethHelper._data.silent_toggle == 'on' then
+                    managers.chat:_receive_message(1, '[SilentMethMagic]', 'Ingredient added!', Color.green)
+                else
+                    managers.chat:send_message(1, '[SilentMethMagic]', 'Ingredient added!', Color.green)
+                end
+            end
+        elseif (id == CookoffAddedID or id == RatsAddedID or id == BorderCrystalAddedID) and countAddedIngredients(currentRecipeList) == 3 then
+            -- Else ID is for ingredient
+            IngredientCount = countAddedIngredients(currentRecipeList)
+            if IngredientCount > OldIngredientCount then
+                OldIngredientCount = IngredientCount
+                if MethHelper._data.silent_toggle == true or MethHelper._data.silent_toggle == 'on' then
+                    managers.chat:_receive_message(1, '[SilentMethMagic]', 'Ingredient added!', Color.green)
+                else
+                    managers.chat:send_message(1, '[SilentMethMagic]', 'Ingredient added!', Color.green)
+                end
+            end
+        else
+            -- Check to make sure that the ingredient is not already being echoed
+            if currentRecipeList[ingredient_dialog[id]] == false then
+                -- Flip the flag
+                currentRecipeList[ingredient_dialog[id]] = true
+
+                -- Print text
+                if MethHelper._data.silent_toggle == true or MethHelper._data.silent_toggle == 'on' then
+                    managers.chat:_receive_message(1, '[SilentMethMagic]', '[' .. countAddedIngredients(currentRecipeList) .. '/3] [' .. ingredient_dialog[id] .. ']', Color.green)
+                else
+                    managers.chat:send_message(1, '[SilentMethMagic]', '[' .. countAddedIngredients(currentRecipeList) .. '/3] [' .. ingredient_dialog[id] .. ']', Color.green)
+                end
+            end
+        end
+    end
+    -- for event mapping
+    -- log("DialogManager: said " .. tostring(id))
+    -- managers.chat:send_message(ChatManager.GAME, managers.network.account:username() or "Offline", id)
+
     return _queue_dialog_orig(self, id, ...)
 end
 -- feed_system_message () shows it to you and nobody else
-		-- send_message () shows it to everyone
-		-- _receive_message () shows it to everyone
+-- send_message () shows it to everyone
+-- _receive_message () shows it to everyone

menu/lang.json

@@ -0,0 +1,8 @@
+{
+    "methHelper_title" : "Methhelper Menu",
+    "methHelper_menu_desc" : "A few options for the Methhelper Mod!",
+    "meth_helper_active_toggle" : "Methhelper Active?",
+    "meth_helper_active_desc" : "Enable or disable Methhelper",
+    "meth_helper_silent_toggle" : "Silentmode?",
+    "meth_helper_silent_desc" : "When in Silent mode only you get the chat messages, while when not in silent mode every one gets the message!"
+}

menu/menu.json

@@ -0,0 +1,27 @@
+{
+	"menu_id" : "methHelper_menu",
+	"parent_menu_id" : "blt_options",
+	"title" : "methHelper_title",
+	"description" : "methHelper_menu_desc",
+	"items" : [
+
+		{
+			"type" : "toggle",
+			"id" : "meth_helper_active",
+			"title" : "meth_helper_active_toggle",
+			"description" : "meth_helper_active_desc",
+			"callback" : "callback_meth_helper_active",
+			"value" : "meth_helper_active_value",
+			"default_value" : true
+        },
+        {
+			"type" : "toggle",
+			"id" : "meth_helper_silent",
+			"title" : "meth_helper_silent_toggle",
+			"description" : "meth_helper_silent_desc",
+			"callback" : "callback_meth_helper_silent",
+			"value" : "meth_helper_silent_value",
+			"default_value" : false
+        }
+    ]
+}

mod.txt

@@ -14,6 +14,7 @@
 	],
 	"hooks" : 
 	[
-		{"hook_id" : "lib/managers/dialogmanager", "script_path" : "lua/MethHelper.lua"}
+		{"hook_id" : "lib/managers/dialogmanager", "script_path" : "lua/MethHelper.lua"},
+		{"hook_id" : "lib/managers/menumanager","script_path" : "lua/MethHelper.lua"}
 	]
 }