doomemacs/modules/lang/gdscript/README.org
Henrik Lissner 7e400abdc0
fix(docs): set mode in file-local vars
Due to emacs-straight/org-mode@e22b4eb, a replacement major mode (for
org-mode) can no longer be specified from .dir-locals.el, as it spirals
into infinite recursion. Therefore, a mode: line is needed in all Doom
docs.

Ref: emacs-straight/org-mode@e22b4eb7aa
2022-08-03 02:46:33 +02:00

2.5 KiB

:lang gdscript

Description   unfold

This module adds support for GDScript, the scripting language of the Godot game engine, to Doom Emacs, powered by gdscript-mode.

Maintainers

This module needs a maintainer. Become a maintainer?

Module flags

+lsp
Enable LSP support for gdscript-mode. Requires :tools lsp and a langserver (Godot 3.2.1 or newer).

Packages

Hacks

No hacks documented for this module.

TODO Changelog

This module does not have a changelog yet.

Installation

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 gdtoolkit:

# On Windows
pip install gdtoolkit

# On MacOS and Linux
pip3 install gdtoolkit

TODO Usage

🔨 This module's usage documentation is incomplete. Complete it?

LSP support

The language server support for GDScript is built into by lsp-mode. As long as you have +lsp and :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 (SPC m for evil users, C-c l otherwise) to explore available commands.

TODO Configuration

🔨 This module has no configuration documentation yet. Write some?

Troubleshooting

Report an issue?

  • The GDScript language server has known issues causing some errors with lsp-mode. They should be addressed in future releases.

Frequently asked questions

This module has no FAQs yet. Ask one?

TODO Appendix

🔨 This module has no appendix yet. Write one?