Merge pull request #21 from XanatosX/develop

Prototype 0.3.1

Author: XanatosX

addons/gameconsole/builtin/command_help.gd

@@ -4,29 +4,31 @@ var list_command_executer: Interaction
 var enter_man_command: Interaction
 
 func _init():
-    list_command_executer = Interaction.new()
-    list_command_executer.from_raw("execute", "list_commands")
-    
-    enter_man_command = Interaction.new()
-    enter_man_command.from_raw("enter", "man")
+	list_command_executer = Interaction.new()
+	list_command_executer.from_raw("execute", "list_commands")
+	
+	enter_man_command = Interaction.new()
+	enter_man_command.from_raw("enter", "man")
 
 func create_command() -> Command:
-    var command = Command.new("help", _get_help, [], "Get help for this console")
-    return 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=%s]List commands[/url][/center]" % list_command_executer.get_as_string()
-    return return_data
+	var information = Console.get_console_information()
+
+	var addon_name = information.get_or_add("name", "UNKNOWN KEY: name")
+	var author_list = information.get_or_add("authors", "UNKNOWN KEY: author")
+	var version = information.get_or_add("version", "UNKNOWN KEY: version")
+
+	var return_data = "[center][b][font_size=20]%s[/font_size][/b][/center]" % addon_name \
+					+  "[center][font_size=10]by %s[/font_size][/center]\n" % author_list \
+					+ "[center][font_size=10]Version: %s[/font_size][/center]\n" % version \
+					+ _get_description() \
+					+ "[center][url=%s]List commands[/url][/center]" % list_command_executer.get_as_string()
+	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=%s]man[/url] command followed by the command you need help with.\n" % enter_man_command.get_as_string() \
-    + " Also if text is underlined you might be able to click it, test the \"[u]List Commands[/u]\" below [/center]\n\n"
+	return "\n[p][center]This addon does allow you to run built in or custom commands for your game.\n" \
+	+ " If you need help run the [url=%s]man[/url] command followed by the command you need help with.\n" % enter_man_command.get_as_string() \
+	+ " Also if text is underlined you might be able to click it, test the \"[u]List Commands[/u]\" below [/center][/p]\n\n"

addons/gameconsole/builtin/command_list_commands.gd

@@ -9,20 +9,20 @@ func _list_commands() -> String:
     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][b]All commands[/b][/color]\n"
-    return_data += "[u]Built In[/u]\n"
+    return_data += "\n[p][b]Built In[/b][/p]\n"
     return_data += _generate_command_list(built_in)
-    return_data += "\n[u]Custom[/u]\n"
+    return_data += "\n[p][b]Custom[/b][/p]\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 = "";
+    var cell_data = "";
     for command in commands:
         if command is Command:
-            return_data += command.get_self_listed()
+            cell_data += "[cell][left]%s[/left][/cell][cell][right]   %s[/right][/cell]" % [command.get_interactive_command(), command.get_command_short_description()]
 
-    return return_data
+    return "\n[p][table=2][cell][i]Command[/i][/cell][cell][right][i]Description[/i][/right][/cell]%s[/table][/p]\n" % cell_data
 
 func _sort_commands(a: Command, b: Command) -> bool:
     return a.command < b.command

addons/gameconsole/builtin/command_quit_game.gd

@@ -3,7 +3,7 @@ extends CommandTemplate
 func create_command() -> Command:
     if OS.has_feature("web"):
         return null
-    var command = Command.new("quit", _quit_game, [], "quit the game")
+    var command = Command.new("quit", _quit_game, [], "quit the game, this only works on non web builds")
     command.built_in
     return command
 

addons/gameconsole/console/command/command.gd

@@ -47,14 +47,12 @@ func execute(arguments: Array) -> String:
 		data = ""
 	return data
 
-func get_self_listed():
+func get_interactive_command():
 	var url_part = "[url=%s]" % self_man_link.get_as_string()
-	var return_data = "- %s%s %s[/url]" % [url_part, get_command_name(), get_arguments()]
-	if short_description != "":
-		return_data += " => %s" % short_description
-	
-	return_data += "\n"
-	return return_data
+	return "%s%s %s[/url]" % [url_part, get_command_name(), get_arguments()]
+
+func get_command_short_description():
+	return short_description
 
 func get_arguments() -> String:
 	var return_arguments = ""
@@ -76,14 +74,19 @@ func get_man_page() -> String:
 		description_to_show = short_description
 	return_text += "%s\n" % description_to_show
 	if arguments.size() > 0:
