godotengine / godotengine/godot-docs

Add configuration examples for macOS/Windows to the "Configuring an IDE" section

Open
#5,007 0 comments 0 reactions 0 assignees View on GitHub
area:engine details enhancement
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

**Your Godot version:**
Any.

**Issue description:**
Specifically, this applies to VS Code. As an example we use a Linux-compatible configuration. And while for the most part the idea for how to configure the editor is given, there are some things that should be set up differently on other operating systems, which often trips people.

We can use code tabs to show examples for all three major OSes. For VS Code that would be samples of `tasks.json` and `launch.json`. Maybe there are similar issues with other editors, but that's the one I see questions about the most.

Here's an adapted example of VS Code's `launch.json` for Windows that I use

```
{
"name": "Launch",
"type": "cppvsdbg",
"request": "launch",
"program": "${workspaceFolder}/bin/godot.windows.tools.64.exe",
// Change the arguments below for the project you want to test with.
// To run the project instead of editing it, remove the "--editor" argument.
"args": [ "-e", "--path", "path-to-your-godot-project-folder" ],
"stopAtEntry": false,
"cwd": "${workspaceFolder}",
"environment": [],
"externalConsole": false,
"visualizerFile": "${workspaceFolder}/platform/windows/godot.natvis"
},
```

**URL to the documentation page (if already existing):**
https://docs.godotengine.org/en/stable/development/cpp/configuring_an_ide/visual_studio_code.html

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.