@dcl/sdk

Main SDK package for building Decentraland scenes.

Overview

The Decentraland SDK provides a complete framework for creating interactive 3D scenes in the Decentraland metaverse. It includes:

- Entity Component System (ECS) for scene development
- UI components and layout tools
- Asset management utilities
- Scene networking capabilities
- Input handling and interactions

Installation

``bash
npm install @dcl/sdk
`

Quick Start

1. Create a new scene:

`bash
npx @dcl/sdk-commands init
`

2. Start the development server:

`bash
npm start
`

Usage

`typescript
import { engine, Entity, Transform, GltfContainer } from '@dcl/sdk/ecs'

// Create an entity
const entity = engine.addEntity()

// Add components
Transform.create(entity, {
position: { x: 8, y: 0, z: 8 },
scale: { x: 1, y: 1, z: 1 }
})

GltfContainer.create(entity, {
src: 'models/myModel.glb'
})
`

Features

$3

- Transform
- GltfContainer
- Material
- UiTransform
- AudioSource
- And many more...

$3

- Input handling
- Physics
- Animation
- Networking

$3

- Flexbox layout
- React-like components
- Event handling

Development

$3

`bash
make build
`

$3

`bash


Run all tests


make test
`

$3

For local development, you can also use:

`bash


Clean all build artifacts and reinstall dependencies

make clean && make install

Format and fix linting issues

make lint-fix

Update dependencies across packages

make sync-deps
``

Documentation

- SDK Documentation
- Scene Examples
- ECS

Architecture Decisions

For a deeper understanding of the SDK architecture:

- ADR-117: CRDT Protocol for Scenes
- ADR-123: Schema and Serialization
- ADR-165: Component Declaration