Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

koishi-plugin-ffxiv-macrodict

AwesomeHamster74MIT2.2.1TypeScript support: included

A koishi plugin for searching macro descriptions which is used in the famous video game FFXIV (Final Fantasy XIV)

ffxiv, final-fantasy-xiv, macro, koishi, koishijs, bot, qqbot

readme

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 以及任意一个包管理器,如 yarnnpm

# 建议使用 `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 并在项目 hatsushimomacrodict 文件夹中贡献翻译。

许可证

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

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

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

changelog

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

2.1.0 - 2023-01-05

Added

  • better CJK fonts (#40)

Fixed

  • broken condition in exactly match searching (#28)
  • segment type changed in koishi 4.9 (#32)

Changed

2.0.11 - 2022-09-06

Added

  • add threshold of distance in fuzzy search (#10)
  • upgrade to adapt koishi v4.8 (#9)
  • optimize html rendering (#15)

Changed

  • add default value in config (#12)

Removed

2.0.10 - 2022-07-02

Added

  • add text mode (#7)
  • update translations (fa7e5f3)

Fixed

  • render images should use about_html (311e59c)

2.0.9 - 2022-06-22

Fixed

  • should not throw error on render (6cca70c)

2.0.8 - 2022-06-20

Added

  • support fuzzy search (#15)
  • extract search function to Service (#17)
  • update i18n translations from crowdin (#13)

Fixed

  • update message not found (#19)

2.0.7 - 2022-06-14

Fixed

  • author field in package.json (71a0adf)

2.0.6 - 2022-06-12

Added

  • add koishi field in package.json (b06d4f2)

Changed

  • transform update to class (c0a2706)

Removed

  • remove usage of template (c4f9611)

2.0.5 - 2022-03-12

Added

Changed

  • re-word some command descriptions

Removed

  • remove unused languages

2.0.4 - 2022-04-02

Fixed

  • koishi cannot currently load plugin (2d611f0)

2.0.3 - 2022-04-01

Fixed

  • error occurs in rendering (977eb89)

2.0.2 - 2022-04-01

Added

  • configuration page in koishi console (efb4171)

Fixed

  • remove unused imports, shrink bundle size (7072e4a)

2.0.1 - 2022-01-21

Changed

  • migrate test files to use plugin-mock (2766ee3)

2.0.0 - 2022-01-17

Added

  • add support for koishi v4 (#1)
  • add fetchOnStart option (#1)

Changed

  • migrate axios to koishi built-in ctx.http.get function (#1)

Fixed

  • puppeteer should be read from ctx.puppeteer (#1)
  • update function causes errors (#1)
  • placeholder reconized as html tag which cause macro content not fully displayed (223c306)