Merge branch 'vscode-instructions' of https://github.com/MrJohn10/colobot into vscode-instructions
commit
db031c7985
|
@ -1,61 +0,0 @@
|
|||
# Using Visual studio code to compile and install project
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before compilation you have to install tools and dependencies (points 1,2,3): [Installing tools and dependencies](https://github.com/colobot/colobot/wiki/How-to-Build-Colobot%3A-Gold-Edition-Using-MSVC#installing-tools-and-dependencies).
|
||||
|
||||
### Cloning project
|
||||
|
||||
In order to clone the project execute the following command:
|
||||
```
|
||||
git clone https://github.com/colobot/colobot.git
|
||||
```
|
||||
In order to clone 'data' submodule you also have to execute: **(this module is needed to launch the game)**
|
||||
```
|
||||
git submodule update --init
|
||||
```
|
||||
If you want you can combine this commands and execute:
|
||||
```
|
||||
git clone https://github.com/colobot/colobot.git --recurse-submodules
|
||||
```
|
||||
### Configuring vscode
|
||||
|
||||
1. Open project folder in vscode.
|
||||
2. Install extension [CMake Tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools).
|
||||
3. Install extensnion [C/C++](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools).
|
||||
4. On the status line at the bottom you can choose cmake configuration and compiler (see the screenshot attached at the bottom)
|
||||
|
||||
### Adding cmake settings:
|
||||
|
||||
* create folder .vscode if there is none. Inside that folder create file settings.json with the following content:
|
||||
```json
|
||||
{
|
||||
"cmake.configureSettings": {
|
||||
"name": "x64-Debug",
|
||||
"generator": "Ninja",
|
||||
"configurationType": "Debug",
|
||||
"inheritEnvironments": ["msvc_x64_x64"],
|
||||
"CMAKE_TOOLCHAIN_FILE": input path to toolchain,
|
||||
"VCPKG_TARGET_TRIPLET": "x64-windows-static",
|
||||
"BOOST_STATIC": "1",
|
||||
"GLEW_STATIC": "1",
|
||||
"MSVC_STATIC": "1"
|
||||
},
|
||||
"cmake.buildDirectory": "${workspaceFolder}\\out\\build\\x64-Debug",
|
||||
"cmake.installPrefix": "${workspaceFolder}\\out\\build\\x64-Debug",
|
||||
"cmake.generator": "ninja"
|
||||
}
|
||||
```
|
||||
|
||||
### Compilation and installation
|
||||
|
||||
* Open cmake extension in the left menu.
|
||||
* Click on 'configure all projects'.
|
||||
* On the status line at the bottom change the compilation target to 'install'
|
||||
* Click build.
|
||||
* Click launch.
|
||||
|
||||

|
||||
|
||||
|
||||
If you have any problems create an issue or talk to us on our [Discord channel](https://discord.gg/TRCJRc).
|
Loading…
Reference in New Issue