FeelUOwn

https://feeluown.readthedocs.io/
Admin
FeelUOwn is a hackable and user-friendly music player that supports multiple online music platform...
Tokens:41,382
Snippets:271
Trust Score:9.6
Update:4 weeks ago
Show doc for...
Tokens:
Raw
### Example fuorc configuration file

Source: https://feeluown.readthedocs.io/en/latest/fuorc.html

Example fuorc configuration file. Sets theme, collections directory, and audio select policy, and registers a function to send a system notification when the song changes. Uses the `when` alias for `add_hook`.

```python
import os

# 自定义配置
config.THEME = 'dark'
config.COLLECTIONS_DIR = '~/Dropbox/public/music'
config.AUDIO_SELECT_POLICY = '>>>'


# 一个小功能：切换歌曲时，发送系统通知
def notify_song_changed(song):
    if song is not None:
        title = song.title_display
        artists_name = song.artists_name_display
        song_str = f'{title}-{artists_name}'
        os.system(f'notify-send "{song_str}"')

when('app.playlist.song_changed', notify_song_changed)

# 让编辑器识别这是一个 Python 文件
#
# Local Variables:
# mode: python
# End:
#
# vim: ft=python

```

--------------------------------

### Request options examples

Source: https://feeluown.readthedocs.io/en/latest/protocol.html

Examples of request options: less (shorthand for less=true) and format=json. These options are not yet implemented.

```text
# 搜索纵观线关键字，结果可以分多次返回（设置了请求选项）
# 这里 less 请求选项是 less=true 的简写
search 纵贯线  #: less

# 使用 JSON 格式返回
search 纵贯线 #: format=json,less
```

--------------------------------

### exec command example

Source: https://feeluown.readthedocs.io/en/latest/protocol.html

Shows the exec command using a multi-line request and its equivalent single-line form.

```text
# 让服务端执行代码
exec <<EOF
print('hello, feeluown')
player.pause()
EOF

# 它基本相当于
exec "print('hello, feeluown'); player.pause()"
```

--------------------------------

### Install openai package with pipx inject

Source: https://feeluown.readthedocs.io/en/latest/fuorc.html

Install the OpenAI Python package into the feeluown environment when feeluown was installed via pipx. Required before configuring the AI assistant.

```bash
pipx inject feeluown openai

```

--------------------------------

### Single-line request examples

Source: https://feeluown.readthedocs.io/en/latest/protocol.html

Examples of single-line requests: status, play, and search. The search command with options is not yet implemented.

```text
# 查看服务端状态，只需要提供命令即可
status

# 播放一首歌曲，必须提供一个参数
play fuo://local/songs/1
play "晴天 - 周杰伦"

# 搜索关键字为晴天、歌手为周杰伦、来源为网易云的歌曲
# 搜索命令必须提供一个参数，命令选项可选
# （注：该功能目前还未实现，欢迎 PR）
search 晴天 [artist=周杰伦,source=netease]
```

--------------------------------

### AI assistant provider configuration in fuorc

Source: https://feeluown.readthedocs.io/en/latest/fuorc.html

Configuration for AI assistant providers in ~/.fuorc. Shows active DeepSeek settings and commented-out examples for Doubao and Kimi. Replace the API key placeholder with your own key.

```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', '')

```

--------------------------------

### TaskManager usage example

Source: https://feeluown.readthedocs.io/en/latest/api.html

Usage example for TaskManager. It shows how to get or create a task spec with a unique name and preemptive kind, then bind a coroutine to it. The example uses TaskType.preemptive, which is an alias for TaskKind.preemptive.

```python
async def fetch_song():
     pass

task_name = 'unique-name'

task_spec = task_mgr.get_or_create(task_name, TaskType.preemptive)
task = task_spec.bind_coro(fetch_song())
```

--------------------------------

### 创建虚拟环境并安装依赖

Source: https://feeluown.readthedocs.io/en/latest/_sources/dev_quickstart.rst.txt

在 Home 目录下创建虚拟环境，激活后安装项目依赖。注意：在 Linux/macOS 下，PyQt6 通常安装在系统 Python 包目录，虚拟环境中可能无法 import，建议按文档中的方法调整 pyvenv.cfg 配置。

