Added code from the wiki mod creation guide (#6)

Author: NikkelM

src/.gitignore

@@ -1,2 +1,12 @@
-# Thunderstore CLI build output
-build/
+# For files used only by a symlink to the ReturnOfModding plugins folder
+/src/LICENSE
+/src/icon.png
+/src/manifest.json
+
+# For source files used to build packages
+/packages
+
+# For build artifacts created by the Thunderstore CLI
+/build
+# For the Thunderstore CLI executable itself, if you include it in your root folder
+tcli.exe

src/src/main.lua

@@ -41,14 +41,16 @@ public.config = config -- so other mods can access our config
 local function on_ready()
 	-- what to do when we are ready, but not re-do on reload.
 	if config.enabled == false then return end
-	
+	mod = modutil.mod.Mod.Register(_PLUGIN.guid)
+
 	import 'ready.lua'
 end
 
 local function on_reload()
 	-- what to do when we are ready, but also again on every reload.
 	-- only do things that are safe to run over and over.
-	
+	if config.enabled == false then return end
+
 	import 'reload.lua'
 end
 

src/src/ready.lua

@@ -7,8 +7,8 @@
 -- 	so you will most likely want to have it reference
 --	values and functions later defined in `reload.lua`.
 
+-- These are some sample code snippets of what you can do with our modding framework:
 local file = rom.path.combine(rom.paths.Content, 'Game/Text/en/ShellText.en.sjson')
-
 sjson.hook(file, function(data)
 	return sjson_ShellText(data)
 end)
@@ -20,4 +20,56 @@ end)
 
 game.OnControlPressed({'Gift', function()
 	return trigger_Gift()
-end})
+end})
+
+
+-- Everything below this line is part of the example mod creation guide,
+-- which you can find on our wiki, replacing Schelemeus portrait:
+-- https://sgg-modding.github.io/Hades2ModWiki/docs/category/creating-your-first-mod
+-- Note that the custom .pkg files are not included in the template, and you will
+-- need to create them yourself if you want to follow the tutorial.
+
+-----------------------------------------------------------
+--------------- Step 1: Loading the package ---------------
+-----------------------------------------------------------
+
+------- Method 1: Calling the package load function when entering the Hub_PreRun room
+-- modutil.mod.Path.Wrap("DeathAreaRoomTransition", function(base, source, args)
+--   if game.CurrentHubRoom.Name == "Hub_PreRun" then
+--     mod.LoadSkellyPackage()
+--     end
+--   base(source, args)
+-- end)
+
+
+------- Method 2: Adding the package load function to the Schelemeus setup events
+-- local loadSkellyPackageCall = { FunctionName = _PLUGIN.guid .. ".LoadSkellyPackage" }
+-- table.insert(game.EnemyData.NPC_Skelly_01.SetupEvents, loadSkellyPackageCall)
+
+
+------- Method 3: Adding the package to the list of packages loaded whenever Schelemeus is spawned
+local customPortraitsPackageName = _PLUGIN.guid .. "Portraits"
+table.insert(game.EnemyData.NPC_Skelly_01.LoadPackages, customPortraitsPackageName)
+
+
+-----------------------------------------------------------
+----------- Step 2: Modifying the portrait path -----------
+-----------------------------------------------------------
+
+-- All packages built by `deppth2 hpk` will have the package name as part of all file paths, to prevent mods from clashing
+-- If you added any nested folders in your package, include them here as well
+local newPortraitFilePath = _PLUGIN.guid .. "Portraits\\Portraits_Skelly_01"
+
+-- rom.path.combine is provided by Hell2Modding to build file paths correctly across different operating systems
+-- rom.paths.Content() will return the path to the Content folder of the current Hades II installation
+local guiPortraitsVFXFile = rom.path.combine(rom.paths.Content(), "Game\\Animations\\GUI_Portraits_VFX.sjson")
+
+sjson.hook(guiPortraitsVFXFile, function(data)
+  for _, entry in ipairs(data.Animations) do
+    if entry.Name == "Portrait_Skelly_Default_01" or entry.Name == "Portrait_Skelly_Default_01_Exit" then
+      entry.FilePath = newPortraitFilePath
+			entry.CreateAnimations = {}
+			entry.OffsetY = 0
+    end
+  end
+end)

src/src/reload.lua

@@ -5,6 +5,8 @@
 -- this file will be reloaded if it changes during gameplay,
 -- 	so only assign to values or define things here.
 
+
+-- These functions are part of the example code snippets from ready.lua
 function sjson_ShellText(data)
 	for _,v in ipairs(data.Texts) do
 		if v.Id == 'MainMenuScreen_PlayGame' then
@@ -21,4 +23,14 @@ end
 
 function trigger_Gift()
 	modutil.mod.Hades.PrintOverhead(config.message)
-end
+end
+
+
+-------------------------------------------------------------------
+-- This function is part of the mod creation guide from the wiki --
+-------------------------------------------------------------------
+function mod.LoadSkellyPackage()
+	local packageName = _PLUGIN.guid .. "Portraits"
+	print("AuthorName-ModName - Loading package: " .. packageName)
+	LoadPackages({ Name = packageName })
+end

src/thunderstore.toml

@@ -5,13 +5,13 @@ schemaVersion = "0.0.1"
 [package]
 namespace = "AuthorName"
 name = "ModName"
-versionNumber = "0.0.0"
+versionNumber = "0.0.1"
 description = "Allows to do some super duper thing."
 websiteUrl = "https://github.com/AuthorName/ModName"
 containsNsfwContent = false
 
 [package.dependencies]
-Hell2Modding-Hell2Modding = "1.0.67"
+Hell2Modding-Hell2Modding = "1.0.70"
 LuaENVY-ENVY = "1.2.0"
 SGG_Modding-Chalk = "2.1.1"
 SGG_Modding-ReLoad = "1.0.2"
@@ -36,7 +36,7 @@ target = "./LICENSE"
 source = "./src"
 target = "./plugins"
 
-# Remove the commented lines below if you have files to copy to the plugins_data folder (like custom .pkg files)
+# Uncomment (remove the #) the three lines below if you have any files to copy to the plugins_data folder (like custom .pkg files)
 # [[build.copy]]
 # source = "./data"
 # target = "./plugins_data"