Merge pull request #3 from XanatosX/develop

Release 0.1.0

Author: XanatosX

.gitattributes

@@ -0,0 +1,2 @@
+# Normalize EOL for all files that Git considers text files.
+* text=auto eol=lf

.gitignore

@@ -0,0 +1,17 @@
+# Godot 4+ specific ignores
+.godot/
+
+# Godot-specific ignores
+.import/
+export.cfg
+export_presets.cfg
+
+# Imported translations (automatically generated from CSV files)
+*.translation
+
+# Mono-specific ignores
+.mono/
+data_*/
+mono_crash.*.json
+
+.vscode/

README.md

@@ -0,0 +1,40 @@
+# Godot Game Console
+
+This Godot addon will add a game console to your game. This console can be used to run commands on your game.
+
+To learn how to add and remove custom commands please checkout the example [script][example-gdscript].
+
+I do know there is a addon like this already in development, check it out at the end of this readme. I still wanted to create my own interpretation of this used in games I created. But as I already developed it I decided to make it public and give something back to the Godot developer community.
+
+## How to install
+
+To install the addon download the source files and put the "addons" folder on a root level to your project. After that enable the plugin via the Godot plugin menu.
+
+Checkout this part of the [Godot documentation][installing-and-enable-plugin]
+
+## Example Project
+
+I added a test and example project to this addon so you can check out the console in action. The example is not much but does show the usage in a really basic manner.
+
+## Built in commands
+
+This is a list with build in commands and there purpose
+
+| Name          | Description                                                                                                           | example       |
+| ------------- | --------------------------------------------------------------------------------------------------------------------- | ------------- |
+| list_commands | This will list all the built in and custom commands currently available                                               | list_commands |
+| clear         | Clear the output of the console window                                                                                | clear         |
+| man           | Get a more detailed description of a command, also including examples if any. Requires the command name as a argument | man clear     |
+| pause         | Pause the game by pausing the root tree                                                                               | pause         |
+| unpause       | unpause the game by unpausing the root                                                                                | unpause       |
+| quit          | Close the game, does not work on a web build.                                                                         | quit          |
+
+
+## Thanks to
+
+As this addon is influenced by the godot console addon check it out as well.
+
+- https://github.com/jitspoe/godot-console
+
+[example-gdscript]: ./example/console_example.gd
+[installing-and-enable-plugin]: https://docs.godotengine.org/en/stable/tutorials/plugins/editor/installing_plugins.html#enabling-a-plugin

addons/gameconsole/builtin/command_argument_count_not_matching.gd

@@ -0,0 +1,13 @@
+extends CommandTemplate
+
+func create_command() -> Command:
+    var command = Command.new("argument not matching", _argument_count_not_matching, ["command_name"], "The provided arguments do not match")
+    command.is_hidden = true
+    return command
+
+func _argument_count_not_matching(command_name: String) -> String:
+    var return_data = "";
+    var command = Console._console_commands[command_name]
+    var command_arguments = command.get_arguments()
+    return_data += "[color=red]The arguments provided do not match the arguments %s of command[/color]" % [command_arguments]
+    return return_data

addons/gameconsole/builtin/command_close.gd

@@ -0,0 +1,10 @@
+extends CommandTemplate
+
+func create_command() -> Command:
+    var command = Command.new("_close", _close, [], "_close the console")
+    return command
+
+func _close() -> String:
+    Console.hide_console()
+    return ""
+

addons/gameconsole/builtin/command_list_commands.gd

@@ -0,0 +1,28 @@
+extends CommandTemplate
+
+func create_command() -> Command:
+    var command = Command.new("list commands", _list_commands, [], "List all commands", "This command will list all the commands currently available in the console")
+    return command
+
+func _list_commands() -> String:
+    var commands = Console.get_all_commands() as Array[Command]
+    var built_in = commands.filter(func(command): return command.built_in) as Array[Command]
+    var custom = commands.filter(func(command): return !command.built_in) as Array[Command]
+    var return_data = "[color=yellow]=== All commands ===[/color]\n"
+    return_data += "== Built In ==\n"
+    return_data += _generate_command_list(built_in)
+    return_data += "\n== Custom ==\n"
+    return_data += _generate_command_list(custom)
+    return  return_data
+
+func _generate_command_list(commands: Array) -> String:
+    commands.sort_custom(_sort_commands)
+    var return_data = "";
+    for command in commands:
+        if command is Command:
+            return_data += command.get_self_listed()
+    
+    return return_data
+
+func _sort_commands(a: Command, b: Command) -> bool:
+    return a.command < b.command

addons/gameconsole/builtin/command_man.gd

@@ -0,0 +1,11 @@
+extends CommandTemplate
+
+func create_command() -> Command:
+    var command = Command.new("man", manual, ["Name of the command"], "Command to get a manual for an command")
+    return command
+
+func manual(command_name: String) -> String:
+    var command = Console.get_specific_command(command_name)
+    if command == null or command.built_in:
+        return "[color=red]No command with name %s was found[/color]" % command_name
+    return command.get_man_page()

addons/gameconsole/builtin/command_no_command.gd

@@ -0,0 +1,9 @@
+extends CommandTemplate
+
+func create_command() -> Command:
+    var command = Command.new("_no_command_provided", _no_command_provided, [], "")
+    command.is_hidden = true
+    return command
+
+func _no_command_provided() -> String:
+    return "[color=red]Please enter a command[/color]"

addons/gameconsole/builtin/command_not_found.gd

@@ -0,0 +1,10 @@
+extends CommandTemplate
+
+func create_command() -> Command:
+    var command = Command.new("not found", _not_found, ["Command name"], "Command was not found")
+    command.is_hidden = true
+    return command
+
+func _not_found(name: String) -> String:
+    return "[color=red]Command %s was not found[/color]" % name
+

addons/gameconsole/builtin/command_pause.gd

@@ -0,0 +1,10 @@
+extends CommandTemplate
+
+func create_command() -> Command:
+    var command = Command.new("_pause", _pause, [], "_pause the game")
+    return command
+
+func _pause() -> String:
+    Console.get_tree().paused = true
+    return "[color=red]paused[/color]"
+