Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update docs #905

Merged
merged 1 commit into from
Feb 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,16 @@

FeelUOwn 是一个稳定、用户友好以及高度可定制的音乐播放器。

[![macOS 效果预览](https://user-images.githubusercontent.com/4962134/235288158-39e6e01d-74f4-4f14-b942-7af924fc6a90.png)](https://www.bilibili.com/video/av46787694/)
[![macOS 效果预览](https://github.com/user-attachments/assets/6d96c655-e35b-46d8-aaec-4d4dc202347f)](https://www.bilibili.com/video/av46787694/)

### 特性

- 稳定、易用:
- 一键安装,各流行平台均有打包(如 Arch Linux, Windows, macOS 等)
- 有各媒体资源平台的插件,充分且合理的利用全网免费资源(如网易云、QQ、Bilibili 等)
- 有各媒体资源平台的插件,充分且合理的利用全网免费资源(如 Youtube Music 等)
- 基础功能完善,桌面歌词、资源智能替换、多音质选择、nowplaying 协议等
- 核心模块有较好的测试覆盖、核心接口保持较好的向后兼容
- 大模型加持:AI 电台、自然语言转歌单等
- 可玩性强:
- 提供基于 TCP 的交互控制协议
- 基于文本的歌单,方便与朋友分享、设备之间同步
Expand All @@ -31,7 +32,7 @@ FeelUOwn 是一个稳定、用户友好以及高度可定制的音乐播放器
# Arch Linux
yay -S feeluown # 安装稳定版,最新版的包名为 feeluown-git
yay -S feeluown-netease # 按需安装其它扩展
yay -S feeluown-kuwo
yay -S feeluown-ytmusic
yay -S feeluown-bilibili

# macOS(也可以下载打包好的二进制)
Expand Down
17 changes: 14 additions & 3 deletions docs/source/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,29 @@

参考 :doc:`quickstart` 文档进行安装。

提供国内各音乐平台插件
提供各音乐平台插件
---------------------------

- `Youtube Music <https://github.com/feeluown/feeluown-ytmusic>`_
- `网易云音乐 <https://github.com/feeluown/feeluown-netease>`_
- `虾米音乐 <https://github.com/feeluown/feeluown-xiami>`_
- `QQ 音乐 <https://github.com/feeluown/feeluown-qqmusic>`_
- `Bilibili <https://github.com/feeluown/feeluown-bilibili>`_

自动寻找播放资源
----------------------------

在搜索框输入 ``==> 我怀念的 - 孙燕姿`` ,播放器会自动匹配歌曲并进行播放。
当你播放 A 平台的 VIP/收费歌曲时,播放器会尝试从其它平台为你寻找免费资源(你需要安装各音乐平台插件)。

自然语言转歌单(AI)
----------------------------

.. image:: https://github.com/user-attachments/assets/8afa13e6-8ff9-4b4f-9ca7-ad1f5661d8cb

基于文本的歌单
----------------------------

将下面内容拷贝到文件 ``~/.FeelUOwn/collections/favorite.fuo`` 中,重启 FeelUOwn 就可以看到此歌单::
将下面内容拷贝到文件 ``~/.FeelUOwn/collections/library.fuo`` 中,重启 FeelUOwn 就可以看到此歌单::

fuo://netease/songs/16841667 # No Matter What - Boyzone
fuo://netease/songs/65800 # 最佳损友 - 陈奕迅
Expand Down
41 changes: 41 additions & 0 deletions docs/source/fuorc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,10 @@ VIDEO_SELECT_POLICY ``str`` ``hd<>`` :class:`feeluown.media.Qua
NOTIFY_ON_TRACK_CHANGED ``bool`` ``False`` 切换歌曲时显示桌面通知
NOTIFY_DURATION ``int`` ``3000`` 桌面通知保留时长(ms)
PROVIDERS_STANDBY ``list`` ``None`` 候选歌曲提供方(默认:所有提供方)
OPENAI_API_KEY ``str`` ``''`` OpenAI API Key
OPENAI_API_BASEURL ``str`` ``''`` OpenAI API Base URL
OPENAI_MODEL ``str`` ``''`` 大模型名字
AI_RADIO_PROMPT ``str`` ``...`` AI Radio 功能的 PROMPT
======================= ========= ============ =========

实验特性的配置项
Expand Down Expand Up @@ -91,6 +95,43 @@ MPV_AUDIO_DEVICE ``str`` ``auto`` MPV 播放设备
.. autofunction:: feeluown.app.config.create_config


AI 助手配置
--------------

要使用 AI 助手,你需要首先做两件事

1. 确保已经安装了 OpenAI 的 Python 包
2. 并且自己有 OpenAI/DeepSeek/Kimi/豆包/智谱AI 等大模型平台(任意一个)的 的 API Key

安装 OpenAI 的 Python 包比较简单,如果你是使用 pipx 安装的,你可以运行::

pipx inject feeluown openai

如果你使用的是 Linux 系统包管理器,你只需要在系统环境中安装 openai 包即可。

获取 API Key 的方法需要参考各个 AI 平台方的文档。以 DeepSeek 为例,你需要在 DeepSeek
“API 开放平台”注册并申请一个 API KEY。然后在 ``~/.furoc`` 中进行如下配置。

.. code:: python

# deepseek
config.OPENAI_API_BASEURL = 'https://api.deepseek.com'
config.OPENAI_MODEL = 'deepseek-chat'
config.OPENAI_API_KEY = '---API KEY---'

# import os

# 豆包
# config.OPENAI_API_BASEURL = 'https://ark.cn-beijing.volces.com/api/v3'
# config.OPENAI_MODEL = 'ep-20250202091715-vwjw2'
# config.OPENAI_API_KEY = os.environ.get('ARK_API_KEY', '')

# kimi
# config.OPENAI_API_BASEURL = 'https://api.moonshot.cn/v1'
# config.OPENAI_MODEL = 'moonshot-v1-8k'
# config.OPENAI_API_KEY = os.environ.get('MOONSHOT_API_KEY', '')


功能定制
--------------

Expand Down
20 changes: 11 additions & 9 deletions docs/source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,27 @@ Ubuntu

.. sourcecode:: sh

# 安装 Python 3 和 pip3(大部分系统已经安装好了)
sudo apt-get install python3 python3-pip
# 安装 Python 3 和 pipx (大部分系统已经安装好了)
sudo apt-get install python3 python3-pip pipx

# 配置 pipx
# pipx 的安装配置教程可以参考:https://github.com/pypa/pipx?tab=readme-ov-file#on-linux
pipx ensurepath
sudo pipx ensurepath --global

# 安装 libmpv1
sudo apt-get install libmpv1

# 安装 PyQt5
sudo apt-get install python3-pyqt5
sudo apt-get install python3-pyqt5.qtopengl
sudo apt-get install python3-pyqt5.qtsvg
sudo apt-get install python3-pyqt5 python3-pyqt5.qtopengl python3-pyqt5.qtsvg

# 安装 dbus-python
sudo apt-get install python3-dbus
sudo apt-get install python3-dbus.mainloop.pyqt5
sudo apt-get install python3-dbus python3-dbus.mainloop.pyqt5

# 安装 feeluown (是一个 Python 包)
# --upgrade 代表安装最新版,--user 代表不安装到系统目录
pip3 install 'feeluown>=3.0[battery]' --upgrade --user
pip3 install pyopengl
pipx install 'feeluown[battery,cookies,webengine]'
pipx inject feeluown pyopengl

# 运行 feeluown -h 来测试安装是否成功
# 如果提示 Commmand Not Found,请查看文档「常见问题」部分
Expand Down
4 changes: 3 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,13 @@
},
python_requires=">=3.8",
url='https://github.com/feeluown/FeelUOwn',
keywords=['media', 'player', 'application', 'PyQt5', 'Python 3'],
keywords=['media', 'player', 'application', 'PyQt5', 'music'],
classifiers=[
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9',
'Programming Language :: Python :: 3.10',
'Programming Language :: Python :: 3.11',
'Programming Language :: Python :: 3.12',
'Programming Language :: Python :: 3 :: Only',
'Environment :: X11 Applications :: Qt',
"Topic :: Multimedia :: Sound/Audio",
Expand Down
Loading