Update Customizing the interface and Using an external text editor docs

This commit is contained in:
Hugo Locurcio
2023-07-11 00:37:42 +02:00
parent 3c2412dd8f
commit dc54a081fc
11 changed files with 175 additions and 24 deletions

View File

@@ -1,19 +1,21 @@
:article_outdated: True
.. _doc_external_editor:
Using an external text editor
==============================
=============================
This page explains how to code using an external text editor.
Godot can be used with an external text editor, such as Sublime Text or Visual
Studio Code. Browse to the relevant editor settings: ``Editor -> Editor Settings
-> Text Editor -> External``
Studio Code. Browse to the relevant editor settings:
**Editor > Editor Settings > Text Editor > External**
.. image:: img/editor_settings.png
.. figure:: img/editor_external_editor_settings.webp
:align: center
:alt: Text Editor > External section of the Editor Settings
There are two fields: the executable path and command-line flags. The flags
**Text Editor > External** section of the Editor Settings
There are two text fields: the executable path and command-line flags. The flags
allow you to integrate the editor with Godot, passing it the file path to open
and other relevant arguments. Godot will replace the following placeholders in
the flags string:
@@ -30,7 +32,7 @@ the flags string:
| ``{line}`` | The line number of the error |
+---------------------+-----------------------------------------------------+
Some example Exec Flags for various editors include:
Some example **Exec Flags** for various editors include:
+---------------------+-----------------------------------------------------+
| Editor | Exec Flags |
@@ -50,16 +52,19 @@ Some example Exec Flags for various editors include:
| Sublime Text | ``{project} {file}:{line}:{column}`` |
+---------------------+-----------------------------------------------------+
.. note:: For Visual Studio Code on Windows, you will have to point to the ``code.cmd``
file. For Emacs, you can call ``emacsclient`` instead of ``emacs`` if
you use the server mode.
.. note::
For Visual Studio Code on Windows, you will have to point to the ``code.cmd``
file.
For Emacs, you can call ``emacsclient`` instead of ``emacs`` if
you use the server mode.
Using External Editor in Debugger
---------------------------------
Using external editor in debugger is determined by a separate option in settings.
For details see :ref:`Script editor debug tools and options <doc_debugger_tools_and_options>`.
For details, see :ref:`Script editor debug tools and options <doc_debugger_tools_and_options>`.
Official editor plugins
-----------------------