-		return_text += "\n[i][b]Arguments[/b][/i]\n"
+		return_text += "\n[i][b]Arguments[/b][/i]\n\n"
+		return_text += "[ul]"
 		for argument in arguments:
-			return_text += "- %s\n" % argument
+			return_text += "%s\n" % argument
+		return_text += "[/ul]"
 	if examples.size() > 0:
-		return_text += "\n[i][b]Examples[/b][/i]\n"
+		return_text += "\n\n[i][b]Examples[/b][/i]\n\n"
+		return_text += "[ul]"
 		for example in examples:
 			var link = self_example_links[example] as Interaction
+			
 			var example_url = "[url=%s]" % link.get_as_string()
-			return_text += "- %s%s[/url]\n" % [example_url, example]
+			return_text += "%s%s[/url]\n" % [example_url, example]
+		return_text += "[/ul]"
 
 	return return_text

addons/gameconsole/console/console.gd

@@ -10,8 +10,6 @@ signal copy_command_to_input(command: String)
 signal unknown_interaction_request(interaction: Interaction)
 
 @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
@@ -26,18 +24,20 @@ var _last_state: bool = false
 var _stored_console_content: String = ""
 var _console_key: int = KEY_QUOTELEFT
 var _first_time_open: bool = true
+var _console_information := {
+	"name": "Game Console",
+	"authors": "Xanatos",
+	"version": "0.3.1"
+}
 
 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 get_console_information() -> Dictionary:
+	return _console_information
 
 func should_pause_on_open(pause: bool):
 	_should_pause = pause
@@ -173,7 +173,7 @@ func _register_commands_in_directory(directory: String):
 	var loaded_scripts: Array[Resource]
 	var files = dir.get_files()
 	for file in files:
-		if !file.ends_with(".gd"):
+		if !file.ends_with(".gd") and !file.ends_with(".gdc"):
 			continue
 		var path = directory + file
 		var script = load(path)
@@ -236,8 +236,6 @@ func get_specific_command(command_name: String) -> Command:
 
 func url_requested(interaction: Interaction):
 	match  interaction.get_type():
-		"UNKNOWN":
-			search_and_execute_command("man list_commands")
 		"man":
 			search_and_execute_command("man %s" % interaction.get_data())
 		"enter":

addons/gameconsole/console/console/command_enter.gd

@@ -58,6 +58,7 @@ func _update_selection_text():
 	text = _current_history[selection]
 
 	text_changed.emit(text)
+	caret_column = text.length()
 	get_tree().get_root().set_input_as_handled()
 
 func autocomplete_accepted(autocomplete_text: String):

addons/gameconsole/console/console/default_console_template.tscn

@@ -14,10 +14,10 @@ script = ExtResource("2_5ui7n")
 process_mode = 3
 layer = 20
 script = ExtResource("1_wfkix")
+autocomplete_service = SubResource("Resource_vkyqv")
 console_content_output = NodePath("PanelContainer/MarginContainer/VBoxContainer/ConsoleOutput")
 console_input = NodePath("PanelContainer/MarginContainer/VBoxContainer/VBoxContainer/HBoxContainer/ConsoleInput")
 console_send_button = NodePath("PanelContainer/MarginContainer/VBoxContainer/VBoxContainer/HBoxContainer/ConsoleSendButton")
-autocomplete_service = SubResource("Resource_vkyqv")
 
 [node name="PanelContainer" type="PanelContainer" parent="."]
 anchors_preset = 10

addons/gameconsole/plugin.cfg

@@ -3,5 +3,5 @@
 name="Game Console"
 description="Addon to add a console to the game, allowing you to register and run commands."
 author="Xanatos"
-version="0.3.0"
+version="0.3.1"
 script="gameconsole.gd"

example/custom_console_template.tscn

@@ -15,10 +15,10 @@ bg_color = Color(0.136826, 0.136826, 0.136826, 1)
 
 [node name="CustomConsoleTemplate" type="CanvasLayer" node_paths=PackedStringArray("console_content_output", "console_input", "console_send_button")]
 script = ExtResource("1_rkm11")
+autocomplete_service = SubResource("Resource_lhmvy")
 console_content_output = NodePath("PanelContainer/MarginContainer/VBoxContainer/ConsoleOutput")
 console_input = NodePath("PanelContainer/MarginContainer/VBoxContainer/HBoxContainer/VBoxContainer/ConsoleInput")
 console_send_button = NodePath("PanelContainer/MarginContainer/VBoxContainer/HBoxContainer/ConsoleSendButton")
-autocomplete_service = SubResource("Resource_lhmvy")
 
 [node name="PanelContainer" type="PanelContainer" parent="."]
 anchors_preset = 9