Rime-Forge 项目启动与配置教程

Rime-Forge 项目启动与配置教程

rime-forge 文正坊 - 中州韵 Rime 输入法私房菜 项目地址: https://gitcode.com/gh_mirrors/ri/rime-forge

1. 项目目录结构及介绍

Rime-Forge 是一个基于 Rime 输入法的开源项目，其目录结构如下：

rime-forge/
├── dict/                # 字典文件目录
├── lua/                 # Lua 脚本目录
├── opencc/              # OpenCC 拼音转换工具配置文件
├── .gitignore           # Git 忽略文件
├── LICENSE              # 项目许可证文件
├── README.md            # 项目说明文件
├── correction_comment.yaml # 校对注释配置文件
├── custom_phrase.txt    # 自定义短语文件
├── custom_phrase.yaml   # 自定义短语配置文件
├── default.custom.yaml  # 默认自定义配置文件
├── default.yaml         # 默认配置文件
├── double_pinyin.schema.yaml # 双拼方案配置文件
├── double_pinyin_abc.schema.yaml # 双拼方案配置文件
├── double_pinyin_flypy.custom.yaml # 双拼方案自定义配置文件
├── double_pinyin_flypy.schema.yaml # 双拼方案配置文件
├── double_pinyin_mspy.schema.yaml # 双拼方案配置文件
├── double_pinyin_pyjj.schema.yaml # 双拼方案配置文件
├── emoji_suggestion.yaml # 表情建议配置文件
├── essay.txt            # 示例文本文件
├── grammar.yaml         # 语法配置文件
├── ibus_rime.custom.yaml # ibus-rime 输入法自定义配置文件
├── key_bindings.yaml    # 快捷键绑定配置文件
├── lua_charset_filter.yaml # Lua 字符集过滤配置文件
├── luna_pinyin.custom.yaml # 拼音方案自定义配置文件
├── luna_pinyin.dict.yaml # 拼音字典配置文件
├── luna_pinyin.extended.dict.yaml # 拼音扩展字典配置文件
├── luna_pinyin.schema.yaml # 拼音方案配置文件
├── luna_pinyin_fluency.schema.yaml # 拼音流畅性配置文件
├── luna_pinyin_simp.schema.yaml # 简体拼音方案配置文件
├── luna_pinyin_zh_tw.schema.yaml # 繁体拼音方案配置文件
├── luna_quanpin.schema.yaml # 全拼方案配置文件
├── pinyin.yaml           # 拼音配置文件
├── punctuation.yaml     # 标点符号配置文件
├── rime.lua             # Rime 主配置脚本
├── stroke.dict.yaml     # 笔画字典配置文件
├── stroke.schema.yaml   # 笔画方案配置文件
├── symbols.yaml         # 符号配置文件
├── symbols_punctuator.yaml # 符号标点配置文件
├── terra_pinyin.custom.yaml # 地球拼音自定义配置文件
├── terra_pinyin.dict.yaml # 地球拼音字典配置文件
├── terra_pinyin.extended.dict.yaml # 地球拼音扩展字典配置文件
├── terra_pinyin.schema.yaml # 地球拼音方案配置文件
├── terra_pinyin_flypy.custom.yaml # 地球拼音自定义配置文件
├── terra_pinyin_flypy.schema.yaml # 地球拼音方案配置文件
├── weasel.custom.yaml   # 小鹤双拼自定义配置文件
├── zh-hant-t-essay-bgc.gram # 繁体中文语法配置文件
├── zh-hant-t-essay-bgw.gram # 繁体中文语法配置文件

每个目录和文件都有其特定的用途，例如 dict/ 目录包含了项目的字典文件，lua/ 目录包含了 Lua 脚本，而 default.yaml 是项目的默认配置文件。

2. 项目的启动文件介绍

项目的启动主要通过 rime.lua 文件进行配置。这个文件是 Rime 输入法的核心配置文件，它负责初始化输入法引擎，并加载其他配置文件。

以下是 rime.lua 文件的基本结构：

-- 初始化 Rime 输入法引擎
rime.init()

-- 加载其他配置文件
rime.load("default.yaml")

-- 根据需要加载其他自定义配置
rime.load("custom_phrase.yaml")

在实际使用中，你需要根据具体的输入法引擎（如 Weasel、ibus-rime 或 Squirrel）对 rime.lua 进行相应的修改和配置。

3. 项目的配置文件介绍

项目的配置主要通过 default.yaml 文件进行。这个文件包含了输入法的基本设置，如输入方案、词库、标点符号、表情建议等。

以下是一个 default.yaml 文件的基本配置示例：

input_method:
  - name:明月拼音
    schema: luna_pinyin
  - name:小鹤双拼
    schema: double_pinyin

在这个配置中，定义了两个输入方案：明月拼音和小鹤双拼。每个方案都指定了一个拼音方案 schema。

此外，还有许多其他配置选项可以调整，包括但不限于：

• custom_phrase: 自定义短语配置
• dictionary: 词典配置
• punctuation: 标点符号配置
• symbols: 符号配置
• emoji: 表情建议配置

您可以根据自己的需求修改这些配置项，以达到最佳的输入体验。

rime-forge 文正坊 - 中州韵 Rime 输入法私房菜 项目地址: https://gitcode.com/gh_mirrors/ri/rime-forge