88844e9cec
Fewer links means less confusion. - Merge doom-issue and doom-commit links into doom-ref (for auto-linking Issue/PR/commit references). - Merge doom-module-source and doom-docs-source links into doom-source. - Rename doom-report-issue to doom-report. - Use '!' as the icon for module issues link. - Remove doom-repo (replaced with "doom:*" in :lang org module). - Add doomdir and emacsdir links to :lang org module.
80 lines
2.7 KiB
Org Mode
80 lines
2.7 KiB
Org Mode
← [[doom-module-index:][Back to module index]] ! [[doom-module-issues:::lang gdscript][Issues]] ↖ [[doom-source:modules/lang/gdscript/][Github]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
|
--------------------------------------------------------------------------------
|
|
#+TITLE: :lang gdscript
|
|
#+SUBTITLE: the language you waited for
|
|
#+CREATED: June 01, 2020
|
|
#+SINCE: 21.12.0 (#3239)
|
|
|
|
* Description :unfold:
|
|
This module adds support for GDScript, the scripting language of the [[http://godotengine.org/][Godot]] game
|
|
engine, to Doom Emacs, powered by [[https://github.com/GDQuest/emacs-gdscript-mode][gdscript-mode]].
|
|
|
|
** Maintainers
|
|
*This module needs a maintainer.* [[doom-contrib-maintainer:][Become a maintainer?]]
|
|
|
|
** Module flags
|
|
- +lsp ::
|
|
Enable LSP support for ~gdscript-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
|
(Godot ~3.2.1~ or newer).
|
|
|
|
** Packages
|
|
- [[doom-package:][gdscript-mode]]
|
|
|
|
** Hacks
|
|
/No hacks documented for this module./
|
|
|
|
** TODO Changelog
|
|
# This section will be machine generated. Don't edit it by hand.
|
|
/This module does not have a changelog yet./
|
|
|
|
* Installation
|
|
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
|
|
|
This module requires Godot 3.2.1+ to be installed to make use of any of its
|
|
features (beyond syntax highlighting).
|
|
|
|
To format your GDScript code, you will need [[https://github.com/Scony/godot-gdscript-toolkit/][gdtoolkit]]:
|
|
#+begin_src sh
|
|
# On Windows
|
|
pip install gdtoolkit
|
|
|
|
# On MacOS and Linux
|
|
pip3 install gdtoolkit
|
|
#+end_src
|
|
|
|
* TODO Usage
|
|
#+begin_quote
|
|
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
|
#+end_quote
|
|
|
|
** LSP support
|
|
The language server support for GDScript is built into by lsp-mode. As long as
|
|
you have [[doom-module:][+lsp]] and [[doom-module:][:tools lsp]] enabled, and Godot 3.2.1+ installed, it should work
|
|
out of the box.
|
|
|
|
Godot's language server is built into the game engine, so you need to open your
|
|
project in Godot ~3.2.1~ or above for the GDScript language server to be
|
|
available.
|
|
|
|
** Commands
|
|
Press the localleader key ([[kbd:][SPC m]] for evil users, [[kbd:][C-c l]] otherwise) to explore
|
|
available commands.
|
|
|
|
* TODO Configuration
|
|
#+begin_quote
|
|
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
|
|
#+end_quote
|
|
|
|
* Troubleshooting
|
|
[[doom-report:][Report an issue?]]
|
|
|
|
- The GDScript language server has known issues causing some errors with
|
|
[[doom-package:][lsp-mode]]. They should be addressed in future releases.
|
|
|
|
* Frequently asked questions
|
|
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
|
|
|
|
* TODO Appendix
|
|
#+begin_quote
|
|
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
|
|
#+end_quote
|