You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/README.md
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,10 @@
1
1
# In-game Developer Console for Unity
2
-
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.)
2
+
This asset provides an <b>in-game developer console</b> (debug console) for Unity projects, allowing developers or players to execute commands or view incoming Unity messages (i.e. Debug.Log, errors, etc.)
3
3
4
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.
5
5
6
+
The asset is completely free, but if you'd like to show support you can [buy me a bowl of spaghetti](https://www.buymeacoffee.com/davidfdev) 🍝
- <i>Or</i> add the following line to <i>Packages/manifest.json</i>:</br>``"com.davidfdev.devconsole": "https://github.com/DavidF-Dev/Unity-DeveloperConsole.git"``
14
-
- Import via the Unity asset store [here]().
16
+
- Import via the Unity asset store [here](https://u3d.as/2EE5).
15
17
- Download directly from the [releases](https://github.com/DavidF-Dev/Unity-DeveloperConsole/releases) tab & import in Unity (<i>Assets>Import Package</i>).
16
18
17
19
## Usage
@@ -52,8 +54,8 @@ Custom commands can be added to the dev console by developers. They can be creat
Commands that use a nullable bool (Boolean?) parameter accept "~", "!", "null", and "toggle" - used primarily as a toggle.</br>
56
-
E.g. executing "<b>showfps !</b>" will toggle showing the fps on-screen.</br></br>
57
+
Commands that use a nullable bool (``Boolean?``) parameter accept "~", "!", "null", and "toggle" - used primarily as a toggle.</br>
58
+
For example, executing "<b>showfps !</b>" will toggle showing the fps on-screen.</br></br>
57
59
To add a custom type, use ``DevConsole.AddParameterType<T>()`` (see FAQ below).
58
60
59
61
#### Example using Command.Create
@@ -117,9 +119,8 @@ A. Yes, use ``DevConsole.RemoveCommand()`` to remove almost any command. There a
117
119
118
120
<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>
119
121
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.
120
-
</br>You can also set ``DevConsole.IsKeyBindingsEnabled`` to toggle key bindings - for example, if the user is in a text field.
@@ -143,4 +144,5 @@ Otherwise, feel free to send me a message if there's a feature you'd like to see
143
144
-[FiraCode](https://github.com/tonsky/FiraCode) font used under the SIL Open Font License 1.1.
144
145
145
146
## Contact
146
-
If you have any questions or would like to get in contact, shoot me an email at contact@davidfdev.com. Alternatively, you can send me a direct message on Twitter at [@DavidF_Dev](https://twitter.com/DavidF_Dev).
147
+
If you have any questions or would like to get in contact, shoot me an email at contact@davidfdev.com. Alternatively, you can send me a direct message on Twitter at [@DavidF_Dev](https://twitter.com/DavidF_Dev).</br></br>
148
+
Consider showing support by [buying me a bowl of spaghetti](https://www.buymeacoffee.com/davidfdev) 🍝
Copy file name to clipboardExpand all lines: package.json
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
{
2
2
"name": "com.davidfdev.devconsole",
3
-
"version": "0.1.8",
3
+
"version": "0.1.8-alpha",
4
4
"displayName": "In-game Developer Console by DavidFDev",
5
-
"description": "A user-friendly in-game developer console that allows developers or users to execute commands or view incoming Unity messages. (MIT License)",
5
+
"description": "A user-friendly in-game developer console that allows developers or players to execute commands or view incoming Unity messages. (MIT License)",
0 commit comments