Merge pull request #14 from XanatosX/develop

Release 0.2.0

Author: XanatosX

README.md

@@ -6,12 +6,55 @@ To learn how to add and remove custom commands please checkout the example [scri
 
 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.
 
+![Welcome Image](https://i.imgur.com/Z7XDN6T.jpeg)
+![List commands](https://i.imgur.com/XN2kKRB.jpeg)
+
 ## 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]
 
+## Quickstart
+
+### Register a command
+
+```gdscript
+Console.register_custom_command("reload", _reload, [], "Reload current scene")
+
+func _reload() -> String:
+	get_tree().reload_current_scene()
+	return "reloaded scene"
+```
+
+### Unregister a command
+
+```gdscript
+Console.remove_command("reload")
+```
+
+### Other important Options
+
+```gdscript
+## Set toggle key
+Console.set_console_key(KEY_F12) 
+
+## Hide console
+Console.hide_console()
+
+## Show console
+Console.show_console()
+
+## Pause game tree if console does open up
+Console.should_pause_on_open()
+
+## Disable console completely, can be used to remove it on release builds
+Console.disable() 
+
+## Enable a disabled console
+Console.enable() 
+```
+
 ## 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.

addons/gameconsole/builtin/command_close.gd

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

addons/gameconsole/builtin/command_help.gd

@@ -0,0 +1,22 @@
+extends CommandTemplate
+
+func create_command() -> Command:
+    var command = Command.new("help", _get_help, [], "Get help for this console")
+    return command
+
+func _get_help() -> String:
+    var config = Console.get_plugin_config()
+    var section = config.get_sections()[0]
+    var addon_name = config.get_value(section, "name")
+    var author_name = config.get_value(section, "author")
+    var version = config.get_value(section, "version")
+    var return_data = "[center][b]%s[/b] by %s[/center]\n" % [addon_name, author_name] \
+                    + "[center]%s[/center]\n" % version \
+                    + _get_description() \
+                    + "[center][url={\"type\": \"execute\", \"command\": \"list_commands\"}]List commands[/url][/center]"
+    return return_data
+
+func _get_description() -> String:
+    return "[center]This addon does allow you to run built in or custom commands for your game.\n" \
+    + " If you need help run the [url={\"type\": \"enter\", \"command\": \"man\"}]man[/url] command followed by the command you need help with.\n" \
+    + " Also if text is underlined you might be able to click it, test the \"[u]List Commands[/u]\" below [/center]\n\n"

addons/gameconsole/builtin/command_list_commands.gd

@@ -8,10 +8,10 @@ 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"
+    var return_data = "[color=yellow][b]All commands[/b][/color]\n"
+    return_data += "[u]Built In[/u]\n"
     return_data += _generate_command_list(built_in)
-    return_data += "\n== Custom ==\n"
+    return_data += "\n[u]Custom[/u]\n"
     return_data += _generate_command_list(custom)
     return  return_data
 

addons/gameconsole/builtin/command_man.gd

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

addons/gameconsole/builtin/command_pause.gd

@@ -1,7 +1,7 @@
 extends CommandTemplate
 
 func create_command() -> Command:
-    var command = Command.new("pause", _pause, [], "_pause the game")
+    var command = Command.new("pause", _pause, [], "pause the game")
     return command
 
 func _pause() -> String:

addons/gameconsole/console/command/command.gd

@@ -34,7 +34,8 @@ func execute(arguments: Array) -> String:
 	return data
 
 func get_self_listed():
-	var return_data = "- %s %s" % [get_command_name(), get_arguments()]
+	var url_part = "[url={\"type\": \"man\", \"command\": \"%s\"}]" % command
+	var return_data = "- %s%s %s[/url]" % [url_part, get_command_name(), get_arguments()]
 	if short_description != "":
 		return_data += " => %s" % short_description
 
@@ -54,18 +55,20 @@ func as_stripped() -> StrippedCommand:
 	return return_data
 
 func get_man_page() -> String:
-	var return_text = "== %s ==\n" % command
+	var command_url = "[url={\"type\": \"enter\", \"command\": \"%s\"}]" % command
+	var return_text = "%s[b]%s[/b][/url]\n\n" % [command_url, command]
 	var description_to_show = description
 	if description_to_show == "":
 		description_to_show = short_description
 	return_text += "%s\n" % description_to_show
 	if arguments.size() > 0:
-		return_text += "= Arguments =\n"
+		return_text += "\n[i][b]Arguments[/b][/i]\n"
 		for argument in arguments:
 			return_text += "- %s\n" % argument
 	if examples.size() > 0:
-		return_text += "= Examples =\n"
+		return_text += "\n[i][b]Examples[/b][/i]\n"
 		for example in examples:
-			return_text += "- %s\n" % example
+			var example_url = "[url={\"type\": \"enter\", \"command\": \"%s\"}]" % example
+			return_text += "- %s%s[/url]\n" % [example_url, example]
 
 	return return_text

addons/gameconsole/console/console.gd

@@ -5,8 +5,11 @@ signal console_open()
 
 signal console_output(text: String)
 signal is_current_command_valid(confirmed: bool)
+signal copy_command_to_input(command: String)
 
 @onready var console_template: PackedScene = preload("res://addons/gameconsole/console/console/default_console_template.tscn")
+var config_file = "res://addons/gameconsole/plugin.cfg"
+var _plugin_config: ConfigFile = null
 
 var _console_commands := {}
 var _used_template: PackedScene
@@ -20,12 +23,19 @@ var _last_state: bool = false
 
 var _stored_console_content: String = ""
 var _console_key: int = KEY_QUOTELEFT
+var _first_time_open: bool = true
 
 func _ready():
 	_preregister_commands()
 	add_child(_overlay_node)
 	_used_template = console_template
 	process_mode = PROCESS_MODE_ALWAYS
+	_plugin_config = ConfigFile.new()
+	if _plugin_config.load(config_file) != OK:
+		printerr("addon config not loaded correctly")
+
+func get_plugin_config() -> ConfigFile:
+	return _plugin_config
 
 func should_pause_on_open(pause: bool):
 	_should_pause = pause
@@ -60,6 +70,8 @@ func show_console():
 	template.store_content.connect(_store_console_content)
 	template.clear_output.connect(_clear_stored_console_content)
 	template.confirm_command.connect(_check_command)
+	template.url_meta_requested.connect(url_requested)
+	copy_command_to_input.connect(template.force_set_input)
 	is_current_command_valid.connect(template.command_valid)
 	console_output.connect(template.add_console_output)
 	_overlay_node.add_child(template)
@@ -68,6 +80,9 @@ func show_console():
 	if _should_pause:
 		search_and_execute_command("pause")
 	_console_shown = true
+	if _first_time_open:
+		search_and_execute_command("help")
+		_first_time_open = false
 	console_open.emit()
 
 func hide_console():
@@ -87,6 +102,7 @@ func _store_console_content(text: String):
 
 func _clear_stored_console_content():
 	_stored_console_content = ""
+	search_and_execute_command("help")
 
 func _check_command(text: String):
 	var executer = CommandDefinition.new(text)
@@ -215,3 +231,12 @@ func get_specific_command(command_name: String) -> Command:
 	if !_console_commands.has(command_name):
 		return null	
 	return _console_commands[command_name]
+
+func url_requested(data: Dictionary):
+	match  data.type:
+		"man":
+			search_and_execute_command("man %s" % data.command)
+		"enter":
+			copy_command_to_input.emit(data.command)		
+		"execute":
+			search_and_execute_command(data.command)

addons/gameconsole/console/console/console_template.gd

@@ -5,6 +5,8 @@ signal output_append(text: String)
 signal store_content(text: String)
 signal confirm_command(text: String)
 signal is_command_valid(confirmed: bool)
+signal url_meta_requested(data: Dictionary)
+signal set_input(command: String)
 signal clear_output()
 signal clear_input()
 
@@ -64,4 +66,16 @@ func check_if_is_valid_command(text: String):
 	confirm_command.emit(text)
 
 func command_valid(confirmed: bool):
-	is_command_valid.emit(confirmed)
+	is_command_valid.emit(confirmed)
+
+func force_set_input(command: String):
+	set_input.emit(command)
+	
+func url_requested(data):
+	var json_parser = JSON.new()
+	var parsed_json = json_parser.parse(data)
+	if parsed_json != OK:
+		Console.print_as_error("url data was not correctly parsed")
+		return
+	var dictionary = json_parser.get_data()
+	url_meta_requested.emit(dictionary)

addons/gameconsole/console/console/default_console_template.tscn

@@ -82,8 +82,10 @@ script = ExtResource("4_jxlgx")
 [connection signal="clear_output" from="." to="PanelContainer/MarginContainer/VBoxContainer/ConsoleOutput" method="clear_stored_text"]
 [connection signal="is_command_valid" from="." to="PanelContainer/MarginContainer/VBoxContainer/VBoxContainer/HBoxContainer/ConsoleInput" method="is_command_valid"]
 [connection signal="output_append" from="." to="PanelContainer/MarginContainer/VBoxContainer/ConsoleOutput" method="append_bbcode_text"]
-[connection signal="text_changed" from="PanelContainer/MarginContainer/VBoxContainer/VBoxContainer/HBoxContainer/ConsoleInput" to="." method="check_if_is_valid_command"]
+[connection signal="set_input" from="." to="PanelContainer/MarginContainer/VBoxContainer/VBoxContainer/HBoxContainer/ConsoleInput" method="autocomplete_accepted"]
+[connection signal="meta_clicked" from="PanelContainer/MarginContainer/VBoxContainer/ConsoleOutput" to="." method="url_requested"]
 [connection signal="text_changed" from="PanelContainer/MarginContainer/VBoxContainer/VBoxContainer/HBoxContainer/ConsoleInput" to="." method="autocomplete_requested"]
+[connection signal="text_changed" from="PanelContainer/MarginContainer/VBoxContainer/VBoxContainer/HBoxContainer/ConsoleInput" to="." method="check_if_is_valid_command"]
 [connection signal="text_changed" from="PanelContainer/MarginContainer/VBoxContainer/VBoxContainer/HBoxContainer/ConsoleInput" to="PanelContainer/MarginContainer/VBoxContainer/VBoxContainer/ConsoleAutocomplete" method="text_updated"]
 [connection signal="text_submitted" from="PanelContainer/MarginContainer/VBoxContainer/VBoxContainer/HBoxContainer/ConsoleInput" to="." method="request_command"]
 [connection signal="autocomplete_accepted" from="PanelContainer/MarginContainer/VBoxContainer/VBoxContainer/ConsoleAutocomplete" to="PanelContainer/MarginContainer/VBoxContainer/VBoxContainer/HBoxContainer/ConsoleInput" method="autocomplete_accepted"]