godot-xterm/addons/godot_xterm/plugin.gd

@tool
extends EditorPlugin

var pty_supported := OS.get_name() in ["Linux", "FreeBSD", "NetBSD", "OpenBSD", "BSD", "macOS"]
var asciicast_import_plugin
var xrdb_import_plugin
var terminal_panel: Control


func _enter_tree():
	asciicast_import_plugin = preload("./import_plugins/asciicast_import_plugin.gd").new()
	add_import_plugin(asciicast_import_plugin)

	xrdb_import_plugin = preload("./import_plugins/xrdb_import_plugin.gd").new()
	add_import_plugin(xrdb_import_plugin)

	var asciicast_script = preload("./resources/asciicast.gd")
	add_custom_type("Asciicast", "Animation", asciicast_script, null)

	if pty_supported:
		terminal_panel = preload("./editor_plugins/terminal/terminal_panel.tscn").instantiate()
		terminal_panel.editor_plugin = self
		terminal_panel.editor_interface = get_editor_interface()
		add_control_to_bottom_panel(terminal_panel, "Terminal")


func _exit_tree():
	remove_import_plugin(asciicast_import_plugin)
	asciicast_import_plugin = null

	remove_import_plugin(xrdb_import_plugin)
	xrdb_import_plugin = null

	remove_custom_type("Asciicast")

	if pty_supported:
		remove_control_from_bottom_panel(terminal_panel)
		terminal_panel.free()
Godot 4 automatic changes 2022-11-09 20:57:46 +00:00			`@tool`
Add all the files 2020-05-10 00:07:31 +07:00			`extends EditorPlugin`

Further progress towards Godot 4.0 support - Primary example scenes (menu, terminal, and asciicast) working but still a lot of warning/error messages and some regressions. - Editor integrated terminal works, but still a lot of warning/error messages and some regressions. - Added support for "blink" display attribute. - Removed GDScript terminal code. Terminal node is now purely a GDExtension. So is LibuvUtils. - GUT tests not working yet. - Still a lot of things to fix. - So far, only built for and manually tested on Linux x86_64. 2023-01-08 22:41:48 +13:00			`var pty_supported := OS.get_name() in ["Linux", "FreeBSD", "NetBSD", "OpenBSD", "BSD", "macOS"]`
Add asciicast importer Former-commit-id: ffa85618659024515cdde252c56c7be34a245446 2020-09-22 15:31:46 +07:00			`var asciicast_import_plugin`
Add basic .xrdb/.Xresources import plugin Adds basic support for importing .Xresources and .xrdb files as Theme resources. Examples of terminal color schemes in .xrdb format can be found here: https://github.com/mbadolato/iTerm2-Color-Schemes/tree/master/xrdb Examples of terminal themes in .Xresources format can be found here: https://github.com/mbadolato/iTerm2-Color-Schemes/tree/master/Xresources https://terminal.sexy also supports exporting themes is Xresources format. 2021-07-18 23:11:31 +07:00			`var xrdb_import_plugin`
Add rudimentary terminal to editor's bottom panel In order to use the gdnative library as an editor plugin it was neccessary to set the `reloadable` property of the gdnlib file to false, in order to prevent crashes when the godot editor window lost focus. This may have consequences when recompiling the library. See: https://docs.godotengine.org/en/3.3/classes/class_gdnativelibrary.html#class-gdnativelibrary-property-reloadable Still crashes quite frequently and doesn't close child processes properly. Part of #43. 2021-07-11 22:32:13 +07:00			`var terminal_panel: Control`
Add asciicast importer Former-commit-id: ffa85618659024515cdde252c56c7be34a245446 2020-09-22 15:31:46 +07:00

Add all the files 2020-05-10 00:07:31 +07:00			`func _enter_tree():`
Use relative rather than absolute paths This should allow GodotXterm be installed in locations other than `addons/godot_xterm`. 2021-07-15 21:30:09 +07:00			`asciicast_import_plugin = preload("./import_plugins/asciicast_import_plugin.gd").new()`
Add asciicast importer Former-commit-id: ffa85618659024515cdde252c56c7be34a245446 2020-09-22 15:31:46 +07:00			`add_import_plugin(asciicast_import_plugin)`
Format files using GDScript Toolkit https://github.com/Scony/godot-gdscript-toolkit 2021-05-26 10:39:48 +07:00
Add basic .xrdb/.Xresources import plugin Adds basic support for importing .Xresources and .xrdb files as Theme resources. Examples of terminal color schemes in .xrdb format can be found here: https://github.com/mbadolato/iTerm2-Color-Schemes/tree/master/xrdb Examples of terminal themes in .Xresources format can be found here: https://github.com/mbadolato/iTerm2-Color-Schemes/tree/master/Xresources https://terminal.sexy also supports exporting themes is Xresources format. 2021-07-18 23:11:31 +07:00			`xrdb_import_plugin = preload("./import_plugins/xrdb_import_plugin.gd").new()`
			`add_import_plugin(xrdb_import_plugin)`

