API
Adding Babylon.js to Your Web Project|
Support|
Using VSCode

Using Visual Studio Code (VSCode)

VSCode is one of several integrated development environments that can be used to develop Babylon.js projects. It has built-in Git integration and a plugin for displaying .babylon files.

You can install VSCode from its site: https://code.visualstudio.com/

Useful plugins

Once installed, a few plugins will help you have the best experience. You can search for them in the Extensions view (default shortcut: Ctrl+Shift+X on Windows/Linux, Cmd+Shift+X on macOS):

  1. Shader languages support for VSCode for syntax highlighting and autocompletion in GLSL shaders
  2. Babylon.js file viewer can be used to display the contents of a .babylon file directly in VSCode. It can be useful if you want to quickly check whether your artist did a good job with an object and its names :)

Keybindings setup

Finally, I would recommend adding a few shortcuts to your environment. Follow the guide:

  1. To configure keyboard shortcuts the way you want, go to the menu under File > Preferences > Keyboard Shortcuts. (Code > Preferences > Keyboard Shortcuts on Mac)
  2. Click Open Keyboard Shortcuts (JSON) on the right side and add:
// Place your key bindings in this file to overwrite the defaults
[
    { "key": "ctrl+shift+alt+s", "command": "workbench.action.files.saveFiles" },
    { "key": "ctrl+shift+alt+k", "command": "workbench.action.tasks.terminate" },
    { "key": "ctrl+shift+alt+t", "command": "workbench.action.tasks.test" },
    { "key": "ctrl+shift+alt+l", "command": "workbench.action.tasks.showLog" },
    { "key": "ctrl+shift+alt+r", "command": "workbench.action.tasks.runTask" }
]

This will make the main commands quicker to access. Do not hesitate to adapt the bindings to your preferences.

keybindings

Debugging code

VSCode also has a Run and Debug tab in the left pane. Select the launch configuration you want to use, then press the Start Debugging button (F5).

With the test task running from the VSCode Run and Debug tab, choose the section you want to debug and launch the debugger.

The debug session will debug all the TypeScript and JavaScript in Chrome and stop on your breakpoints set up in files in VSCode. It debugs all the code from src, materialsLibrary, proceduralTexturesLibrary, postprocessLibrary, etc.

Hint: If another Chrome session is already running with remote debugging on port 9222, the debugger will fail to attach because the port is already in use. You will need to close the other remote debugging session first.