Skip to content

odd256/rime_auto_deploy

Repository files navigation

Rime Auto Deploy

一款基于 Python 的 Rime 输入法自动化部署工具。旨在为 Windows、macOS 和 Linux 用户提供一键式的 Rime 安装、配置及皮肤美化体验。


🌟 特性

  • 全平台支持: 适配 Windows (小狼毫)、macOS (鼠须管) 及 Linux (fcitx5-rime)。
  • 基础配置源可选: 支持 雾凇拼音 (Rime-Ice)白霜拼音 (Rime-Frost)
  • 薄荷皮肤适配: 预设参考自 Oh-my-rime 的亮/暗模式皮肤,支持系统主题自动切换。
  • 自定义配置管理:
    • 支持本地 custom_config/ 目录同步,方便维护个人习惯。
    • 环境感知: 同步时自动过滤非当前平台的配置文件(如 Windows 下忽略 squirrel.custom.yaml)。
    • 方案注入: 自动在 default.custom.yaml 中注入所选输入方案,并为每个方案开启“默认英文”状态。
  • 扁平化菜单: 所有功能一目了然,无子菜单嵌套。
    • 一键安装: 新手友好的全自动安装流程。
    • 更新上游配置: 拉取最新上游仓库,自动保留用户词典和自定义配置。
    • 同步自定义配置: 一键同步本地 custom_config/ 到 Rime。
    • 修改配置源和方案: 随时切换雾凇/白霜、全拼/双拼等。
  • 状态持久化: 自动记录偏好,后续操作无需重复选择。

🚀 快速开始

前提条件

  • 已安装 Python (推荐 3.8+)。
  • 推荐使用 uv 进行管理。

运行步骤

  1. 克隆项目:

    git clone https://github.com/your-username/rime-auto-deploy.git
    cd rime-auto-deploy
  2. 安装依赖并运行:

    • 使用 uv:
      uv sync
      uv run main.py
    • 使用 pip:
      pip install -r requirements.txt
      python main.py
      
      
  3. 菜单功能详解:

    • [1] 一键安装(首次使用): 自动完成安装、备份、基础配置下载及自定义同步。
    • [2] 更新上游配置: 从 GitHub 拉取最新上游仓库配置,自动保留用户词典、自定义配置和学习记录。
    • [3] 同步自定义配置: 修改本地 custom_config/ 后,使用此项快速推送到 Rime 目录并重新部署。
    • [4] 修改配置源和方案: 重新选择配置源(雾凇/白霜)或切换输入方案(全拼/双拼等)。

🛠️ 自定义配置

您可以将自己的 .yaml 配置文件放入 custom_config/ 目录。

  • 皮肤设置: 修改 weasel.custom.yaml (Windows) 或 squirrel.custom.yaml (macOS)。脚本会自动根据您的系统选择性同步。
  • 个人习惯: 修改 default.custom.yaml (脚本会自动为您同步并注入选定的输入方案)。
  • 默认英文: 脚本会自动为每个启用的方案生成 .custom.yaml 并注入 switches/@0/reset: 1,确保初始切换到该方案时为英文模式。

🤝 致谢

本项目在开发过程中参考并集成了以下优秀开源项目:


📄 开源协议

MIT License

About

一个 rime 输入法配置工具,如果能帮到你,记得点个star~

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages