Skip to content

Using raylib in VSCode

Marcus Sanatan edited this page Jan 30, 2022 · 14 revisions

VSCode is an excellent choice of code editor when it comes to raylib. Getting set up with a new VSCode project is easy.

Note: Make sure you install Raylib from the official release binaries rather than building Raylib from source (should work without changes on Windows if you install Raylib mingw release).

Step 1

Copy the VSCode folder (and all its contents) from raylib/projects/VSCode (from your installed directory) to your desired project location. These files can also be found here.

Note: You can use this Zip Tool to download only the VSCode folder as a zip.

Step 2

Make sure you set the proper paths to your local build of raylib in c_cpp_properties.json and tasks.json. These will be specific to your installation of raylib.

in c_cpp_properties.json make sure

"includePath": [
  "C:/raylib/raylib/src/**",
  "${workspaceFolder}/**"
],
"compilerPath": "C:/raylib/mingw/bin/gcc.exe",

in some cases it's mingw32 instead of mingw (which comes with installer v2.0). In version 4, the compiler path is as follows:

"compilerPath": "C:/raylib/w64devkit/bin/gcc.exe",

Check your folder to see which one you have. In tasks.json also you have to make this change for compile to occur.

Extra Configuration for Windows Subsystem for Linux Users

If you are on Windows and use Windows Terminal with the Windows Subsystem for Linux as your default shell, you won't be able to debug or build your game with the default settings. That's because the build configuration will try to launch cmd to open a standard Windows shell which won't exists in your Linux distribution.

To make it work, edit launch.json in the .vscode folder so that the externalConsole property is true instead of false. You need to make this change twice i.e. you should see "externalConsole": true, in both configurations.

Step 3

Install the "C/C++" VSCode extension. (From Menu - File > Preferences > Extensions)

Step 4

Try launching by using the "Debug" launch configuration in the Debug tab.

or

You can Build the game using View > Command Palette (or Ctrl + Shift + P), Type Run Task and press Enter. And Select the Build Debug option. A game executable will be created in the project folder. You can see any error in the console

Clone this wiki locally