{"id":14961410,"url":"https://github.com/godotengine/godot-vscode-plugin","last_synced_at":"2025-04-11T00:54:03.265Z","repository":{"id":39658997,"uuid":"76180369","full_name":"godotengine/godot-vscode-plugin","owner":"godotengine","description":"Godot development tools for VSCode","archived":false,"fork":false,"pushed_at":"2025-03-28T22:20:10.000Z","size":4197,"stargazers_count":1716,"open_issues_count":88,"forks_count":188,"subscribers_count":37,"default_branch":"master","last_synced_at":"2025-04-11T00:53:55.450Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/godotengine.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"custom":"https://fund.godotengine.org/"}},"created_at":"2016-12-11T14:46:29.000Z","updated_at":"2025-04-10T20:16:52.000Z","dependencies_parsed_at":"2023-10-11T05:14:08.274Z","dependency_job_id":"0a01d4c1-46d9-4c1a-9bf9-64ebe17bebf9","html_url":"https://github.com/godotengine/godot-vscode-plugin","commit_stats":{"total_commits":397,"total_committers":66,"mean_commits":6.015151515151516,"dds":0.5717884130982368,"last_synced_commit":"489db36e85f6732700ca188c2c8fa2c1ba14933f"},"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godotengine%2Fgodot-vscode-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godotengine%2Fgodot-vscode-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godotengine%2Fgodot-vscode-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godotengine%2Fgodot-vscode-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/godotengine","download_url":"https://codeload.github.com/godotengine/godot-vscode-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248322610,"owners_count":21084336,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-24T13:25:03.325Z","updated_at":"2025-04-11T00:54:03.240Z","avatar_url":"https://github.com/godotengine.png","language":"TypeScript","funding_links":["https://fund.godotengine.org/"],"categories":["TypeScript"],"sub_categories":[],"readme":"# Godot Tools\n\nGame development tools for working with [Godot Engine](http://www.godotengine.org/) in Visual Studio Code.\n\n**IMPORTANT NOTE:** Versions 1.0.0 and later of this extension only support\nGodot 3.2 or later.\n\n- [Godot Tools](#godot-tools)\n- [Features](#features)\n- [Download](#download)\n- [Commands](#commands)\n- [Configuration](#configuration)\n\t\t- [Godot Editor](#godot-editor)\n\t\t- [VS Code](#vs-code)\n- [GDScript Debugger](#gdscript-debugger)\n\t\t- [*Configurations*](#configurations)\n\t- [Issues and contributions](#issues-and-contributions)\n- [Contributing](#contributing)\n\t- [FAQ](#faq)\n\t\t- [Why does it fail to connect to the language server?](#why-does-it-fail-to-connect-to-the-language-server)\n\t\t- [Why isn't IntelliSense displaying script members?](#why-isnt-intellisense-displaying-script-members)\n\n\n# Features\n\n(**bold items** are new in Godot Tools `v2.0.0`)\n- **ALL FEATURES FULLY SUPPORT GODOT 4**\n- GDScript (`.gd`) language features:\n  - syntax highlighting\n  - `ctrl+click` on any symbol to jump to its definition or **open its documentation**\n  - `ctrl+click` on `res://resource/path` links\n  - **hover previews on `res://resource/path` links**\n  - **builtin code formatter**\n  - autocompletions\n  - full typed GDScript support\n  - optional \"Smart Mode\" to improve productivity with dynamically typed scripts\n  - Hover previews show function/variable definitions including doc-comments\n  - **switch from a `.gd` file to the related `.tscn` file (default keybind is `alt+o`)**\n  - display script warnings and errors\n- GDScript Debugger features:\n  - **completely rewritten, greatly improved reliability**\n  - **new, simple configuration** (seriously, just hit F5!)\n  - **convenient launch targets: current project/current file/pinned file**,\n  - breakpoints\n  - exceptions\n  - step-in/out/over\n  - variable watch\n  - call stack\n  - active scene tree\n  - inspector\n- GDResource (`.tscn` and `.tres`) language features:\n  - syntax highlighting\n  - **`ctrl+click` on `res://resource/path` links**\n  - **`ctrl+click` on symbols to jump to its definition or open its documentation**\n  - **hover previews show definitions of External and Sub Resources**\n  - **hover previews on `res://resource/path` links**\n  - **inlay hints to help visualize External and Sub Resources**\n  - **in-editor Scene Preview**\n- GDShader (`.gdshader`) language features:\n  - syntax highlighting\n\n# Download\n\n- [Visual Studio Marketplace **(recommended)**](https://marketplace.visualstudio.com/items?itemName=geequlim.godot-tools)\n  - Stable release, with support for automatic updates.\n- [GitHub Releases](https://github.com/godotengine/godot-vscode-plugin/releases)\n  - Stable release, but no automatic updates. Can be useful if you need to install an older version of the extension.\n- [Development build (follows the `master` branch)](https://nightly.link/godotengine/godot-vscode-plugin/workflows/ci/master/godot-tools.zip)\n  - Development build. Contains new features and fixes not available in stable releases, but may be unstable.\n  - Extract the ZIP archive before installing (it contains the `.vsix` file inside).\n\nTo install from GitHub Releases or a development build,\nsee [Install from a VSIX](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix)\nin the Visual Studio Code documentation.\n\n# Commands\n\nThe extension adds a few entries to the VS Code Command Palette under \"Godot Tools\":\n\n- Open workspace with Godot editor\n- List Godot's native classes (and open thier documentation)\n- Debug the current `.tscn`/`.gd` file\n- Debug the pinned `.tscn`/`.gd` file\n- Pin/Unpin the current `.tscn`/`.gd` file for debugging\n- Open the pinned file\n\n# Configuration\n\n### Godot Editor\n\nYou can set VS Code as your default script editor for Godot by following these steps:\n\n1. Open the **Editor Settings**\n2. Select **Text Editor \u003e External**\n3. Check **Use External Editor** \n4. Fill **Exec Path** with the path to your VS Code executable\n    * On macOS, this executable is typically located at: `/Applications/Visual Studio Code.app/Contents/MacOS/Electron`\n5. Fill **Exec Flags** with `{project} --goto {file}:{line}:{col}`\n\nYou can make Godot seamlessly reload VSCode-edited scripts by changing some additional settings. More details about each are available when hovering over the description in the Settings window: \n\n- **Editor Settings \u003e Text Editor \u003e Behavior \u003e Files \u003e Auto Reload Scripts on External Change**\n- **Editor Settings \u003e Interface \u003e Editor \u003e Save on Focus Loss**\n- **Editor Settings \u003e Interface \u003e Editor \u003e Import Resources When Unfocused**\n\n### VS Code\n\nYou can use the following settings to configure Godot Tools:\n\n- `godotTools.editorPath.godot3`\n- `godotTools.editorPath.godot4`\n\nThe path to the Godot editor executable. _Under Mac OS, this is the executable inside of Godot.app._\n\n- `godotTools.lsp.headless`\n  \nWhen using Godot \u003e3.6 or \u003e4.2, Headless LSP mode is available. In Headless mode, the extension will attempt to launch a windowless instance of the Godot editor to use as its Language Server.\n\n# GDScript Debugger\n\nThe debugger is for GDScript projects. To debug C# projects, use [C# Tools for Godot](https://github.com/godotengine/godot-csharp-vscode).\n\nTo configure the GDScript debugger:\n\n1. Open the command palette (by pressing F1):\n2. `\u003eView: Show Run and Debug`\n3. Click on \"create a launch.json file\"\n\n![Run and Debug View](img/run-and-debug.png)\n\n4. Select the Debug Godot configuration.\n5. Change any relevant settings.\n6. Press F5 to launch.\n\n### *Configurations*\n\nMinimal:\n```json\n{\n\t\"name\": \"Launch\",\n\t\"type\": \"godot\",\n\t\"request\": \"launch\"\n}\n```\n\nEverything:\n```json\n{\n\t\"name\": \"Launch\",\n\t\"type\": \"godot\",\n\t\"request\": \"launch\",\n\t\"project\": \"${workspaceFolder}\",\n\t\"address\": \"127.0.0.1\",\n\t\"port\": 6007,\n\t\"scene\": \"main|current|pinned|\u003cpath\u003e\",\n\t\"editor_path\": \"\u003cpath\u003e\",\n\t// engine command line flags\n\t\"profiling\": false,\n\t\"single_threaded_scene\": false,\n\t\"debug_collisions\": false,\n\t\"debug_paths\": false,\n\t\"debug_navigation\": false,\n\t\"debug_avoidance\": false,\n\t\"debug_stringnames\": false,\n\t\"frame_delay\": 0,\n\t\"time_scale\": 1.0,\n\t\"disable_vsync\": false,\n\t\"fixed_fps\": 60,\n\t// anything else\n\t\"additional_options\": \"\"\n}\n```\n\nGodot's command flags are documented here: https://docs.godotengine.org/en/stable/tutorials/editor/command_line_tutorial.html\n\n*Usage*\n\n- Stacktrace and variable dumps are the same as any regular debugger\n- The active scene tree can be refreshed with the Refresh icon in the top right.\n- Nodes can be brought to the fore in the Inspector by clicking the Eye icon next to nodes in the active scene tree, or Objects in the inspector.\n- You can edit integers, floats, strings, and booleans within the inspector by clicking the pencil icon next to each.\n\n![Showing the debugger in action](img/godot-debug.png)\n\n## Issues and contributions\n\nThe [Godot Tools](https://github.com/godotengine/godot-vscode-plugin) extension\nis an open source project from the Godot organization. Feel free to open issues\nand create pull requests anytime.\n\nSee the [full changelog](https://github.com/GodotExplorer/godot-tools/blob/master/CHANGELOG.md)\nfor the latest changes.\n\n# Contributing\n\nsee [CONTRIBUTING.md](CONTRIBUTING.md)\n\n## FAQ\n\n### Why does it fail to connect to the language server?\n\n- Godot 3.2 or later is required.\n- Make sure the Godot editor is running\n- Make sure to open the project in the Godot editor first. If you opened\n  the editor after opening VS Code, you can click the **Retry** button\n  in the bottom-right corner in VS Code.\n- Reset the LSP Server port to the default values in both Godot's Editor Settings and\n  in VSCode.\n\n### Why isn't IntelliSense displaying script members?\n\n- GDScript is a dynamically typed script language. The language server can't\n  infer all variable types.\n- To increase the number of results displayed, open the **Editor Settings**,\n  go to the **Language Server** section then check **Enable Smart Resolve**.\n\n### Can Godot/VSCode load in my script changes automatically instead of showing a confirmation window?\n\nGodot has some Editor Settings that can help you if your workflow involves changing files in both editors:\n\n- **Editor Settings \u003e Text Editor \u003e Behavior \u003e Files \u003e Auto Reload Scripts on External Change**\n- **Editor Settings \u003e Interface \u003e Editor \u003e Save on Focus Loss**\n- **Editor Settings \u003e Interface \u003e Editor \u003e Import Resources When Unfocused**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgodotengine%2Fgodot-vscode-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgodotengine%2Fgodot-vscode-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgodotengine%2Fgodot-vscode-plugin/lists"}