mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-08 15:09:50 +01:00
60 lines
3.1 KiB
ReStructuredText
60 lines
3.1 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`
|
|
|
|
.. image:: img/editor_settings.png
|
|
|
|
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:
|
|
|
|
+---------------------+-----------------------------------------------------+
|
|
| 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/Sublime Text | `{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}` |
|
|
+---------------------+-----------------------------------------------------+
|
|
|
|
.. 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 <https://github.com/godotengine/godot-vscode-plugin>`_
|
|
- `Emacs <https://github.com/godotengine/emacs-gdscript-mode>`_
|