Skip to content

Commit f8cfa6f

Browse files
committed
2 parents 3c383f6 + faa0534 commit f8cfa6f

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

.github/README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# 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.)
33

44
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

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) 🍝
7+
68
<img src="/.github/preview2.gif" alt="Developer console preview" width="72%"></img>
79

810
## Setup
@@ -11,7 +13,7 @@ Simply import the package into your project and you're good to go. No additional
1113
- Git URL: ``https://github.com/DavidF-Dev/Unity-DeveloperConsole.git``</br>
1214
<img src="/.github/install1.png" alt="Package manager install" width="25%"></src>
1315
- <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).
1517
- Download directly from the [releases](https://github.com/DavidF-Dev/Unity-DeveloperConsole/releases) tab & import in Unity (<i>Assets>Import Package</i>).
1618

1719
## Usage
@@ -52,8 +54,8 @@ Custom commands can be added to the dev console by developers. They can be creat
5254
#### Parameters
5355
Default supported parameter types implement the [``IConvertible``](https://docs.microsoft.com/en-us/dotnet/api/system.iconvertible) interface (e.g. int, float, string, bool, etc.)</br>
5456
Enums are also supported.</br>
55-
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>
5759
To add a custom type, use ``DevConsole.AddParameterType<T>()`` (see FAQ below).
5860

5961
#### Example using Command.Create
@@ -117,9 +119,8 @@ A. Yes, use ``DevConsole.RemoveCommand()`` to remove almost any command. There a
117119

118120
<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>
119121
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.
121122
```cs
122-
public static bool AllowGameInput => DevConsole.IsOpenAndFocused;
123+
public static bool AllowGameInput => !DevConsole.IsOpenAndFocused;
123124

124125
private void CheckGameInput()
125126
{
@@ -143,4 +144,5 @@ Otherwise, feel free to send me a message if there's a feature you'd like to see
143144
- [FiraCode](https://github.com/tonsky/FiraCode) font used under the SIL Open Font License 1.1.
144145

145146
## 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) 🍝

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"name": "com.davidfdev.devconsole",
3-
"version": "0.1.8",
3+
"version": "0.1.8-alpha",
44
"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)",
66
"unity": "2020.1",
77
"hideInEditor": false,
88
"documentationUrl": "https://github.com/DavidF-Dev/Unity-DeveloperConsole",

0 commit comments

Comments
 (0)