Flashfocus 项目使用教程

1. 项目目录结构及介绍

Flashfocus 项目是一个为平铺窗口管理器提供简单焦点动画的开源项目。项目的目录结构如下：

• bin/: 存放可执行脚本。
• demo/: 包含演示相关的内容。
• scripts/: 包含项目运行所需的脚本。
• src/: 项目源代码所在的目录。
• tests/: 包含项目的测试代码。
• .github/: 存放 GitHub 专用的配置文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• CHANGELOG.md: 记录项目历史版本的更改日志。
• CONTRIBUTING.md: 提供项目贡献指南。
• Dockerfile: 用于构建 Docker 容器的配置文件。
• LICENSE: 项目的许可证文件。
• MANIFEST.in: 用于构建项目包时包含特定的文件和目录。
• Makefile: 用于构建项目的 Makefile 文件。
• README.md: 项目的自述文件，包含项目介绍和使用说明。
• flashfocus.service: 用于在系统中设置 Flashfocus 为服务。
• pyproject.toml: 项目构建和打包的配置文件。

2. 项目的启动文件介绍

项目的启动主要是通过在窗口管理器的配置文件中添加启动命令来实现。例如，在 i3 窗口管理器中，你需要在配置文件中添加以下内容来启动 Flashfocus：

exec_always --no-startup-id flashfocus

此外，项目中提供了一个 flash_window 脚本，该脚本可以通过绑定快捷键来触发当前窗口的闪烁效果。例如，在 i3 中绑定 mod+n 快捷键来执行此脚本：

bindsym $mod+n exec --no-startup-id flash_window

3. 项目的配置文件介绍

Flashfocus 的配置文件用于自定义焦点动画的行为。配置文件可以放在以下位置：

• $XDG_CONFIG_HOME/flashfocus/flashfocus.yml
• ~/.config/flashfocus/flashfocus.yml
• ~/.flashfocus.yml

配置文件支持多种自定义选项，包括窗口特定的闪烁定制。当首次运行 Flashfocus 时，它会在上述位置之一创建一个默认的配置文件。

以下是配置文件的一个示例：

# Flashfocus 配置文件示例

# 全局设置
global:
  opacity: 0.8  # 焦点窗口的不透明度
  duration: 0.5  # 焦点动画的持续时间（秒）

# 窗口特定的设置
window:
  - class: "term"
    opacity: 0.9  # 特定窗口类的不透明度
    duration: 1.0  # 特定窗口类的动画持续时间

请确保在修改配置文件后重新启动 Flashfocus，以使更改生效。