Use relative rather than absolute paths This should allow GodotXterm be installed in locations other than `addons/godot_xterm`. 2021-07-15 21:30:09 +07:00			`var asciicast_script = preload("./resources/asciicast.gd")`
Add asciicast importer Former-commit-id: ffa85618659024515cdde252c56c7be34a245446 2020-09-22 15:31:46 +07:00			`add_custom_type("Asciicast", "Animation", asciicast_script, null)`
Format files using GDScript Toolkit https://github.com/Scony/godot-gdscript-toolkit 2021-05-26 10:39:48 +07:00
Add new PTY node (replaces Pseudoterminal node) Uses fork of node-pty native code for forking pseudoterminals. Uses libuv pipe handle to communicate with the child process. - Paves the way for cross-platform (Linux, macOS and Windows) support. - Renames Pseudoterminal to PTY (which is much easier to type and spell :D). - Better performance than the old Pseudoterminal node. Especially when streaming large amounts of data such as running the `yes` command. - Allows setting custom file, args, initial window size, cwd, env vars (including important ones such as TERM and COLORTERM) and uid/gid on Linux and macOS. - Returns process exit code and terminating signal. 2021-07-03 00:27:34 +07:00			`if pty_supported:`
Godot 4 automatic changes 2022-11-09 20:57:46 +00:00			`terminal_panel = preload("./editor_plugins/terminal/terminal_panel.tscn").instantiate()`
Terminal panel updates - Add TerminalSettings resource. - Init/load terminal settings from terminal panel. - Add terminal context menu (i.e. right-click PopupMenu). - Add shortcut to open a new terminal Ctrl+Shift+T and make terminal panel visible. 2021-07-12 23:11:28 +07:00			`terminal_panel.editor_plugin = self`
Add rudimentary terminal to editor's bottom panel In order to use the gdnative library as an editor plugin it was neccessary to set the `reloadable` property of the gdnlib file to false, in order to prevent crashes when the godot editor window lost focus. This may have consequences when recompiling the library. See: https://docs.godotengine.org/en/3.3/classes/class_gdnativelibrary.html#class-gdnativelibrary-property-reloadable Still crashes quite frequently and doesn't close child processes properly. Part of #43. 2021-07-11 22:32:13 +07:00			`terminal_panel.editor_interface = get_editor_interface()`
			`add_control_to_bottom_panel(terminal_panel, "Terminal")`
Add all the files 2020-05-10 00:07:31 +07:00

			`func _exit_tree():`
Add asciicast importer Former-commit-id: ffa85618659024515cdde252c56c7be34a245446 2020-09-22 15:31:46 +07:00			`remove_import_plugin(asciicast_import_plugin)`
			`asciicast_import_plugin = null`
Format files using GDScript Toolkit https://github.com/Scony/godot-gdscript-toolkit 2021-05-26 10:39:48 +07:00
Add basic .xrdb/.Xresources import plugin Adds basic support for importing .Xresources and .xrdb files as Theme resources. Examples of terminal color schemes in .xrdb format can be found here: https://github.com/mbadolato/iTerm2-Color-Schemes/tree/master/xrdb Examples of terminal themes in .Xresources format can be found here: https://github.com/mbadolato/iTerm2-Color-Schemes/tree/master/Xresources https://terminal.sexy also supports exporting themes is Xresources format. 2021-07-18 23:11:31 +07:00			`remove_import_plugin(xrdb_import_plugin)`
			`xrdb_import_plugin = null`

Add asciicast importer Former-commit-id: ffa85618659024515cdde252c56c7be34a245446 2020-09-22 15:31:46 +07:00			`remove_custom_type("Asciicast")`
Add new PTY node (replaces Pseudoterminal node) Uses fork of node-pty native code for forking pseudoterminals. Uses libuv pipe handle to communicate with the child process. - Paves the way for cross-platform (Linux, macOS and Windows) support. - Renames Pseudoterminal to PTY (which is much easier to type and spell :D). - Better performance than the old Pseudoterminal node. Especially when streaming large amounts of data such as running the `yes` command. - Allows setting custom file, args, initial window size, cwd, env vars (including important ones such as TERM and COLORTERM) and uid/gid on Linux and macOS. - Returns process exit code and terminating signal. 2021-07-03 00:27:34 +07:00
			`if pty_supported:`
Add rudimentary terminal to editor's bottom panel In order to use the gdnative library as an editor plugin it was neccessary to set the `reloadable` property of the gdnlib file to false, in order to prevent crashes when the godot editor window lost focus. This may have consequences when recompiling the library. See: https://docs.godotengine.org/en/3.3/classes/class_gdnativelibrary.html#class-gdnativelibrary-property-reloadable Still crashes quite frequently and doesn't close child processes properly. Part of #43. 2021-07-11 22:32:13 +07:00			`remove_control_from_bottom_panel(terminal_panel)`
			`terminal_panel.free()`