From 3271002b9ec7ac9863785e842e3600d5dbec1dc0 Mon Sep 17 00:00:00 2001 From: Nathan Lovato Date: Wed, 28 Oct 2020 13:51:42 -0600 Subject: [PATCH] Edit external_editor.rst Add intro Tweak text Add commands for Emacs Link to the two official external editor plugins --- tutorials/editor/external_editor.rst | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/tutorials/editor/external_editor.rst b/tutorials/editor/external_editor.rst index e5cb069af..267620ae0 100644 --- a/tutorials/editor/external_editor.rst +++ b/tutorials/editor/external_editor.rst @@ -3,17 +3,20 @@ Using an external text editor ============================== +This page explains how to code using an external text editor. + .. warning:: - `External editors are currently incompatible with Godot's "Sync Script Changes" feature. `__ + `External editors are currently incompatible with Godot's "Sync Script + Changes" feature. `__ -Godot can be used with an external text editor, such as Sublime Text or Visual Studio Code. -To enable an external text editor, browse to the relevant editor settings via: -``Editor -> Editor Settings -> Text Editor -> External`` +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`` .. image:: img/editor_settings.png -There are two fields: the executable path and command line flags. The flags +There are two 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: @@ -45,5 +48,17 @@ Some example Exec Flags for various editors include: +---------------------+-----------------------------------------------------+ | Vim (gVim) | ``"+call cursor({line}, {col})" {file}`` | +---------------------+-----------------------------------------------------+ +| Emacs | ``emacs +{line}:{col} {file}`` | ++---------------------+-----------------------------------------------------+ -.. note:: For Visual Studio Code you will have to point to the ``code.cmd`` file. +.. note:: For Visual Studio Code, 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. + +Official editor plugins +----------------------- + +We have official plugins for the following code editors: + +- `Visual Studio Code `_ +- `Emacs `_