```bash
# 以在 Home 目录下创建虚拟环境为例

# 创建 ~/.venvs 目录，如果之前没有创建的话
mkdir -p ~/.venvs

# 创建虚拟环境（大家也可以选择用 virtualenv）
python3 -m venv ~/.venvs/fuo

# 激活虚拟环境
source ~/.venvs/fuo/bin/activate

# 安装项目依赖
pip3 install -e .
```

--------------------------------

### Create a text-based playlist in library.fuo

Source: https://feeluown.readthedocs.io/en/latest/_sources/features.rst.txt

Copy these lines into ~/.FeelUOwn/collections/library.fuo and restart FeelUOwn to see the playlist. Each line is a fuo:// URI with a comment showing the song title and artist.

```text
fuo://netease/songs/16841667  # No Matter What - Boyzone
fuo://netease/songs/65800     # 最佳损友 - 陈奕迅
fuo://xiami/songs/3406085     # Love Story - Taylor Swift
fuo://netease/songs/5054926   # When You Say Noth… - Ronan Keating
fuo://qqmusic/songs/97773     # 晴天 - 周杰伦
fuo://qqmusic/songs/102422162 # 给我一首歌的时间 … - 周杰伦,蔡依林
fuo://xiami/songs/1769834090  # Flower Dance - DJ OKAWARI
```

--------------------------------

### 注册、获取、列出和搜索资源提供方

Source: https://feeluown.readthedocs.io/en/latest/media_assets_management/library.html

音乐库模块提供通用接口来管理资源提供方。使用 library.register(provider) 注册提供方，library.get(provider.identifier) 获取实例，library.list() 列出所有提供方，library.search('linkin park') 搜索关键词。

```python
# 注册一个资源提供方
library.register(provider)

# 获取资源提供方实例
provider = library.get(provider.identifier)

# 列出所有资源提供方
library.list()

# 在音乐库中搜索关键词
library.search('linkin park')

```

--------------------------------

### Ubuntu 安装 FeelUOwn 完整步骤

Source: https://feeluown.readthedocs.io/en/latest/_sources/quickstart.rst.txt

在 Ubuntu 18.04 上安装 FeelUOwn 的完整命令序列，包括安装 Python、pipx、libmpv、PyQt6、dbus-python，以及生成桌面图标。

```sh
# 安装 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

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

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

# 安装 feeluown （是一个 Python 包）
# --upgrade 代表安装最新版，--user 代表不安装到系统目录
pipx install 'feeluown[battery,cookies,webengine,ai]'
pipx inject feeluown pyopengl

# 运行 feeluown -h 来测试安装是否成功
# 如果提示 Command Not Found，请检查 pipx 的 PATH 配置
feeluown -h

# 生成桌面图标
feeluown-genicon

# （可能还需要安装）使用 fcitx 输入法的用户可能需要安装
# 否则有可能不能在 GUI 中切换输入法
sudo apt-get install fcitx-frontend-qt5
```

--------------------------------

### Response header format

Source: https://feeluown.readthedocs.io/en/latest/protocol.html

Shows the response header format for success and failure, including an example response.

```text
# 成功
ACK ok {length} #: more,json
{body}

# 失败
ACK oops {length}
{err_type}: {err_msg}

# 示例
ACK ok 0
```

--------------------------------

### Complex resource identifier example

Source: https://feeluown.readthedocs.io/en/latest/protocol.html

Shows a possible future format for resource identifiers with complex descriptions, using a here-document style.

```text
fuo://{provider}/songs/{identifier} <<EOF
  title:     hello world
  artist:    fuo://{provider}/artists/{identifier}  # {name}
  album:     fuo://{provider}/artists/{identifier}  # {album_name}-{artists_name}
  duration:  123.01
  url:       http://xxx/yyy.mp3
EOF
```

--------------------------------

### 使用 netcat 连接 fuo 服务

Source: https://feeluown.readthedocs.io/en/latest/_sources/protocol.rst.txt

当 feeluown 以默认参数启动时，会启动一个监听 23333 端口的 TCP 服务。使用 netcat 连接该端口，服务端会返回 'OK feeluown 1.0.0'。

```sh
~ > nc localhost 23333
OK feeluown 1.0.0
```

--------------------------------

### TaskManager.get_or_create(name, kind=TaskKind.preemptive)

