luanti-org/luanti
1
0
Fork 0
mirror of https://github.com/luanti-org/luanti.git synced 2025-10-26 21:35:28 +01:00
Code Activity

Add documentation for IDE developer setup (#13935)

Browse Source
This commit is contained in:
AFCMS
2024-05-26 14:28:12 +02:00
committed by GitHub
parent 728f643ea7
commit 82790b1556
15 changed files with 193 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
doc/ides/vscode.md Normal file
View File

@@ -0,0 +1,51 @@
# [Visual Studio Code](https://code.visualstudio.com)
VSCode suppport for C/C++ and CMake is provided by
the [Microsoft C/C++ extension pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools-extension-pack).
You can install it from the VSCode extensions tab.
If you use a unofficial VSCode distribution like [VSCodium](https://vscodium.com), you will need to install the
extension pack manually by downloading the VSIX files and going to `Extensions > ... > Install from VSIX`.
CMake support for VSCode uses CMake presets provided by the project by default.
When you open the Minetest folder with VSCode, you should get a quick pick asking you for the default preset.
![VSCode CMake Preset Selection](images/vscode_cmake_preset_selection.png)
You can use the bottom bar to change the CMake profile, change the build target, build, run and debug (running/debugging doesn't build first).
![VSCode Toolbar](images/vscode_toolbar.png)
Like most of the VSCode experience, it may be faster to use commands directly (most of the VSCode UI just trigger commands).
| Command Name | Usecase |
|----------------------------------|----------------------------------|
| `CMake: Select Configure Preset` | Change the current CMake profile |
| `CMake: Set Build Target` | Change the current build target |
| `CMake: Build` | Build current target |
| `CMake: Clean` | Clean build files |
| `CMake: Run Without Debugging` | Run selected run target |
| `CMake: Debug` | Debug selected run target |
## Windows
Under Windows, the recommended compiler is the [Visual Studio](https://visualstudio.microsoft.com) compiler.
From the Visual Studio installer, you need to install the `Desktop development with C++` Workload.
[Vcpkg](https://vcpkg.io) is the recommended way of installing Minetest dependencies.
Follow the official documentation to install it and install Minetest dependencies as explained in [Windows compilation process](../compiling/windows.md).
You need to let CMake know about the `vcpkg` installation in VSCode.
Modify your `.vscode/settings.json`:
```json
{
"cmake.configureSettings": {
"CMAKE_TOOLCHAIN_FILE": "C:/path/to/vcpkg/scripts/buildsystems/vcpkg.cmake"
}
}
```