The project's README from github.com/huanfeng/WindInput. As one markdown file: README.md.
轻量、快速、可定制的开源中文输入法
前往 windinput.com/download 下载对应平台的安装包:
Win + Space 切换到清风输入法.pkg 通用安装包(Apple Silicon / Intel),安装后在
「系统设置 → 键盘 → 文本输入 → 编辑」中添加清风输入法,再从输入法菜单切换.deb 安装包(amd64 / arm64,Ubuntu 22.04+、Debian 系发行版),以
Fcitx5 输入法引擎的形式工作;sudo apt install ./WindInput-*.deb 安装后,在「Fcitx5 配置」中
把清风输入法加入输入法列表。系统输入法框架需为 Fcitx5,KDE Plasma 等桌面的额外设置与已知限制见
wind_linux/README.mdWindows 版的程序文件与安装包已做数字签名;SmartScreen 需要下载量积累信誉,新版本发布初期 仍可能拦截,按提示「更多信息 → 仍要运行」继续即可。macOS 版尚未做苹果签名与公证,被 Gatekeeper 拦下时到「系统设置 → 隐私与安全性」放行。
完整的使用说明、配置参考和常见问题都在文档站:windinput.com/docs
本仓库包含清风输入法的核心部分:
| 组件 | 技术 | 职责 |
|---|---|---|
wind_input |
Rust | 核心服务:输入引擎、词库、候选管理、UI 渲染、IPC(跨平台) |
wind_tsf |
C++ | Windows TSF 输入法框架接口,键盘事件捕获 |
wind_macos |
Swift | macOS IMKit 输入法客户端 |
wind_linux |
C++ | Linux Fcitx5 addon(预览版,见 wind_linux/README.md) |
发布版安装包还需要以下配套项目,它们在各自的独立仓库中维护:
| 仓库 | 技术 | 职责 | 开源状态 |
|---|---|---|---|
| wind-installer | Rust | Windows 安装器与卸载器(清单驱动的通用打包器) | 已开源 |
| wind-portable | Rust | Windows 便携版(绿色版)启动器,免安装就地运行 | 已开源 |
| wind-ui-rust | Rust | 跨平台轻量 GUI 库,安装器 / 便携版 / 设置程序的界面基础 | 已开源 |
| wind-setting | Rust | 图形设置程序 | 已开源 |
其中 wind-installer 与 wind-portable 只用于 Windows;macOS 的 .pkg 安装包由本仓库的
scripts/mac/dev.sh pkg 直接打包,Linux 的 .deb 由 scripts/linux/package-deb.sh 打包,均无需额外仓库。
这些配套项目都是可选的:与本仓库放在同级目录时构建脚本会一并构建,缺失则自动跳过, 核心输入法本身可独立构建和运行。完整成品请从下载页获取。
wind-installer 与 wind-portable 通过 crates.io 上发布的 windui 使用 GUI 库,无需本地检出
wind-ui-rust;只有 wind-setting 是 path 依赖(windui = { path = "../wind-ui-rust" }),
构建它时才需要把 wind-ui-rust 一并放到同级目录。
.\scripts\dev.ps1scripts/mac/dev.shscripts/dev.sh构建脚本会自动下载第三方词库数据并生成完整的数据目录。详细说明见 贡献指南。
欢迎贡献代码、报告 Bug 或提出建议!请阅读 贡献指南。
首次提交 PR 需要签署 贡献者许可协议 (CLA)。
清风输入法在设计与实现过程中参考了许多优秀的开源输入法项目, 它们的思路、文档与源码为本项目提供了重要的指引,在此一并致谢:
上述项目均为独立作品,本项目仅作实现参考,未复制其源代码; 数据来源部分适用各自的许可证条款,详见 NOTICE.md。
本项目源代码自 v0.127.0 起采用 GNU 通用公共许可证第 3 版或更高版本(GPL-3.0-or-later)。 v0.127.0 之前发布的版本仍适用其发布时的 MIT 许可证。
基于本项目修改并分发的作品须同样以 GPL-3.0 发布并提供完整源代码。
词库数据来源于 白霜拼音、极点五笔、 pinyin-data、OpenCC 等第三方项目,适用各自的许可证条款,完整声明详见 NOTICE.md。
GPL 许可证授予您使用、修改与分发源代码的权利,但不包括使用项目名称与标识的权利。
若您将本项目分支后公开发布,请更换项目名称与 logo,并注明为非官方分支, 以便用户区分软件的实际维护者。
本项目未注册商标,上述为约定与请求而非法律条款, 详见 项目名称与标识使用约定。