diff --git a/.docs/hotreload.md b/.docs/hotreload.md new file mode 100644 index 00000000..76f5c862 --- /dev/null +++ b/.docs/hotreload.md @@ -0,0 +1,22 @@ +# HotReload + +HotReload automatically reloads cogs in local cog paths on file change. +This is useful for development, as it allows you to make changes to your cogs and see the changes reflected in Discord immediately, without having to manually `[p]reload` the cog. + +## Installation + +```bash +[p]repo add seacogs https://www.coastalcommits.com/cswimr/SeaCogs +[p]cog install seacogs hotreload +[p]cog load hotreload +``` + +## Commands + +### hotreload notifychannel + +Set the channel where hotreload will send notifications when a cog is reloaded. + +### hotreload list + +Debugging command that shows the list of currently active observers. May be expanded in the future to show watched file paths. diff --git a/hotreload/info.json b/hotreload/info.json index 87dc8518..5527eb15 100644 --- a/hotreload/info.json +++ b/hotreload/info.json @@ -1,15 +1,23 @@ { - "author" : ["cswimr"], - "install_msg" : "Thank you for installing HotReload! This cog does not provide any commands, please see the [documentation](https://seacogs.coastalcommits.com/hotreload) for more information.", - "name" : "HotReload", - "short" : "Automatically reload cogs in local cog paths on file change.", - "description" : "Automatically reload cogs in local cog paths on file change.", - "end_user_data_statement" : "This cog does not store end user data.", + "author": [ + "cswimr" + ], + "install_msg": "Thank you for installing HotReload! Please see the [documentation](https://seacogs.coastalcommits.com/hotreload) to get started.", + "name": "HotReload", + "short": "Automatically reload cogs in local cog paths on file change.", + "description": "Automatically reload cogs in local cog paths on file change.", + "end_user_data_statement": "This cog does not store end user data.", "hidden": false, "disabled": false, "min_bot_version": "3.5.0", - "min_python_version": [3, 10, 0], - "requirements": ["watchdog"], + "min_python_version": [ + 3, + 10, + 0 + ], + "requirements": [ + "watchdog" + ], "tags": [ "utility", "development"