Skip to content

Commit b8eed4f

Browse files
committed
chore: update README
1 parent 9980338 commit b8eed4f

File tree

2 files changed

+134
-2
lines changed

2 files changed

+134
-2
lines changed

README.en.md

+67-1
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,12 @@ A combination of [landscape](https://github.com/hexojs/hexo-theme-landscape)、[
4949
- Mouse firework animation
5050
- pjax
5151
- ServiceWorker
52-
- live2d
52+
- live2d / live2d-widgets
5353
- reimu Mouse Pointer
5454
- Internal tag plugin for providing internal/external/friendly link cards
5555
- Support the bottom of the article copyright statement
5656
- Support for configuring custom CDN sources
57+
- Aplayer / Meting music player
5758
- Highly customizable
5859

5960
## Installation
@@ -562,6 +563,17 @@ Disabled by default
562563
```yaml
563564
live2d:
564565
enable: false
566+
position: left # left | right
567+
```
568+
569+
#### live2d-widgets
570+
571+
Disabled by default
572+
573+
```yaml
574+
live2d_widgets:
575+
enable: false
576+
position: left # left | right
565577
```
566578

567579
#### reimu cursor
@@ -672,6 +684,60 @@ home_categories:
672684
cover:
673685
```
674686

687+
#### Music Player (v1.2.0+)
688+
689+
> Please open Pjax before using it, otherwise the player will automatically pause
690+
691+
Use Aplayer + Meting (optional) disabled by default
692+
693+
##### Aplayer
694+
695+
Set `player.aplayer.enable` to `true` and configure it in `player.aplayer.options` according to [Aplayer Docs](https://aplayer.js.org/#/home?id=options)
696+
697+
```yaml
698+
player:
699+
aplayer:
700+
enable: true
701+
options:
702+
audio: [] # audio list
703+
fixed:
704+
autoplay:
705+
loop:
706+
order:
707+
preload:
708+
volume:
709+
mutex:
710+
listFolded:
711+
```
712+
713+
##### Aplayer + Meting
714+
715+
Set `player.aplayer.enable` and `player.meting.enable` to `true` at the same time, and configure it in `player.meting.options` according to [Meting Docs](https://github.com/metowolf/MetingJS?tab=readme-ov-file#option), `player.aplayer.options` is the Aplayer configuration
716+
717+
```yaml
718+
player:
719+
aplayer:
720+
enable: true
721+
options:
722+
audio: [] # this option will be overwritten by meting
723+
fixed:
724+
autoplay:
725+
loop:
726+
order:
727+
preload:
728+
volume:
729+
mutex:
730+
listFolded:
731+
meting:
732+
enable: true
733+
meting_api: # custom api
734+
options:
735+
id:
736+
server:
737+
type:
738+
auto:
739+
```
740+
675741
</details>
676742

677743

README.md

+67-1
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,12 @@
4848
- 鼠标动画
4949
- pjax
5050
- ServiceWorker
51-
- live2d
51+
- live2d / live2d-widgets
5252
- reimu 鼠标指针
5353
- 内部提供内链/外链/友链卡片的标签插件
5454
- 文章底部版权声明
5555
- 配置自定义 CDN 源
56+
- Aplayer / Meting 音乐播放器
5657
- 高度自定义
5758

5859
## 安装
@@ -561,6 +562,17 @@ service_worker:
561562
```yaml
562563
live2d:
563564
enable: false
565+
position: left # left | right
566+
```
567+
568+
#### live2d-widgets
569+
570+
默认关闭
571+
572+
```yaml
573+
live2d_widgets:
574+
enable: false
575+
position: left # left | right
564576
```
565577

566578
#### reimu 鼠标指针
@@ -667,6 +679,60 @@ home_categories:
667679
cover:
668680
```
669681

682+
#### 音乐播放器(v1.2.0+)
683+
684+
> 使用前建议先打开 Pjax,否则会出现播放器自动暂停的问题
685+
686+
使用Aplayer + Meting(可选)默认关闭
687+
688+
##### 纯Aplayer
689+
690+
将 `player.aplayer.enable` 设置为 `true`,并在 `player.aplayer.options` 中参考 [Aplayer Docs](https://aplayer.js.org/#/home?id=options) 进行配置
691+
692+
```yml
693+
player:
694+
aplayer:
695+
enable: true
696+
options:
697+
audio: [] # audio list
698+
fixed:
699+
autoplay:
700+
loop:
701+
order:
702+
preload:
703+
volume:
704+
mutex:
705+
listFolded:
706+
```
707+
708+
##### Aplayer + Meting
709+
710+
同时将 `player.aplayer.enable` 和 `player.meting.enable` 设置为 `true`,并在 `player.meting.options` 中参考 [Meting Docs](https://github.com/metowolf/MetingJS?tab=readme-ov-file#option) 进行配置,`player.aplayer.options` 为 Aplayer 配置
711+
712+
```yml
713+
player:
714+
aplayer:
715+
enable: true
716+
options:
717+
audio: [] # this option will be overwritten by meting
718+
fixed:
719+
autoplay:
720+
loop:
721+
order:
722+
preload:
723+
volume:
724+
mutex:
725+
listFolded:
726+
meting:
727+
enable: true
728+
meting_api: # custom api
729+
options:
730+
id:
731+
server:
732+
type:
733+
auto:
734+
```
735+
670736
</details>
671737

672738
<details>

0 commit comments

Comments
 (0)