Skip to content

Commit

Permalink
docs: prepare for release
Browse files Browse the repository at this point in the history
  • Loading branch information
WilsontheWolf committed Jan 10, 2025
1 parent 73b54fb commit eedb47e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
14 changes: 7 additions & 7 deletions docs/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -143,24 +143,24 @@ Running `watch config_tab <path>` 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 <path>` 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 <path>` 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]
Expand Down

0 comments on commit eedb47e

Please sign in to comment.