Skip to content

Latest commit

 

History

History
105 lines (71 loc) · 3.1 KB

README.md

File metadata and controls

105 lines (71 loc) · 3.1 KB
Raw

koishi-plugin-ffxiv-macrodict

English | 简体中文

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

Features and Usage

Search Text Command Descriptions

Use macrodict <command-name> to search the description of a text command.

Example:

macrodict target
# or use alias
macrodict ta
# or start with /
macrodict /target

Specify Language of Output Description

Use -l <language-code> or --lang <language-code> to specify the language of the output description. Available language codes are:

  • en (English)
  • ja (Japanese)
  • de (German)
  • fr (French)
  • zh (Simplified Chinese)
  • ko (Korean)

If you didn't specify the language code, the plugin will use the language code of the current channel, or fallback to English en.

Example:

macrodict -l en target

Install

Market

If you create your Bot project via the Koishi boilerplate, you can install the koishi-plugin-ffxiv-macrodict plugin from the plugin market. As the dependency of the plugin, you may need to install koishi-plugin-puppeteer before enable the plugin.

You can follow the instructions from Install and Configure Plugins to add the plugin to your Bot.

Manually

First, you should have nodejs and a package manager like yarn or npm installed.

# We recommend to use `yarn`
$ yarn add koishi-plugin-ffxiv-macrodict
# But you can use `npm` if you prefer
$ npm install --save koishi-plugin-ffxiv-macrodict

Configuration

This plugin expose the following configuration:

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

Translation

This plugin supports multiple languages.

To contribute translations, please register a Crowdin and contribute translations to the macrodict folder of the project hatsushimo.

LICENSE

This plugin is licensed under the MIT license.

FINAL FANTASY is a registered trademark of Square Enix Holdings Co., Ltd. All the macro data from FINAL FANTASY XIV is used without any modification.

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