CyIME README

The project's README from github.com/Cyletix/CyIME. As one markdown file: README.md.

CyIME

English · 繁體中文

CyIME 是 Cyletix 开发维护的 Android 输入法,基于 Rime 引擎,从 Xime fork 而来。中文拼音、双拼、五笔、笔画、仓颉、注音,日语、英文、西班牙语,手写、语音、拍照识字都在本机完成,另有给听障人士用的实时字幕。

下载与安装

要求 Android 9.0(API 28)及以上,安装包只有 ARM64。

  1. 在 Releases 下载安装包,两个包源码相同,只差带不带离线模型:
    • 轻量版 CyIME-<版本>-arm64-v8a.apk:不带语音、手写、联想模型,需要时在「扩展 › 模型」下载。
    • 完整版 CyIME-<版本>-full-arm64-v8a.apk:内置 SenseVoice 语音、手写、声纹、联想模型和九键词组模型,装上就能离线用。边说边出字的 Paraformer 不内置,需要时在应用里下载。
  2. 安装后在系统设置里启用 CyIME,并把它设为当前输入法。
  3. 以后在「设置 › 关于 › 检查更新」更新,会下载和现在同一种(轻量/完整)的安装包交给系统安装。

带谷歌服务的手机(三星、海外版机型等)从 2027 年起安装未在谷歌登记的应用要先开一次「高级安装」,国行手机和 adb 安装不受影响,见 谷歌开发者验证与安装。

从旧版 com.kingzcheung.xime 迁移:安装身份已独立为 com.cyletix.cyime,系统当作新应用,可以并存,旧版数据不会自动继承。

功能

下面写「默认关」的功能要在设置里自己打开。

中文

其他语言

手写、语音、识字

字幕

键盘与外观

剪贴板与同步

设置

构建

# 克隆项目(含子模块)
git clone --recursive https://github.com/Cyletix/CyIME.git

# 已克隆过则初始化子模块
git submodule update --init --recursive

# 调试包 / 发布包
./gradlew assembleDebug
./gradlew assembleRelease

需要 JDK 17 和 NDK 29.0.14206865。构建时会联网下载雾凇拼音、日语词库、笔画、仓颉码表和 sherpa-onnx 运行库,按记录的 SHA-256 校验后打进安装包。日常出包用仓库根目录的 packager.cmd(双击打开图形界面,带参数是命令行),预设见 scripts/packager/config.json;版本规则见 打包与版本规则。

技术栈:Kotlin · Jetpack Compose · Material 3 · librime(JNI / C++)· ONNX Runtime · sherpa-onnx · OpenCV

项目关系

贡献

见 CONTRIBUTING.md:先提 Issue,再提最小修改的 PR。

鸣谢

CyIME 用到了下面这些项目、数据和模型,感谢作者们的工作。安装包里的许可证全文和版权声明见 app/src/main/assets/NOTICE.txt、app/src/main/assets/licenses/ 和各方案目录下的 NOTICE 文件;应用里在「设置 › 关于 › 鸣谢」和「开源许可证」。

上游

项目 作者 用在哪里 许可证
Xime Kingz Cheung(kingzcheung)及贡献者 CyIME 的起点:界面框架、Rime 接入、九键 librime-t9、插件系统、手写与联想 GPL-3.0
rime-wubi(fork 自 KyleBing/rime-wubi86-jidian) kingzcheung;KyleBing 内置五笔 86 方案和手写的五笔反查 Apache-2.0
Xime 模型:ochwpro、predictive-text-small、predictive-text-base Xime 项目 中文手写识别;智能联想 ochwpro MIT;small Apache-2.0;base CC BY-NC-SA 4.0

输入引擎

项目 作者 用在哪里 许可证
librime(经 ximeiorg/librime) 佛振(lotem)及 Rime 社区 输入引擎 BSD-3-Clause
librime-lua hchunhui 方案里的 Lua 脚本 BSD-3-Clause
librime-octagram 佛振(lotem) 九键语法模型 GPL-3.0
librime-predict Rime 联想 BSD-3-Clause
OpenCC BYVoid(Carbo Kuo) 简繁转换 Apache-2.0
Boost、glog、yaml-cpp、LevelDB、marisa-trie、Snappy 各自作者 librime 依赖 BSL-1.0、BSD-3-Clause、MIT、BSD-3-Clause、BSD-2-Clause 或 LGPL-2.1、BSD-3-Clause

词库与码表

