A lot of times, your scene might need functionality that is already encapsulated in a reusable library. Using external libraries can make your work a lot easier.
You can import external libraries into a Decentraland project and then reference the systems, components, or functions described in these libraries.
Check the Awesome repository to find a series of libraries, both created by the Decentraland Foundation and by community members, that solve common problems.
Via the Editor #
Install a dependency #
Make sure you’ve installed the Decentraland editor.
- Open your scene’s folder using Visual Studio Code.
📔 Note: The Visual Studio window must be at the root folder of the scene project.
Open the Decentraland Editor tab on Visual Studio. Note that the bottom section lists all of your project’s currently installed dependencies.
+icon on the header of the Dependencies view.
Visual Studio opens an input box at the top of the screen. Provide the name of the dependency you wish to install and hit enter. The dependency is then installed to your scene. For example
📔 Note: If you wish to install a specific version of a dependency (and not the default latest version), you can specify this as part of the name with an
@at the end. For example
- If it is a Decentraland library (ie.
Update a dependency #
Click the refresh icon on the header of the Dependencies section. All dependencies on the scene are updated to the versions indicated on your scene’s
package.json file. If dependencies point to the
@latest version, then this action installs the current latest stable release.
If a dependency in your scene’s
package.json points to a specific version number, then you need to either:
Reinstall as a new dependency, clicking the plus sign and specifying the library name with
@latestat the end. For example
Manually change the
package.jsonfile so that the dependency version points to
@latest. Then click the update icon again.
Remove a dependency #
Hover over a dependency to see a trash icon. Press this icon to remove an unused dependency from the scene.
You can also click the
- icon on the header of the Dependencies section, and then write the name of the dependency you wish to delete.
Via the CLI #
To install a library in your project folder, run
npm i and the library name in your project’s root path. If the library is a Decentraland library, add
-B at the end, to install it like a bundled dependency. For example:
npm i @dcl/ecs-scene-utils -B
📔 Note: You may need to run
dcl buildafter installing the library for the library’s dependencies to get installed.
package.json file lists the version of the scene as
@latest, then run
npm i to update all libraries to their corresponding latest versions.
package.json references a specific version number, you can update it by running the command to install the library, adding
@ and the version number in the end. For example:
npm i @dcl/[email protected] -B
To delete a library from your scene’s dependencies run
npm rm and the library name. For example:
npm rm @dcl/ecs-scene-utils
It’s a good practice to remove any libraries that you’re not using. Unused libraries still occupy space in the scene, affecting the player’s experience of downloading and running your scene.