LookupPlugin

Look Up Plugin

This unofficial TaleSpire allows the chat to be used to look up local and/or remote information using topic find or

keyword(s) find with the results of the search displayed in the chat.

This plugin, like all others, is free but if you want to donate, use:

Change Log

1.3.0: LookupEngine ignores HTML tags (and inside content) on the command line

1.3.0: LocalFileprovider renamed to be alphabetically first (thus able to override other providers)

1.3.0: Removed legacy version of LookupEngine

1.2.2: Fixed local provider to support rich text elements (e.g. size and color).

1.2.1: Fixed local provider. No plugin or engine change.

1.2.0: Added support for Whisper

1.2.0: Replace LookupEngine with Browser Control based solution to allow nagivating pages like DndBeyond

1.2.0: Warning: Breaking for providers. Need to make small update. See below.

1.1.5: Updated for compatibility with udpated Chat Service plugin.

1.1.2: Removed dependency on Extra Asset Library. No plugin change.

1.1.1: Switched local files to use txt extension to prevent conflict with EAR (thinking the files are asset bundles)

1.1.0: Added support for providers which can get data from websites

1.0.0: Initial release

Install

Use R2ModMan or similar installer to install this plugin.

Usage

The plugins adds 3 chat operations:

`/lu topic` (Look Up): Displays the related topic. The topic given must match a topic file for the search to succeed.

`/fd keywords` (Find): Display the first topic which contains the keyword or keywords.

`/fa keywords` (Find All): Display all topics which contains the keyword or keywords.

Note: If multiple keywords are provdied then they must appear in the order given. For example "healing spell" will find

only references of "healing spell" and not just "healing" or just "spell" or even "spell of healing".

Note: Topic look ups must match exactly but they are not case sensitive. Find looks ups are case sensitive.

The find requests can only be used with local content. The lookup request, on the other hand, can use one or more provides

to look up the information. The first provider to have the information is used.

If the user has the Chat Whisper plugin then the results can be whispered using:

`/w name /lu keywords such as /w LordAshes /lu fireball`

Note: To use Lookup Plugin with Chat Whisper the Chat Whisper suffix needs to be configure to either be blank (in which case

it will not be possible to identify which chat messages were whispered) or needs to start with a chat supported html tag

such as `(Whisper) or (Whisper)`. With the latest Lookup Plugin code, any HTML

tags and their contents are ignored when looking for lookup keywords. This means starting the Chat Whisper suffix with an

html tag will cause the whisper suffix to be ignore when the content is passed to the lookup engine.

Providers

Providers dictate how the look up function obtains data. Each provider is a different source of data and has its own set

of rules for extrating and formatting the data. The LookUp Plugin comes with two providers, a local files provider and

a DnD Beyond provider for spells.

Demo Content

You can do a look up for Firebolt locally.

You can look up most 5E SRD spells using the sample D&D Beyond provider.

Note: Firebolt is one work in the local version but two words (Fire bolt) on DnD Beyond.

How It Works

The LookUp plugin, when doing a lookup, calls the LookupEngine.exe which goes through the different providers, one by one,

until one of them provides content for the search. The LookUpEngine dumps the results to the console which the Lookup Plugin

grabs and writes to the Chat. You can test the LookUpEngine from the command line by running it with the search keys words

as the command line parameters. This can be useful when testing provider scripts.

Creating Local Content

Currently, content must be placed in the `CustomData/Sources` sub-folder of this plugin. To create content files, create

a