README.zh-CN.md

koishi-plugin-ffxiv-macrodict

English | 简体中文

koishi 的插件，用于搜索并显示著名 MMORPG 网络游戏 最终幻想 XIV (Final Fantasy XIV，FFXIV) 的文本指令信息。

• 功能与用法
  • 搜索指令的描述
  • 手动更新数据
• 安装
  • 插件市场
  • 手动安装
• 注意
• 配置
• 翻译
• 许可证

功能与用法

搜索指令的描述

使用 macrodict <指令名> 搜索文本指令信息。

实例：

macrodict target
# 也可以识别中文的文本指令
macrodict 目标
# 也可以识别以 / 开头的文本指令
macrodict /target

输出其他语言版本的描述

使用 -l <语言代码> 或 --lang <语言代码> 指定输出的语言版本。可选值有：

• en：英文
• ja：日文
• de：德文
• fr：法文
• zh：简体中文
• ko：韩文

若没有指定语言，则默认以当前频道的语言输出，或回退到英文 en。

实例：

macrodict -l en target

安装

插件市场

如果你通过 Koishi 模板项目创建了你的机器人，你可以直接在插件市场安装名为 koishi-plugin-ffxiv-macrodict 的插件。你可能还需要安装 koishi-plugin-puppeteer 才能启用本插件。

你可以需要参考安装和配置插件的说明添加此插件到你的机器人中。

手动安装

首先，你需要安装 nodejs 以及任意一个包管理器，如 yarn 或 npm。

# 建议使用 `yarn`
$ yarn add koishi-plugin-ffxiv-macrodict
# 但是你也可以使用 `npm`
$ npm install --save koishi-plugin-ffxiv-macrodict

配置

该插件公开以下配置：

export interface MacroDictConfig {
  aliases?: string[]
  defaultLanguage?: 'en' | 'de' | 'fr' | 'ja' | 'ko' | 'chs'
  fetchOnStart?: boolean
}

翻译

本插件支持多语言。

若您想要贡献翻译，请注册 Crowdin 并在项目 hatsushimo 的 macrodict 文件夹中贡献翻译。

许可证

本插件遵循 MIT license 许可协议。

FINAL FANTASY、最终幻想是株式会社史克威尔艾尼克斯的注册商标。所有来自 FINAL FANTASY XIV 的宏描述数据均未作任何修改。

FINAL FANTASY XIV © 2010 - 2022 SQUARE ENIX CO., LTD. All Rights Reserved.