Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
elringus committed May 31, 2024
1 parent c8d16d9 commit 2925573
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions docs/guide/development-console.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# Development Console

Development console is used to execute static C# methods via in-game UI.
Development console is used to execute static C# methods via in-game UI. To enable or disable the feature, use `Enable Development Console` property in the engine configuration. To keep the feature only under development (debug) builds, enable `Debug Only Console` in the same configuration menu.

To show the console UI while the game is running, make sure development console is enabled in the engine configuration and press `~` (tilde) key. In case you have issues using the default key (eg, when under Unity editor on Mac OS), you can change it via `Toggle Console Key` property.

![Engine Configuration](https://i.gyazo.com/bc56a837c03d198e2d8141bdebc2e696.png)
To show the console UI while the game is running, make sure development console is enabled and press `~` (tilde) key. The key can be changed via input configuration under `ToggleConsole` binding.

To expose a C# method to the console, add a `ConsoleCommand` attribute to a static method. The attribute has an optional string argument, allowing to set a shortcut:

Expand Down

0 comments on commit 2925573

Please sign in to comment.