Skip to content

Commit

Permalink
deprecated vs-extension (#485)
Browse files Browse the repository at this point in the history
  • Loading branch information
nearnshaw authored Jan 27, 2025
1 parent fee3d11 commit e368b7c
Show file tree
Hide file tree
Showing 13 changed files with 58 additions and 48 deletions.
2 changes: 1 addition & 1 deletion content/creator/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ There are also some community-built tools that can help you create Decentraland
- [**DCL Edit**](https://dcl-edit.com/): Drag and drop 3d models into your scene. You can then work on adding interactivity to the resulting scene using the SDK.
- [**Unity Exporter Toolkit**](https://github.com/PolygonalMind/dcl-dev-exportersdk7-release): Build in Unity, with a number of pre-built interactive modules. Export a fully-working Decentraland scene.

The following deprecated tools are also available:
The following **deprecated tools** are also available:

- **Web Editor:** Use an easy drag and drop interface to create scenes. [Learn more]({{< ref "/content/creator/sdk7/web-editor/web-editor.md" >}}).

Expand Down
16 changes: 8 additions & 8 deletions content/creator/deprecated/quests/client.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ Use the [Quests Client for SDK 7](https://github.com/decentraland/quests-client)

### Installation

#### Via the CLI

Run this command in your scene's directory:

```bash
$ npm install @dcl/quests-client
```

#### Via the VS Code Extension

Follow the steps in [Install a dependency]({{< ref "/content/creator/sdk7/libraries/manage-dependencies.md#install-a-dependency" >}}):
Expand All @@ -26,14 +34,6 @@ Follow the steps in [Install a dependency]({{< ref "/content/creator/sdk7/librar

3. Visual Studio opens an input box at the top of the screen. Write `@dcl/quests-client`.

#### Via the CLI

Run this command in your scene's directory:

```bash
$ npm install @dcl/quests-client
```

## Quests Client overview

The types below are defined in [Quests Client for SDK 7](https://github.com/decentraland/quests-client).
Expand Down
6 changes: 0 additions & 6 deletions content/creator/sdk7/debugging/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,6 @@ Ideally, the loading of the code in your scene should follow a clear sequential

To fix these dependencies, you often must resort to calling functions or object constructors passing references to already instanced entities/objects in the function arguments; Instead of hard-coding references to these entities/objects in the function, which may or may not already be instanced.

## Issues when running the VS Code Extension

### Issue: The Decentraland extension never finishes loading the scene, it may say something like "Can't connect to server".

Make sure your Node version is up to date. It must be 16 or newer.

# Issues when deploying

### Issue: You don't have permissions to deploy to these parcels
Expand Down
6 changes: 4 additions & 2 deletions content/creator/sdk7/getting-started/installation-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,11 @@ image & more info

## VS Code Extension

The Decentraland Visual Studio Code extension allows you to build, preview and deploy Decentraland scenes.
{{< hint warning >}}
**📔 Note**: The Decentraland Visual Studio Code Extension is deprecated. We encourage you to use the Creator Hub together with Visual Studio Code without the extension.
{{< /hint >}}

<img src="/images/editor/editor-header.png" alt="Header" width="100%"/>
The Decentraland Visual Studio Code extension allows you to build, preview and deploy Decentraland scenes.

To install the Decentraland Visual Studio Code extension:

Expand Down
20 changes: 0 additions & 20 deletions content/creator/sdk7/getting-started/preview-scene.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,26 +54,6 @@ You can add the following flags to the `npm run start` command to change its beh
**📔 Note**: Parameters need to be added with two series of dashes, for example `npm run start -- --web3`.
{{< /hint >}}

## Using the VS Code Extension

{{< hint warning >}}
**📔 Note**: The VS Code Extension will open your scene preview on the legacy Web Explorer.
{{< /hint >}}

To run a scene preview using the VS Code Extension:

Make sure you've [installed the Decentraland VS Code Extension]({{< ref "/content/creator/sdk7/getting-started/installation-guide.md#vs-code-extension" >}}).

1. Open your scene's folder using Visual Studio Code.

> Note: The Visual Studio window must be at the root folder of the scene project.
2. Open the Decentraland tab on Visual Studio. Note that the bottom section lists all of your project's currently installed dependencies.

3. Click the **Run Scene** button.

This opens a browser tab running the Decentraland scene.

## Upload a scene to decentraland

Once you're happy with your scene, you can upload it and publish it to Decentraland. For this you must own LAND, a Decentraland NAME, or an ETH ENS name, or have permissions given by someone that does. See [publishing]({{< ref "/content/creator/sdk7/publishing/publishing.md" >}}) for instructions on how to do that.
Expand Down
4 changes: 4 additions & 0 deletions content/creator/sdk7/getting-started/scene-from-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ weight: 6

Create a new Decentraland scene project based on an example to start out with a solid base. You can use this to reuse game mechanics, art assets, or anything that may be included in the parent project.

{{< hint warning >}}
**📔 Note**: The Decentraland Visual Studio Code Extension is deprecated. We encourage you to use the [Creator Hub]({{< ref "/content/creator/scene-editor/about-editor.md" >}}) instead.
{{< /hint >}}

1. Make sure you've [installed the Decentraland VS Code Extension]({{< ref "/content/creator/sdk7/getting-started/installation-guide.md#vs-code-extension" >}})

2. Open a Visual Studio Code window on an _empty folder_.
Expand Down
2 changes: 1 addition & 1 deletion content/creator/sdk7/interactivity/deprecated-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ Event data includes only the ID of the player and a version number for that avat
When this event is triggered, you can then use the [getUserData()]({{< ref "/content/creator/sdk7/interactivity/user-data.md#get-player-data">}}) function to fetch the latest version of this information, including the list of wearables that the player has on. You may need to add a slight delay before you call `getUserData()` to ensure that the version this function returns is up to date.

{{< hint info >}}
**💡 Tip**: When testing in preview with the legacy web explorer, to avoid using a random avatar, run the scene in the browser connected with your Metamask wallet. In the VS Code Extension Editor, open the Decentraland tab and hover your mouse over it to display the three dots icon on the top-right. Click this icon and select **Open in browser with Web3**.
**💡 Tip**: When testing in preview with the legacy web explorer, to avoid using a random avatar, run the scene in the browser connected with your Metamask wallet. In the deprecated VS Code Extension Editor, open the Decentraland tab and hover your mouse over it to display the three dots icon on the top-right. Click this icon and select **Open in browser with Web3**.
{{< /hint >}}

{{< hint warning >}}
Expand Down
2 changes: 1 addition & 1 deletion content/creator/sdk7/interactivity/event-listeners.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ The event on `AvatarBase` includes the following information:
You can also detect changes in wearables or avatars form other players in the scene, simply pass a reference to the other player instead of `engine.PlayerEntity`.

{{< hint info >}}
**💡 Tip**: When testing in preview with the legacy web editor, to avoid using a random avatar, run the scene in the browser connected with your Metamask wallet. In the Decentraland VS Code Extension, open the Decentraland tab and hover your mouse over it to display the three dots icon on the top-right. Click this icon and select **Open in browser with Web3**.
**💡 Tip**: When testing in preview with the legacy web editor, to avoid using a random avatar, run the scene in the browser connected with your Metamask wallet. In the Decentraland deprecated VS Code Extension, open the Decentraland tab and hover your mouse over it to display the three dots icon on the top-right. Click this icon and select **Open in browser with Web3**.
{{< /hint >}}

You can also detect changes on the profiles of other players in the scene, simply pass a reference to the other player instead of `engine.PlayerEntity`.
Expand Down
4 changes: 4 additions & 0 deletions content/creator/sdk7/libraries/manage-dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ Check the [Examples page](https://studios.decentraland.org/resources?sdk_version

## On the VS Code extension

{{< hint warning >}}
**📔 Note**: The Decentraland Visual Studio Code Extension is deprecated. We encourage you to use the [Creator Hub]({{< ref "/content/creator/scene-editor/about-editor.md" >}}) together with Visual Studio Code without the extension.
{{< /hint >}}

### Install a dependency

Make sure you've [installed the VS Code Extension]({{< ref "/content/creator/sdk7/getting-started/installation-guide.md#vs-code-extension" >}}).
Expand Down
4 changes: 4 additions & 0 deletions content/creator/sdk7/projects/portable-experiences.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ Smart Wearables are a kind of portable experience that is associated to a wearab

### Using the VS Code Extension

{{< hint warning >}}
**📔 Note**: The Decentraland Visual Studio Code Extension is deprecated. We encourage you to use the [Creator Hub]({{< ref "/content/creator/scene-editor/about-editor.md" >}}) together with Visual Studio Code without the extension.
{{< /hint >}}

Make sure you've [installed the Decentraland VS Code Extension]({{< ref "/content/creator/sdk7/getting-started/installation-guide.md#vs-code-extension" >}}), then:

1. Open a Visual Studio Code window on an _empty folder_.
Expand Down
4 changes: 4 additions & 0 deletions content/creator/sdk7/projects/smart-wearables.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ The **Creator Hub** doesn't currently support creating Smart Wearables projects.

### Using the VS Code Extension

{{< hint warning >}}
**📔 Note**: The Decentraland Visual Studio Code Extension is deprecated. We encourage you to use the [Creator Hub]({{< ref "/content/creator/scene-editor/about-editor.md" >}}) together with Visual Studio Code without the extension.
{{< /hint >}}

Make sure you've [installed the Decentraland VS Code Extension]({{< ref "/content/creator/sdk7/getting-started/installation-guide.md#vs-code-extension" >}}), then:

1. Open a Visual Studio Code window on an _empty folder_.
Expand Down
12 changes: 12 additions & 0 deletions content/creator/sdk7/publishing/publishing.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,10 @@ Make sure you've [installed the Creator Hub]({{< ref "/content/creator/scene-edi

### Via the VS Code Extension

{{< hint warning >}}
**📔 Note**: The Decentraland Visual Studio Code Extension is deprecated. We encourage you to use the [Creator Hub]({{< ref "/content/creator/scene-editor/about-editor.md" >}}) together with Visual Studio Code without the extension.
{{< /hint >}}

Make sure you've [installed the Decentraland VS Code Extension]({{< ref "/content/creator/sdk7/getting-started/installation-guide.md#vs-code-extension" >}}).

1. Open your scene's folder using Visual Studio Code.
Expand Down Expand Up @@ -162,6 +166,10 @@ If you're working in a confidential project that you don't want to unveil until

### Via the VS Code Extension

{{< hint warning >}}
**📔 Note**: The Decentraland Visual Studio Code Extension is deprecated. We encourage you to use the [Creator Hub]({{< ref "/content/creator/scene-editor/about-editor.md" >}}) together with Visual Studio Code without the extension.
{{< /hint >}}

To deploy a scene to the test server:

1. Open VSCode in a Decentraland scene project.
Expand Down Expand Up @@ -201,6 +209,10 @@ Players are never directed to this server, the only way to access it is to expli

### Via the VS Code Extension

{{< hint warning >}}
**📔 Note**: The Decentraland Visual Studio Code Extension is deprecated. We encourage you to use the [Creator Hub]({{< ref "/content/creator/scene-editor/about-editor.md" >}}) together with Visual Studio Code without the extension.
{{< /hint >}}

To deploy a scene to a custom server:

1. Open VSCode in a Decentraland scene project.
Expand Down
24 changes: 15 additions & 9 deletions content/creator/worlds/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,21 +56,23 @@ However, Worlds granted by ENS domain ownership serve as the perfect first step

## Publish a World

Users have various options to publish content on their World:
Users have various options to publish content on their World. As a prerequisite for any of the options below, you must hold a Decentraland NAME or ENS Domain in your wallet, or have permissions granted by an owner.

### 1. Using the Web Editor (no-code)
### 1. Use the Creator Hub (no-code / code)

The Builder is the ideal choice for non-developers. Scenes can be created from scratch using the Scene Builder by simply dragging and dropping items into the scene. [Smart items]({{< ref "/content/creator/scene-editor/smart-items/smart-items.md" >}}) can also be used for player interaction once the scene is deployed.
The Creator Hub is the go-to option for creating Decentraland Scenes. It can be used to create no-code scenes via an easy drag-and-drop interface, or you can also combine it with Visual Studio Code to write code freely.

See [Publish Scene]({{< ref "/content/creator/scene-editor/publish-scene.md" >}}) for more details.

Creators can also use Templates, edit them, and then deploy them to their World. More templates from the Foundation will be uploaded over time. Another option is to use a scene from the Scene Pool. Anyone can get a scene from the pool, download it, and then import it into the Builder to edit it or deploy it to a World as it is.
### 2. Using the Web Editor (no-code)

When deploying a scene from the Builder, users will have the option to select either a Decentraland NAME or an ENS Domain held in their wallet.
The Builder is the ideal choice for non-developers. Scenes can be created from scratch using the Scene Builder by simply dragging and dropping items into the scene. [Smart items]({{< ref "/content/creator/scene-editor/smart-items/smart-items.md" >}}) can also be used for player interaction once the scene is deployed.

The [Builder](https://builder.decentraland.org/worlds) also serves as the go-to place for visualizing your allocated space and monitoring how much is consumed by each Decentraland NAME or ENS Domain. Additionally, users can easily undeploy scenes to release storage space, view when their storage capacity is exceeded, and access comprehensive information about their Worlds, whether they are hosted on Decentraland NAMES or ENS Domains.

### 2. Using the SDK and Editor
### 3. Using the SDK and Editor

The starting point for this product is having a scene that meets the size requirements mentioned above. If you wish to know more about how to create a scene, check out the [Decentraland SDK]({{< ref "/content/creator/sdk7/getting-started/sdk-101.md" >}}) documentation.
If you wish to know more about how to create a scene, check out the [Decentraland SDK]({{< ref "/content/creator/sdk7/getting-started/sdk-101.md" >}}) documentation.

If you are a Content Creator, you may be already familiar with how the [publishing of a scene]({{< ref "/content/creator/deprecated/scenes/publishing/publishing.md" >}}) works, the experience is quite similar, but with a small caveat:

Expand Down Expand Up @@ -108,14 +110,18 @@ If you wish to opt-out from your Worlds being indexed in Places, you can add the
}
```

### 3. Publish via the VS Code Extension:
### 4. Publish via the VS Code Extension:

{{< hint warning >}}
**📔 Note**: The Decentraland Visual Studio Code Extension is deprecated. We encourage you to use the [Creator Hub]({{< ref "/content/creator/scene-editor/about-editor.md" >}}) instead.
{{< /hint >}}

1. Open VSCode in a Decentraland scene project.
2. Click on the Decentraland icon on the left sidebar.
3. Click on the three-dot menu at the top right of the sidebar, next to the green reload arrow button, select **Publish Scene To Your World**
4. Approve the transaction.

### 4. Publish via the CLI
### 5. Publish via the CLI

To deploy a scene to a world via the CLI, you need to specify the target server in the deployment command-line and use the Worlds Content Server URL.

Expand Down

0 comments on commit e368b7c

Please sign in to comment.