Source: https://feeluown.readthedocs.io/en/latest/_modules/feeluown/task.html

Gets a task specification by name, creating it if it does not exist. The kind parameter specifies the task kind (preemptive or cooperative). Returns the task specification.

```APIDOC
## TaskManager.get_or_create(name, kind=TaskKind.preemptive)

### Description
Gets a task specification by name, creating it if it does not exist. The kind parameter specifies the task kind.

### Method
Method

### Signature
`get_or_create(self, name, kind=TaskKind.preemptive)`

### Parameters
- **name** (str) - Required - The task identifier (name).
- **kind** (TaskKind) - Optional - The kind of task, default is `TaskKind.preemptive`.

### Returns
- **PreemptiveTaskSpec** - The task specification.

### Example
```python
task_spec = task_mgr.get_or_create('unique-name', TaskKind.preemptive)
```
```

--------------------------------

### 安装 libmpv 和 pipx（macOS/Ubuntu）

Source: https://feeluown.readthedocs.io/en/latest/_sources/quickstart.rst.txt

使用系统包管理器安装 libmpv 和 pipx，为后续安装 FeelUOwn 做准备。

```sh
# macOS
brew install mpv pipx

# Ubuntu
sudo apt-get install libmpv1 pipx
```

--------------------------------

### 以 debug 模式启动 feeluown

Source: https://feeluown.readthedocs.io/en/latest/_sources/dev_quickstart.rst.txt

使用 --debug 选项启动 feeluown，以便进行调试。运行 feeluown -h 可查看更多选项。

```bash
# 运行 feeluown -h 查看更多选项
feeluown --debug
```

--------------------------------

### feeluown.fuoexec.source

Source: https://feeluown.readthedocs.io/en/latest/_sources/fuorc.rst.txt

Executes a source string in the fuorc context.

```APIDOC
## feeluown.fuoexec.source

### Description
Executes a source string in the fuorc context.

### Method
Function

### Signature
`feeluown.fuoexec.source(source)`

### Parameters
- **source** (str) - Required - The source code to execute.

### Returns
None

```

--------------------------------

### NetEase search API album response

Source: https://feeluown.readthedocs.io/en/latest/research.html

Example of the album object returned by NetEase Cloud Music's search API. It lacks the album cover URL, songs, and complete artist information, which motivates the design discussion about abstracting resource providers.

```json
"album": {
    "artist": {
        "id": 0,
        "alias": [],
        "img1v1": 0,
        "name": "",
        "picUrl": null,
        "picId": 0,
    },
    "id": 2960228,
    "name": "\u5218\u5fb7\u534e Unforgettable Concert 2010",
    "picId": 2540971374328644,
    ...
}

```

--------------------------------

### 克隆 FeelUOwn 仓库

Source: https://feeluown.readthedocs.io/en/latest/_sources/dev_quickstart.rst.txt

使用 SSH 方式克隆自己 fork 的 FeelUOwn 仓库到本地。

```bash
git clone git@github.com:username/FeelUOwn.git
```

--------------------------------

### 使用 NetCat 连接 FeelUOwn Daemon

Source: https://feeluown.readthedocs.io/en/latest/_sources/quickstart.rst.txt

通过 NetCat 工具连接 FeelUOwn Daemon 端口，输入命令查看播放器状态或播放音乐。

```sh
nc localhost 23333
# 输入 `status` 命令，可以查看播放器状态
# 输入 `fuo play fuo://netease/songs/470302665` 可以播放音乐
```

--------------------------------

### openSUSE Tumbleweed 安装 FeelUOwn

Source: https://feeluown.readthedocs.io/en/latest/_sources/quickstart.rst.txt

以 root 用户运行命令，添加仓库并安装 feeluown。

```sh
zypper addrepo https://download.opensuse.org/repositories/home:weearcm/openSUSE_Tumbleweed/home:weearcm.repo
zypper refresh
zypper install --recommends feeluown
```

--------------------------------

### FeelUOwn 协议多行文本格式

Source: https://feeluown.readthedocs.io/en/latest/_sources/protocol.rst.txt

展示多行文本的格式，类似于 bash here document。document 是命令的参数，这种命令只能接收一个参数。

```text
{cmd} [{options}]  #: {req_options} <<EOF
document
EOF
```
Tokens:
Raw