https://github.com/vektor451/vek-dev-console
Simple C# based developer console for Godot 4.3+.
https://github.com/vektor451/vek-dev-console
console developer-console developer-tool godot godot-addon godot-engine godot-mono godot-plugin godot4 godot4-3
Last synced: about 1 year ago
JSON representation
Simple C# based developer console for Godot 4.3+.
- Host: GitHub
- URL: https://github.com/vektor451/vek-dev-console
- Owner: vektor451
- License: mit
- Created: 2024-10-13T00:24:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-18T17:00:17.000Z (about 1 year ago)
- Last Synced: 2025-03-23T21:04:40.449Z (about 1 year ago)
- Topics: console, developer-console, developer-tool, godot, godot-addon, godot-engine, godot-mono, godot-plugin, godot4, godot4-3
- Language: C#
- Homepage:
- Size: 301 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vekkie's C# Developer Console
Simple C# based developer console for Godot 4.3+.
## Setup
1. `git clone` this repo into the `/addons` folder of your Godot project. You should have a `/addons/vekDevConsole` folder with all of the plugin's files.
2. Build the C# solution. If you are placing the addon in a new project, you might have to make a random empty C# script first to be able to build it.
3. Enable the `Dev Console` in the plugins tab of your project settings.
4. Add a `dev_console` action into your project's input map, which can also be found in the project settings (this is necessary for opening the console).
5. Add the `DevConsole` node to a desired scene in your project. It is strongly recommended to then set the anchor preset to `Full Rect`.
6. Console time B).
## Usage
To add a command to the console, use the DevConsole's `AddCommand(name, command)` method. This is static, and will be accessed anywhere in your project as `DevConsole.AddCommand` The name property is a generic string, however the command is a class consisting of 3 notable properties:
- Action: The main method to execute with the console command. Supports arguments of type int, float, string or bool, and is required.
- ReadAction: An alternate method executed if the command was submitted with no arguments. Usually used to retrieve the value of a property, but can be used for other means (for instance with the help command, printing all commands and their descriptions). Doesn't support arguments, and is optional.
- Description: The command's description used when getting help. Technically optional, but not advised to omit.
You can also remove commands with `RemoveCommand(name)`
This will not work natively in GDScript, and will require you to create a C# script with methods that call the GDScript from there, and then create commands for those methods.
## Todo
- Make a more in-depth readme with more of the actual usage details of the console.
- Be able to show the same content as the editor output window.
- Other small fixes and improvements.