use updated chalk interface

Author: AndreLouisIssa

CHANGELOG.md

@@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Added dedicated `ready` and `reload` files so `main.lua` can be ignored for simple mods.
+- Added a stub `defs.lua` as a reminder to document the plugin if relevant.
+
+### Changed
+
+- Default template is more up-to-date.
+
+## [0.5.1] - 2024-05-15
+
+### Fixed
+
+- Use `plugins` as target for `src` files to prevent flattening the Thunderstore package on decompression.
+
+## [0.5.0] - 2024-05-15
+
 ### Changed
 
 - Default template is now a valid example plugin
@@ -43,7 +60,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - First version of the template!
 
-[unreleased]: https://github.com/SGG-Modding/Hades2ModTemplate/compare/0.4.0...HEAD
+[unreleased]: https://github.com/SGG-Modding/Hades2ModTemplate/compare/0.5.1...HEAD
+[0.5.1]: https://github.com/SGG-Modding/Hades2ModTemplate/compare/0.5.0...0.5.1
+[0.5.0]: https://github.com/SGG-Modding/Hades2ModTemplate/compare/0.4.0...0.5.0
 [0.4.0]: https://github.com/SGG-Modding/Hades2ModTemplate/compare/0.3.0...0.4.0
 [0.3.0]: https://github.com/SGG-Modding/Hades2ModTemplate/compare/0.2.0...0.3.0
 [0.2.0]: https://github.com/SGG-Modding/Hades2ModTemplate/compare/0.1.0...0.2.0

src/src/def.lua

@@ -0,0 +1,12 @@
+---@meta AuthorName-ModName
+local public = {}
+
+-- document whatever you made publicly available to other plugins here
+-- use luaCATS annotations and give descriptions where appropriate
+--  e.g. 
+--	---@param a integer helpful description
+--	---@param b string helpful description
+--	---@return table c helpful description
+--	function public.do_stuff(a, b)
+
+return public

src/src/main.lua

@@ -1,3 +1,4 @@
+---@meta _
 -- grabbing our dependencies,
 -- these funky (---@) comments are just there
 --	 to help VS Code find the definitions of things
@@ -30,8 +31,8 @@ chalk = mods["SGG_Modding-Chalk"]
 reload = mods['SGG_Modding-ReLoad']
 
 ---@module 'config'
-config = chalk.auto_lua_toml() 
--- ^ this updates our config.toml in the config folder!
+config = chalk.auto 'config.lua'
+-- ^ this updates our `.cfg` file in the config folder!
 public.config = config -- so other mods can access our config
 
 local function on_ready()

src/src/ready.lua

@@ -1,3 +1,4 @@
+---@meta _
 -- globals we define are private to our plugin!
 ---@diagnostic disable: lowercase-global
 

src/src/reload.lua

@@ -1,3 +1,4 @@
+---@meta _
 -- globals we define are private to our plugin!
 ---@diagnostic disable: lowercase-global
 

src/thunderstore.toml

@@ -11,8 +11,9 @@ websiteUrl = "https://github.com/AuthorName/ModName"
 containsNsfwContent = false
 
 [package.dependencies]
+Hell2Modding-Hell2Modding = "1.0.26"
 SGG_Modding-ENVY = "1.0.0"
-SGG_Modding-Chalk = "1.0.0"
+SGG_Modding-Chalk = "2.0.2"
 SGG_Modding-ReLoad = "1.0.1"
 SGG_Modding-SJSON = "1.0.0"
 SGG_Modding-ModUtil = "3.1.0"
@@ -33,7 +34,7 @@ target = "./LICENSE"
 
 [[build.copy]]
 source = "./src"
-target = "./"
+target = "./plugins"
 
 
 [publish]