@dcl/quests-client

中文文档
1.0.3发布于 2023/10/25Apache-2.0TypeScriptCommonJS近 30 天下载 5941

查询客户端

中文使用文档
文档目录3 节
  1. 安装
  2. 示例
  3. 场景示例:查询跟踪

Decentraland

查询客户端 - SDK7

SDK7的查询客户端是一个 RPC 客户端 与 查询服务器 追踪探寻的国家,并发送事件以取得进展.

设置

如果您想要为该项目做出贡献,则需要安装依赖并构建项目.

首先安装国家预防机制的依赖性:

$ npm install

该项目使用查询服务 原型定义 生成编译所需的代码,所以在开始开发前,确保您运行:

$ make build

使用量

这个库旨在被用在Decentraland Scene中,并使用用户认证等SDK7特性来初始化客户端.

您可以找到文档开始使用库 这里。 。 。 .

安装

向您的工程添加依赖性

$ npm add @dcl/quests-client

示例

创建查询客户端 executeTask 而如果基于钱包的认证是 OK, 您将准备使用客户端订阅更新或发送新的事件, 这些事件可能会在搜索中取得进展 .

例如,我们注册了两个可观察者来利用您代码中其他部分的客户端: questEventsObservable 财务报告和审定财务报表 questStartObservable

executeTask(async () => {
  // retrieve websocket url from env
  const ws = 'wss://quests-rpc.decentraland.zone'

  const questID = 'q123-u456-e789-s012-t345'

  // create quests client
  try {
    const client = await createQuestsClient(ws, questID)

    questEventsObservable.on('message', async (action) => {
      await client.sendEvent({ action })
    })

    questStartObservable.on('start', async () => {
      await client.startQuest()
    })

    client.onStarted((quest) => {
      // update your state here or react to the quest started event
    })

    client.onUpdate((quest) => {
      // update your state here or react to the quest updates
    })

    // retrieve all quest instances and their state
    const userInstance = client.getQuestInstance()
    ...
  } catch (e) {
    console.log(`[Your Scene] connection to ${ws} failed! ${e}`)
  }
})

场景示例:查询跟踪

在这 仓库 您可以找到一个可以使用所有查询客户端功能的场景.

或者你去看看图书馆的文件 这里

版本与发布记录

@dcl/quests-client 共发布 23 个版本,首次发布于 2023/06/02;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.3latest2023/10/253 年前
1.0.3-20231025131529.commit-ab10531next2023/10/253 年前
1.0.22023/10/253 年前
1.0.2-20231024193022.commit-5a9b8892023/10/253 年前
1.0.12023/10/253 年前
1.0.1-20231024191537.commit-4091ac72023/10/253 年前

关于 @dcl/quests-client 的常见问题

@dcl/quests-client 是什么?

查询客户端

如何安装 @dcl/quests-client?

在项目目录运行 npm install @dcl/quests-client,或使用 pnpm add / yarn add / bun add。

@dcl/quests-client 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@dcl/quests-client 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@dcl/quests-client 可以商用吗?

@dcl/quests-client 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@dcl/quests-client 的下载量有多少?

根据 npm 官方下载统计,@dcl/quests-client 在 2026/10/12 – 2026/11/10 这 30 天内被下载 5,941 次,日均约 198 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@dcl/quests-client 还在维护吗?

最新版本 1.0.3 发布于 2023/10/25(3 年前);至今共发布 23 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/06/02。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。