History

Henrik Lissner 88844e9cec docs: simplify internal docs links 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.		2021-11-21 20:04:28 +01:00
..
config.el	Add shortcuts and descriptions for GDScript module	2021-01-23 15:18:48 -06:00
packages.el	Bump :lang	2021-07-11 17:52:08 -04:00
README.org	docs: simplify internal docs links	2021-11-21 20:04:28 +01:00

README.org

:lang gdscript

Description
- Maintainers
- Module flags
- Packages
- Hacks
- Changelog
Installation
Usage
- LSP support
- Commands
Configuration
Troubleshooting
Frequently asked questions
Appendix

← Back to module index ! Issues ↖ Github ± Suggest edits ? Help

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

gdscript-mode

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?