# @applemusic-like-lyrics/core 中文文档

规范地址：https://npmcn.com/package/%40applemusic-like-lyrics/core/

版本：0\.6\.0
npm 元数据更新时间：2026-09-19T17:01:28.961Z
中文译文更新时间：2026-11-06T11:39:25.498Z
软件包许可：AGPL-3\.0-only

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

原始 npm 页面：https://www.npmjs.com/package/%40applemusic-like-lyrics/core
原文对照：https://npmcn.com/package/%40applemusic-like-lyrics/core/?lang=original
源码仓库：https://github.com/amll-dev/applemusic-like-lyrics

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

- 包体积（解压后）：1.9 MB，11 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：5 个
- peer 依赖：@pixi/app \*，@pixi/core \*，@pixi/sprite \*，@pixi/display \*，@pixi/filter-blur \*，@pixi/filter-bulge-pinch \*，@pixi/filter-color-matrix \*
- 首次发布：2023-07-24T08:40:52.619Z
- 最新版本发布：2026-09-19T17:01:28.555Z
- 近 30 天下载量：7388（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：35（近 12 个月 10 个）

## 中文简介

AMLL 的纯 JS 核心组件框架，包括歌词显示组件和背景组件等其它可以复用的组件

## 安装

```sh
npm install @applemusic-like-lyrics/core
```

也可以使用：`pnpm add @applemusic-like-lyrics/core`、`yarn add @applemusic-like-lyrics/core`、`bun add @applemusic-like-lyrics/core`

## README

# AMLL 核心

英文/英文 [简体中文](https://npmcn.com/package/%40applemusic-like-lyrics/core/README-CN.md)

> 警告: 这是一个个人项目,仍在开发中。 可能还有许多问题,所以请不要在生产环境中直接使用!

![AMLL-Core](https://img.shields.io/badge/Core-%233178c6?label=Apple%20Music-like%20Lyrics&labelColor=%23FB5C74) [![npm](https://img.shields.io/npm/dt/%40applemusic-like-lyrics/core)](https://www.npmjs.com/package/@applemusic-like-lyrics/core) [![npm](https://img.shields.io/npm/v/%40applemusic-like-lyrics%2Fcore)](https://www.npmjs.com/package/@applemusic-like-lyrics/core)

MALL的纯JS核心组件框架,包括lyric显示组件和背景组件以及其他可再用组件.

这里的一切都是UI框架独立的,因此可以在各种动态页面框架下间接地被引用.

或者,如果你需要使用组件绑定,有一个 [反应绑定版本](https://npmcn.com/package/%40applemusic-like-lyrics/react/README.md) (单位:千美元) [Vue 绑定版本](https://npmcn.com/package/%40applemusic-like-lyrics/vue/README.md)

## 特征

-   歌词和背景的纯前端渲染
-   带有翻译和罗马化的词层定时歌词
-   多行、 二重奏和背景线支持
-   通过 CSS 变量定制样式

## 安装

安装所需的依赖( 如果以下列出的依赖没有安装, 您需要自己安装):

```bash
npm install @pixi/app @pixi/core @pixi/display @pixi/filter-blur @pixi/filter-bulge-pinch @pixi/filter-color-matrix @pixi/sprite # using npm
yarn add @pixi/app @pixi/core @pixi/display @pixi/filter-blur @pixi/filter-bulge-pinch @pixi/filter-color-matrix @pixi/sprite # using yarn
```

安装框架 :

```bash
npm install @applemusic-like-lyrics/core # using npm
yarn add @applemusic-like-lyrics/core # using yarn
```

## 使用摘要

关于详细的API文档,请参见: [AMLL 文档](https://amll.dev/en/reference/core)。 。 。 .

```typescript
import { LyricPlayer } from "@applemusic-like-lyrics/core";
import "@applemusic-like-lyrics/core/style.css"; // Import required styles

const player = new LyricPlayer(); // Create a lyric player component
document.body.appendChild(player.getElement()); // Add the component's element to the page
player.setLyricLines([]) // Set lyrics
player.setCurrentTime(0) // Set current playback time (needs to be called every frame)
player.update(0) // Update lyric component animation (needs to be called every frame)
```

歌词设定通过 `LyricPlayer.setLyricLines` 是一个 `LyricLine[]` 参数。 关于详细情况,请参见: [./弧/接口.ts](https://npmcn.com/package/%40applemusic-like-lyrics/core/src/interfaces.ts)。 。 。 .

## 数据模型

词组输入为 `LyricLine[]`,每行包含:

-   `words`: 计时字数组,每个字包括 `startTime` 编号 : `endTime` 编号 : `word`,可选 `romanWord`, (中文(简体) ), `ruby`,以及 `obscene`
-   `translatedLyric`: 翻译文本
-   `romanLyric`: 罗马化文本
-   `startTime` 编号 : `endTime`:行时间戳
-   `isBG` 编号 : `isDuet`: 背景和二重奏旗帜

## 样式

主作风格由: `@applemusic-like-lyrics/core/style.css`。常见的覆盖通过 CSS 变量:

```css
.amll-lyric-player {
  --amll-lp-color: #ffffff;
  --amll-lp-bg-color: rgba(0, 0, 0, 0.35);
}
```

## 发展

```bash
pnpm --filter @applemusic-like-lyrics/core dev
pnpm --filter @applemusic-like-lyrics/core build
```

## 常见问题

### @applemusic-like-lyrics/core 是什么？

AMLL 的纯 JS 核心组件框架，包括歌词显示组件和背景组件等其它可以复用的组件

### 如何安装 @applemusic-like-lyrics/core？

在项目目录运行 npm install @applemusic-like-lyrics/core，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@pixi/app（\*）、@pixi/core（\*）、@pixi/sprite（\*）、@pixi/display（\*）、@pixi/filter-blur（\*）、@pixi/filter-bulge-pinch（\*）、@pixi/filter-color-matrix（\*）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @applemusic-like-lyrics/core 支持 TypeScript 吗？

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

### @applemusic-like-lyrics/core 支持 ESM 还是 CommonJS？

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

### @applemusic-like-lyrics/core 可以商用吗？

@applemusic-like-lyrics/core 使用 AGPL-3\.0-only 许可。最严格的 Copyleft：除分发外，通过网络向用户提供基于它的服务也需要开源对应源码。闭源 SaaS 使用前务必评估。以上为概括，不构成法律意见，请以许可原文为准。

### @applemusic-like-lyrics/core 的下载量有多少？

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

### @applemusic-like-lyrics/core 还在维护吗？

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