Skip to content

Commit

Permalink
vs code extension document is added (#652)
Browse files Browse the repository at this point in the history
* vs code extension document is added

* modified

* Update docs/user-manual/scripting/vscode-extension.md

Co-authored-by: Will Eastcott <[email protected]>

* Update docs/user-manual/scripting/vscode-extension.md

Co-authored-by: Will Eastcott <[email protected]>

* Update docs/user-manual/scripting/vscode-extension.md

Co-authored-by: Will Eastcott <[email protected]>

* Update docs/user-manual/scripting/vscode-extension.md

Co-authored-by: Will Eastcott <[email protected]>

* webp image added

* updates

* fix errors

* fixes

* Edit pass

---------

Co-authored-by: Will Eastcott <[email protected]>
  • Loading branch information
isumygin-sc and willeastcott authored Apr 16, 2024
1 parent 3a6961f commit 58ad574
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions docs/user-manual/scripting/vscode-extension.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: VS Code Extension
sidebar_position: 12
---

For developers seeking an enhanced code editing experience with features like source control, GitHub Copilot and a wide range of extensions, integrating Visual Studio Code (VS Code) with PlayCanvas offers a powerful alternative to the built-in Code Editor. To this end, we provide an [open-source](https://github.com/playcanvas/vscode-extension) VS Code Extension.

![Live Editing script assets with VS Code extension](/img/user-manual/scripting/vscode-extension.webp)

## Features

* **Real-Time Sync**: Any changes made in VS Code are automatically synced with your PlayCanvas project, ensuring that your team always has access to the latest updates.
* **Enhanced Code Editing**: Leverage the full power of VS Code's editing features, such as IntelliSense, code snippets, GitHub Copilot and advanced refactoring tools.
* **Source Control**: Switch branches to work in isolation.
* **Collaboration**: Collaborate on scripts and shaders with your team, with changes reflected immediately in the PlayCanvas editor. Use the `Pull Latest` command from the context menu to pull latest changes into your VS Code environment.

## Installation

* **Install Visual Studio Code**: [Download VS Code](https://code.visualstudio.com/download) and install it.
* **Install the PlayCanvas VS Code Extension**: Search for [the PlayCanvas extension](https://marketplace.visualstudio.com/items?itemName=playcanvas.playcanvas) in the VS Code Marketplace and install it. This extension connects VS Code to your PlayCanvas projects using the PlayCanvas [REST API](/user-manual/api/).

### Configuration

* Open VS Code and navigate to Settings (`File` > `Preferences` > `Settings`) and type "PlayCanvas" in the search bar.
* [Generate a new API Key](/user-manual/api/#authorization) and enter the key and User ID in the settings. User ID can be found in your [PlayCanvas account settings](https://playcanvas.com/account).
* Toggle "PlayCanvas: Use Playcanvas Types" to enable or disable PlayCanvas Engine API types for enhanced IntelliSense support. It adds a virtual reference to the type definitions automatically at the top of the source file. The reference will not be uploaded when the script is updated.

## Using the Extension

* **Add Project**: Open your project in VS Code by opening the Command Pallette (`CTRL`+`Shift`+`P`) and typing "PlayCanvas: Add Project".
* **Edit**: Edit scripts, shaders and other text assets with rich editing support.
* **Sync**: Save your changes in VS Code; the PlayCanvas extension automatically syncs these changes to the cloud.
* **Preview and Debug**: Use the [Launch Page](/user-manual/editor/launch-page/) to preview and debug your application as you develop.

### Debugging

The VS Code extension for PlayCanvas does not directly support debugging of scripts running in the browser. However, you can [use browser developer tools](/user-manual/scripting/debugging/) to debug your PlayCanvas scripts in conjunction with VS Code for a powerful debugging experience.

Integrating VS Code with PlayCanvas provides a sophisticated environment tailored for advanced development workflows, giving developers the flexibility and tools needed to build complex and high-performance web-based applications.
Binary file not shown.

0 comments on commit 58ad574

Please sign in to comment.