项目 作者 用在哪里 许可证
雾凇拼音 rime-ice iDvel(Dvel) 全拼、小鹤双拼、九键、14 键的词库和方案 GPL-3.0
RIME-LMDG(万象语言模型) amzxyz 九键语法增强模型(可下载) CC BY 4.0
rime-stroke 四季的風、雪齋、Kunki Chou、宋天 笔画方案 LGPL-3.0
Cangjie5 Jackchows;倉頡之友·馬來西亞 仓颉五代码表 MIT
rime-cangjie、rime-bopomofo Rime 仓颉、注音方案的写法参照 LGPL-3.0
小麦注音 McBopomofo OpenVanilla 台湾词、读音和词频(注音、繁体输出、仓颉排序) MIT
rime-jaroomaji lazy fox chan 日语方案和词库 Apache-2.0;词库各自保留原许可:Mozc(BSD 风格)、JMdict / KANJIDIC2(EDRDG,CC BY-SA 4.0)
搜狗细胞词库 搜狗输入法及词库作者 应用内下载的分类词库,文件直接从搜狗下载 版权归原作者
rime-wubi98 cz-archive 五笔 98(应用内下载) GPL-3.0
ECDICT skywind3000(Linwei) 候选释义:英→中 MIT
CC-CEDICT MDBG 候选释义:中→英 CC BY-SA 4.0
opus-mt-zh-en Helsinki-NLP 释义里常见短语的参考译文(在电脑上离线生成) CC BY 4.0
FrequencyWords Hermit Dave 西班牙语补全词表 代码 MIT;词表 CC BY-SA 4.0
ChaiPUA 字体 谭淞宸(tansongchen) 显示五笔字根等扩展区字符(随 Xime 带入) 字体内未标明

语料(训练 CyIME 自己的模型)

语料 作者 用在哪里 许可证
LCCC(Large-scale Cleaned Chinese Conversation) 清华大学 CoAI 小组 九键词组模型、联想底表、26 键常用词词频 MIT
OpenSubtitles(OPUS) opensubtitles.org;OPUS 九键词组模型的字幕口语部分 未标明
Natural Language Corpus Data Peter Norvig 英文滑行的词频和词对频率 MIT
Cornell Movie-Dialogs Corpus Cristian Danescu-Niculescu-Mizil、Lillian Lee 英文滑行的口语词对 研究用公开数据
MathWriting Google 训练公式手写模型 CC BY-NC-SA 4.0

语音、识字与推理

项目 作者 用在哪里 许可证
sherpa-onnx k2-fsa(新一代 Kaldi) 语音识别、断句、声纹运行库,以及各语音模型的 ONNX 导出 Apache-2.0
ONNX Runtime Microsoft 手写、联想、识字等模型推理 MIT
Silero VAD Silero 语音断句 MIT
SenseVoice 阿里巴巴 FunAudioLLM 语音识别(多语言、整句定稿) FunASR 模型许可(需署名、保留模型名)
Paraformer 阿里巴巴达摩院 FunASR 中英流式语音识别 Apache-2.0
Zipformer 中文 k2-fsa 中文流式语音识别 Apache-2.0
X-ASR zh-en GilgameshWind 中文整句定稿(可下载) Apache-2.0
ReazonSpeech k2 v2 Reazon Research 日语语音识别 Apache-2.0
3D-Speaker CAM++ 阿里巴巴 3D-Speaker 字幕区分说话人 Apache-2.0
PaddleOCR PP-OCRv5、RapidOCR PaddlePaddle;RapidAI 拍照识字模型及其 ONNX 版本 Apache-2.0
OpenCV OpenCV 拍照识字的图像处理 Apache-2.0
KaTeX KaTeX 作者 显示手写公式 MIT
UER-py 中文 RoBERTa UER 团队 九键整句打分(已停用,词表仍在包里) Apache-2.0

Android 库

Kotlin、Jetpack Compose 与 AndroidX(含 CameraX、Room)、Material Components、OkHttp、Coil、kaml、kotlinx.serialization、ZXing(配对二维码)、exp4j(计算器)、Apache Commons Compress 均为 Apache-2.0;LuaJ(插件运行时)MIT;sora-editor(方案文件编辑器)LGPL-2.1。

设计参考

CyIME 的交互、外观和键位参考过下面这些产品和方案:

许可证

GPLv3。上游代码版权归其作者所有,本分支的修改由 Cyletix 维护。"Xime" 名称、Logo 及其他品牌资产不属于 GPLv3 授权范围,详见 TRADEMARKS.md。第三方组件、数据和模型按各自的许可证分发,见上面的鸣谢和 app/src/main/assets/NOTICE.txt。注意智能联想 base 模型(CC BY-NC-SA 4.0)和公式手写模型(训练数据 MathWriting 为 CC BY-NC-SA 4.0)不能用于商业用途。

CyIME (Cyletix/CyIME)

Searching Database…

253 ·GitHub

txt、app/src/main/assets/licenses/ 和各方案目录下的 NOTICE 文件;应用里在「设置 › 关于 › 鸣谢」和「开源许可证」。

Creator
Cyletix
Size
135.7 MB
Stars
253
Age
1mo
Commits · 90 Days