Skip to content

Commit 08eef24

Browse files
authored
Update README.md
1 parent dbf0e06 commit 08eef24

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

.github/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# In-game Developer Console for Unity
22
This asset provides an <b>in-game developer console</b> (debug console) for Unity projects, allowing developers or users to execute commands or view incoming Unity messages (i.e. Debug.Log, errors, etc.)
33

4-
The dev console window has a user-friendly look, inspired by Valve's Source engine console and Discord's user-interface. It includes text suggestion & autocomplete that enables quick access to commands.
4+
The dev console window has a user-friendly look, inspired by Valve's Source engine console and Discord's user-interface. It includes text suggestion, autocomplete & key bindings that enable quick access to commands.
55

66
<img src="/.github/preview2.gif" alt="Developer console preview" width="72%"></img>
77

@@ -86,10 +86,13 @@ The asset provides various built-in commands.
8686
- ``print (String)message``: display a message in the dev console log.
8787
- ``exit``: exit the game.
8888
- ``fullscreen (Boolean)enabled``: query or set whether the window is fullscreen.
89+
- ``bind (InputKey)key (String)command``: bind the specified key to execute a command, even if the dev console window is closed.
8990
- ``scene_load (Int32)buildIndex``: load a scene.
9091
- ``scene_info (Int32)sceneIndex``: display information about an active scene.
9192
- ``obj_list``: display a hierarchical list of all game objects in the scene.
9293
- ``obj_info (String)name``: display information about a game object.
94+
- ``sys_info``: display information about the system.
95+
- ``enum (String)enumName``: display all values of the specified enum.
9396

9497
And more...
9598

@@ -107,10 +110,11 @@ DevConsole.AddParameterType<GameObject>((string input) => GameObject.Find(input)
107110
```
108111

109112
<b>Q. Can I remove a built-in command?</b></br>
110-
A. Yes, use ``DevConsole.RemoveCommand()`` to remove almost any command. There are six permanent commands that cannot be removed (``devconsole``, ``commmands``, ``help``, ``print``, ``clear`` & ``reset``).
113+
A. Yes, use ``DevConsole.RemoveCommand()`` to remove almost any command. There are a few permanent commands that cannot be removed that are deemed essential for the developer console to run correctly.
111114

112115
<b>Q. How can I stop keyboard input in the dev console from triggering game-specific actions (e.g. space will make the character jump even though the input field is focused)?</b></br>
113-
A. As far as I know, this is an unavoidable issue. I recommend making a global property for your game (e.g. ``AllowGameInput``) which you can query before performing any game-specific input. This property can then reference ``DevConsole.IsOpenAndFocused``, effectively disabling game-specific input when the dev console is open and the input field is focused.
116+
A. As far as I know, this is an unavoidable issue. I recommend making a global property for your game (e.g. ``AllowGameInput``) which you can query before performing any game-specific input. This property can then reference ``DevConsole.IsOpenAndFocused``, effectively disabling game-specific input when the dev console is open and the input field is focused.
117+
</br>You can also set ``DevConsole.IsKeyBindingsEnabled`` to toggle key bindings - for example, if the user is in a text field.
114118
```cs
115119
public static bool AllowGameInput => DevConsole.IsOpenAndFocused;
116120

0 commit comments

Comments
 (0)