From eedb47ef2a459e5eae81712f642b83a2f1df7dbc Mon Sep 17 00:00:00 2001 From: WilsontheWolf <33164598+WilsontheWolf@users.noreply.github.com> Date: Thu, 9 Jan 2025 19:30:43 -0700 Subject: [PATCH] docs: prepare for release --- docs/changelog.md | 2 +- docs/dev.md | 14 +++++++------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index 78b12e5..e883bad 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -11,7 +11,7 @@ - New option to process strings before printing to the lovely console. - This allows the expanding tables to also be printed and also works around some weird lovely bugs. - Experimental option to make the console accessible from the crash screen. - - Must be toggled in the config for now. If there is an issue it will cause the game to close without a crash screen. + - Toggleable in the config. Doesn't work in vanilla. - Key repeat is now on in the console (allows you to hold keys like backspace). - Split config into multiple tabs diff --git a/docs/dev.md b/docs/dev.md index 9109f17..ef0dbf4 100644 --- a/docs/dev.md +++ b/docs/dev.md @@ -38,7 +38,7 @@ local debugplus = dpAPI.registerID("MyMod") DebugPlus provides a logger to allow users to log at different log levels, with their mod name appended to logs. > [!NOTE] -> If you are writing a [Steamodded](https://github.com/Steamopollys/Steamodded) mod, you can use [Steamodded's logging tools](https://github.com/Steamopollys/Steamodded/wiki/Logging) to also get these benefits, without relying on DebugPlus. +> If you are writing a [Steamodded](https://github.com/Steamodded/smods) mod, you can use [Steamodded's logging tools](https://github.com/Steamodded/smods/wiki/Logging) to also get these benefits, without relying on DebugPlus. > > Additionally, if you don't want any fancy features, just logging with `print` works fine. @@ -143,24 +143,24 @@ Running `watch config_tab ` will watch the provided file for changes and e See [examples/watch_config_tab.lua](../examples/watch_config_tab.lua). -#### joker +#### center > [!NOTE] -> This watch depends on [Steamodded](https://github.com/Steamopollys/Steamodded) (v1.0.0+) to function. +> This watch depends on [Steamodded](https://github.com/Steamodded/smods) (v1.0.0+) to function. > [!WARNING] -> This watch command has side effects. Changes to jokers will stay until you restart the game. +> This watch command has side effects. Changes to objects will stay until you restart the game. -Running `watch joker ` will watch the provided file for changes and eval the code. The big difference between this and [lua](#lua) is that this will take the returned value, and use it in a similar way to the object passed to [`SMODS.Joker`](https://github.com/Steamopollys/Steamodded/wiki/05.-SMODS.Center#smodsjoker). The biggest difference between SMODS.Joker is that the key needs to be the full key with the `j_` prefix and your mod prefix. +Running `watch center ` will watch the provided file for changes and eval the code. The big difference between this and [lua](#lua) is that this will take the returned value, and use it in a similar way to the object passed to the different [`SMODS.Center`](https://github.com/Steamodded/smods/wiki/SMODS.Center)'s. The biggest difference between the SMODS.Center's is that the key needs to be the full key with the `j_` prefix and your mod prefix. DebugPlus will update the functions and loc_txt for your joker on the fly (and adds error protecton to the function). This allows you to rapidly iterate on a joker. -See [examples/watch_joker.lua](../examples/watch_joker.lua). +See [examples/watch_joker.lua](../examples/watch_joker.lua) and [examples/watch_consumeable.lua](../examples/watch_consumeable.lua). #### shader > [!NOTE] -> This watch depends on [Steamodded](https://github.com/Steamopollys/Steamodded) (v1.0.0+) to function. +> This watch depends on [Steamodded](https://github.com/Steamodded/smods) (v1.0.0+) to function. > [!WARNING]