summaryrefslogtreecommitdiffstats
path: root/doc/classes/EditorSettings.xml
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2023-06-16 09:24:32 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2023-12-19 15:04:02 +0100
commit0e97acff84ca6c859b48b22a6d42c4680ef1c432 (patch)
tree9ea2b3767cf8f605c8350d5f3d9dfb1db4f64554 /doc/classes/EditorSettings.xml
parenta311a4b162364d032b03ddf2a0e603ba40615ad7 (diff)
downloadredot-engine-0e97acff84ca6c859b48b22a6d42c4680ef1c432.tar.gz
Add a editor FileSystem dock action to open a terminal in selected folder
This is useful to enter some commands without having to open a separate terminal and `cd` to the project folder.
Diffstat (limited to 'doc/classes/EditorSettings.xml')
-rw-r--r--doc/classes/EditorSettings.xml15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml
index ec051c0545..3bfa24537f 100644
--- a/doc/classes/EditorSettings.xml
+++ b/doc/classes/EditorSettings.xml
@@ -463,6 +463,21 @@
<member name="filesystem/external_programs/raster_image_editor" type="String" setter="" getter="">
The program that opens raster image files when clicking "Open in External Program" option in Filesystem Dock. If not specified, the file will be opened in the system's default program.
</member>
+ <member name="filesystem/external_programs/terminal_emulator" type="String" setter="" getter="">
+ The terminal emulator program to use when using [b]Open in Terminal[/b] context menu action in the FileSystem dock. You can enter an absolute path to a program binary, or a path to a program that is present in the [code]PATH[/code] environment variable.
+ If left empty, Godot will use the default terminal emulator for the system:
+ - [b]Windows:[/b] PowerShell
+ - [b]macOS:[/b] Terminal.app
+ - [b]Linux:[/b] The first terminal found on the system in this order: gnome-terminal, konsole, xfce4-terminal, lxterminal, kitty, alacritty, urxvt, xterm.
+ To use Command Prompt (cmd) instead of PowerShell on Windows, enter [code]cmd[/code] in this field and the correct flags will automatically be used.
+ On macOS, make sure to point to the actual program binary located within the [code]Programs/MacOS[/code] folder of the .app bundle, rather than the .app bundle directory.
+ If specifying a custom terminal emulator, you may need to override [member filesystem/external_programs/terminal_emulator_flags] so it opens in the correct folder.
+ </member>
+ <member name="filesystem/external_programs/terminal_emulator_flags" type="String" setter="" getter="">
+ The command-line arguments to pass to the terminal emulator that is run when using [b]Open in Terminal[/b] context menu action in the FileSystem dock. See also [member filesystem/external_programs/terminal_emulator].
+ If left empty, the default flags are [code]{directory}[/code], which is replaced by the absolute path to the directory that is being opened in the terminal.
+ [b]Note:[/b] If the terminal emulator is set to PowerShell, cmd, or Konsole, Godot will automatically prepend arguments to this list, as these terminals require nonstandard arguments to open in the correct folder.
+ </member>
<member name="filesystem/external_programs/vector_image_editor" type="String" setter="" getter="">
The program that opens vector image files when clicking "Open in External Program" option in Filesystem Dock. If not specified, the file will be opened in the system's default program.
</member>