# @flare-engine/achievements 中文文档

规范地址：https://npmcn.com/package/%40flare-engine/achievements/

版本：0\.4\.12
npm 元数据更新时间：2026-11-12T19:49:38.987Z
中文译文更新时间：2026-11-14T22:49:11.959Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40flare-engine/achievements
原文对照：https://npmcn.com/package/%40flare-engine/achievements/?lang=original
项目主页：https://github.com/grzott/flare-engine#readme
源码仓库：https://github.com/grzott/flare-engine

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：54.4 kB，12 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：0 个
- peer 依赖：react \>=19\.0\.0
- 首次发布：2026-06-09T16:19:37.057Z
- 最新版本发布：2026-11-12T19:49:38.598Z
- 近 30 天下载量：2302（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：17（近 12 个月 17 个）

## 中文简介

供应商接口(消费者提供适配器)

## 安装

```sh
npm install @flare-engine/achievements
```

也可以使用：`pnpm add @flare-engine/achievements`、`yarn add @flare-engine/achievements`、`bun add @flare-engine/achievements`

## README

# @flare-engine/成绩

类型 `AchievementsProvider` 接口 + `NoopAchievementsProvider` +反应上下文,加 `createMemoryAchievements` 编号 : `createStorageAchievements` ——本地供应商,拥有定义的解锁/进度合同,用于测试,dev,和单人游戏. 混凝土平台适配器(Game Center,Google Play Games,Steam)是后发射的;在此之前在应用边界自线.

## 安装

```sh
bun add @flare-engine/achievements
```

## 使用量

```tsx
import {
  AchievementsContext,
  useAchievements,
  NoopAchievementsProvider,
} from '@flare-engine/achievements';

export function App() {
  return (
    <AchievementsContext.Provider value={NoopAchievementsProvider}>
      {/* ... */}
    </AchievementsContext.Provider>
  );
}
```

`useAchievements()` 返回活动提供者。 这个 `AchievementsProvider` 表面为 `unlock(id, progress?)`, (中文(简体) ), `getState(id)`,以及 `getAll()` - 全都是动脉 进展是局部的 `[0, 1]` 值; 省略以完全解锁.

## 本地供应商+解锁合同

`createMemoryAchievements()` 保持状态为内存; `createStorageAchievements(store, opts?)` 以注射方式坚持 `{ get, set }` 存储。 两者都拥有相同的合同——语义适配器作者应保留:

```ts
import { createStorageAchievements } from '@flare-engine/achievements';
import type { AchievementsStore } from '@flare-engine/achievements';

declare const myStore: AchievementsStore;

const achievements = createStorageAchievements(myStore); // { get, set }

await achievements.unlock('first_blood', 0.5); // progress 0.5
await achievements.unlock('first_blood', 0.2); // ignored — progress stays 0.5
await achievements.unlock('first_blood');      // full unlock, latches
await achievements.getState('first_blood');    // { unlocked: true, progress: 1, unlockedAt }
```

-   **相撞+单音:** 进度被锁定到 `[0, 1]` (非无限 ) `0`),永不减少——一个更低要求的值被忽略.
-   **`unlock(id)` 完全解锁** (目标进展) `1`) (中文(简体) ).
-   **带子 :** 实现进展 `1` 套装 `unlocked: true` 邮票 `unlockedAt` 一次(通过注射) `now`默认值 `Date.now`) (中文(简体) ). 重新解锁是禁用——原版 `unlockedAt` 保留.
-   **未跟踪的IDs** 报告 `{ unlocked: false, progress: 0 }`。 。 。 .

`AchievementsStore` 是一个结构 `{ get(key): Promise<string | null>; set(key, value): Promise<void> }` - 那个 `get`编号 :`set` 子集为 `@flare-engine/storage`是因为 `StorageAdapter`,因此存储提供者不添加依赖性,并与任何 Aync KV (AsyncStorage, MMKV 包装器, a) 合作 `localStorage` 嘘,... ) 它从水分上懒惰地从 `store.get(key)` (默认密钥) `'flare.achievements'`),在每次突变后持续,而串行会写出这样同时解锁不会丢失更新.

## 内置后退

在 CI 或 dev 构建中没有平台证书, 请选择 `NoopAchievementsProvider` (或当地供应商)在您自己的嵌入式旗帜后方,所以在真实的资质存在之前,任何事物都不要触碰本地的SDK.

## 常见问题

### @flare-engine/achievements 是什么？

供应商接口\(消费者提供适配器\)

### 如何安装 @flare-engine/achievements？

在项目目录运行 npm install @flare-engine/achievements，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=19\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @flare-engine/achievements 支持 TypeScript 吗？

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

### @flare-engine/achievements 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @flare-engine/achievements 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @flare-engine/achievements 可以商用吗？

@flare-engine/achievements 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @flare-engine/achievements 的下载量有多少？

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

### @flare-engine/achievements 还在维护吗？

最新版本 0\.4\.12 发布于 2026/11/13（3 天前）；至今共发布 17 个版本，其中过去 12 个月发布了 17 个；首次发布于 2026/06/10。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。