xref: /MusicFree/readme.md (revision b882a19d884fffa32f7c8cef31652b909dceaa0f)
1# MusicFree
2---
3## 简介
4一个插件化、定制化、无广告的免费音乐播放器,目前只支持Android和Harmony OS。
5
6如果需要了解后续进展可以关注b站账号:[不想睡觉猫头猫](https://space.bilibili.com/12866223);如果有问题可以在issue区或者qq群:252994941反馈。
7
8## 特性
9- 插件化:本软件仅仅是一个播放器,本身**并不集成**任何平台的任何音源,所有的搜索、播放、歌单导入等功能全部基于**插件**。这也就意味着,**只要可以在互联网上搜索到的音源,只要有对应的插件,你都可以使用本软件进行搜索、播放等功能**。关于插件的详细说明请看插件一节。
10
11- 插件支持的功能:搜索(音乐、专辑、作者)、播放、查看专辑、查看作者详细信息、导入单曲、导入歌单、获取歌词等。
12
13- 定制化、无广告:本软件提供了浅色、深色模式;支持自定义背景;本软件基于GPL协议开源,~~一个star做交易~~ 将会保持免费。
14- 隐私:所有的数据都存储在本地,本软件不会收集你的任何个人信息。
15- 歌词关联:你可以把两首歌的歌词关联起来,比如将歌曲A的歌词关联到歌曲B,关联后A、B两首歌都将显示歌曲B的歌词。你也可以关联多首歌的歌词,如A->B->C,这样A、B、C三首歌都将显示C的歌词。
16
17
18
19
20## 插件
21插件本质上是一个满足插件协议的js函数。插件中定义了搜索(音乐、专辑、作者)、播放、查看专辑、作者详细信息、导入歌单、获取歌词等基本函数,插件的开发者只需要关心输入输出逻辑,至于分页、缓存等全都交给MusicFree控制即可。本软件通过插件来完成播放器的所有功能,这样解耦的设计也可以使得本软件可以专注于做一个功能完善的播放器,我直呼小而美。
22
23插件开发文档可以参考(todo: 仓库以及说明)
24
25
26需要注意的是:
27- 如果你是使用第三方下载的插件,那么请自行鉴别插件的安全性(基本上看下没有奇怪的网络请求什么的就好了;自己写的最安全,*不要安装来路不明的东西*),防止恶意代码破坏。因为第三方恶意插件导致的可能的损失与本软件无关。
28
29- 插件使用过程中可能会产生某些和本软件无关的版权数据,插件产生的任何数据与本软件无关,请使用者自行删除数据。
30
31## 下载地址
32请转到发布页查看:todo
33
34
35## ChangeLog
36
37## 支持这个项目
38如果你喜欢这个项目,或者希望我可以持续维护下去,你可以通过以下任何一种方式支持我;)
391. Star这个项目,分享给你身边的人;
402. 关注b站[不想睡觉猫头猫](https://space.bilibili.com/12866223)或公众号获取最新信息;
41
42`2022.10.01`
43
44希望可以发布第一版吧。
45
46---
47本项目仅供学习参考使用,不得以任何方式用于任何商业行为;请在符合法律法规的情况下合理使用本项目。