mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
76 lines
3.6 KiB
ReStructuredText
76 lines
3.6 KiB
ReStructuredText
.. _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**
|
|
|
|
.. figure:: img/editor_external_editor_settings.webp
|
|
:align: center
|
|
:alt: Text Editor > External section of the Editor Settings
|
|
|
|
**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:
|
|
|
|
+---------------------+-----------------------------------------------------+
|
|
| Field in Exec Flags | Is replaced with |
|
|
+=====================+=====================================================+
|
|
| ``{project}`` | The absolute path to the project directory |
|
|
+---------------------+-----------------------------------------------------+
|
|
| ``{file}`` | The absolute path to the file |
|
|
+---------------------+-----------------------------------------------------+
|
|
| ``{col}`` | The column number of the error |
|
|
+---------------------+-----------------------------------------------------+
|
|
| ``{line}`` | The line number of the error |
|
|
+---------------------+-----------------------------------------------------+
|
|
|
|
Some example **Exec Flags** for various editors include:
|
|
|
|
+---------------------+-----------------------------------------------------+
|
|
| Editor | Exec Flags |
|
|
+=====================+=====================================================+
|
|
| Geany/Kate | ``{file} --line {line} --column {col}`` |
|
|
+---------------------+-----------------------------------------------------+
|
|
| Atom | ``{file}:{line}`` |
|
|
+---------------------+-----------------------------------------------------+
|
|
| JetBrains Rider | ``{project} --line {line} {file}`` |
|
|
+---------------------+-----------------------------------------------------+
|
|
| Visual Studio Code | ``{project} --goto {file}:{line}:{col}`` |
|
|
+---------------------+-----------------------------------------------------+
|
|
| Vim (gVim) | ``"+call cursor({line}, {col})" {file}`` |
|
|
+---------------------+-----------------------------------------------------+
|
|
| Emacs | ``emacs +{line}:{col} {file}`` |
|
|
+---------------------+-----------------------------------------------------+
|
|
| 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.
|
|
|
|
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>`.
|
|
|
|
Official editor plugins
|
|
-----------------------
|
|
|
|
We have official plugins for the following code editors:
|
|
|
|
- `Visual Studio Code <https://github.com/godotengine/godot-vscode-plugin>`_
|
|
- `Emacs <https://github.com/godotengine/emacs-gdscript-mode>`_
|