RSG 2.0 SDK documentation

Task guides and concepts for Roku SceneGraph TypeScript apps.

Overview and getting started

• RSG 2.0 SDK overview
• Getting started with the RSG 2.0 SDK
• Examples
• Directory layout
• Installing @roku-sdk/* packages from npmjs.com
• rk create
• rk CLI

Core concepts

• App configuration options (roku-config.ts)
• Dynamic Component Libraries (DCL)
• Tween value-shape contract
• Effects
• Flexible manifest processing

Guides

• FlexGrid API usage
• FlexGrid
• Focus boundary
• FocusableGroup
• KeyHandler
• Modal boundary
• Importing and processing static images
• RSG testing library

Runtime and debugging

• App profiling
• Mapping runtime errors to TypeScript source code
• Forwarding exceptions to monitoring services
• Fetch: deviations from the WHATWG standard
• Perfetto profiling
• Debugging Roku apps with AI
• rk decode-stack
• rk logs
• rk perfetto

Advanced and tooling

• Asset tree-shaking
• Extending the device pool
• Pipeline extension API
• rk build
• rk dcl
• rk dev
• rk device lease
• rk device pool
• rk device
• rk ecp
• rk gen-types
• rk keysequence
• AI integration via MCP (rk mcp)
• rk device package
• rk plugins
• Roku Cloud Emulator devices
• rk server managed lifecycle (phase 0 contract)
• rk server
• Importing XML components with type safety

Knowledge base and troubleshooting

• AnchorNode ↔ base-component field-name collisions
• Console API polyfill (@roku-sdk/native)
• js-debug: cross-directory sourceMappingURL cannot be resolved
• 1. Recreation of nodes

API reference

• Generated SDK API reference
• Generated rk CLI reference
• Generated MCP tool reference
• Generated HTTP reference

Generated reference pages are published separately. Missing pages are warnings during the beta documentation check.

Release and upgrade notes

• 2.16.0
• Upgrade notes

Beta

The RSG 2.0 SDK is currently in beta. During this time:

• Stable packages install from npmjs.com without registry configuration or a token.
• Contributors can clone the public repository
  and link workspace packages to run bundled examples. See
  Installing the SDK.
• Documentation and APIs may still change. You should read the
  Upgrade notes before upgrading.