Spotlight Omnisearch

A powerful search tool that allows you to search for anything in your game, including documents, compendiums, files, settings and more.

How to use

Spotlight Omnisearch

Spotlight Omnisearch is a powerful tool designed to streamline your search experience. Follow these simple steps to make the most of its features:

• Opening the Omnisearch: Use the shortcut Shift + Space to quickly open the Spotlight Omnisearch window.

• Closing the Omnisearch: To close the Omnisearch, you can either press Escape or click outside the search window (optional, default off).

• Confirming Results: Press Enter to confirm the first search result.

• Executing Actions: For the first or second actions of the first result, use Shift + Enter or Alt + Enter, respectively.

• Filtering Results: You can filter search results by type using the syntax !item or !actor by appending ! before your search query.

• Special Commands: Spotlight Omnisearch offers special commands for various tasks:

  • See the Applets section for more information on how to use applets.

Document Searches

Spotlight Omnisearch

When searching Spotlight Omnisearch will show first documents imported in your world, then it will show documents in compendiums

Special Actions

Some documents will have special actions, for example, Scenes will have Activate and View actions or Journal Entries will have actions to open specific pages.

Filtering

When you search, you will see that each category of result is separated by a line which also contains it's header or category. You can filter using those same words to only show results of that category. In order to filter, you can use the ! character followed by the category name. For example, !scene will only show scenes.

What can I search for?

Spotlight Omnisearch can search for a wide variety of things, including:

Certainly! Here's the updated markdown table with the additional information:

Applets

Spotlight Omnisearch includes many applets that can be used to perform various tasks. To use an applet simply type it's corresponding keyword (listed below) and then the query (if needed) separated by a space.

Calculator

Calculator Applet

To use the calculator applet, you don't need any special keyword, simply type a math expression (e.g. 5 * 3 + (2**5)) and the result will be calculated. Press Enter or click on the result to copy it to your clipboard.

Unit Conversion : You can also convert units by typing 10m to convert 10 meters to feet, for example.

Dice Roller

Dice Roller Applet

• Keywords: roll, r:, r
• Usage: roll 2d6 or r 1d20 + 5

Click on the applet or press Enter to roll the dice and see the result.

Note

Note Applet

• Keywords: note, n:, n
• Usage: note This is a note

Click on the applet or press Enter to save the note. It will be saved in a Journal Entry called Omnisearch Notes [UserName]. A new page will be created for the current Date and every note in that page will be saved with a timestamp.

Timer

Timer Applet

• Keywords: timer, t:, t , time
• Usage: timer 5m or t 1h 30m or time 5 30 or t 30

Click on the applet or press Enter to start the timer. The timer will be always displayed in the Spotlight Omnisearch window if it's running.

Tracker

Tracker Applet

• Keywords: tracker, track, t:
• Usage: No text needs to be added

Click on the success or fail squares to interact with the tracker.

Counter

Counter Applet

• Keywords: counter, c:, c , count
• Usage: No text needs to be added

The Counter will give you 4 separate numbers that you can increase or decrease by clicking on the up/down arrows or typing the number directly.

Module Integration

Splatter

With the Splatter module you get access to the HP related actions: heal, damage, kill, restore

Item Piles

With the Item Piles module you get access to the trade action and special filters for Piles, Merchants and other Item Piles specific actors.

Dfreds Convinient Effects

With the Dfreds Convinient Effects module you can search for DFred effects and click to toggle them on selected tokens.

Dig Down

With the Dig Down module you can search for files indexed by the module and drag images to the canvas.

Developer API

Spotlight Omnisearch offers a simple API to integrate with other modules. You can register your own actions that will be searchable within the Omnisearch.

Registering a Search Term

To register a search term, you can use the following code:

Hooks.on("spotlightOmnisearch.indexBuilt", (INDEX) => {
  const mySearchTerms = getMySearchTerms();
  INDEX.push(...mySearchTerms);
});

If you need to run async code to get your search terms, you can use the following code:

Hooks.on("spotlightOmnisearch.indexBuilt", (INDEX, promises) => {
  const myPromise = getMySearchTermsAsync();
  myPromise.then((mySearchTerms) => {
    INDEX.push(...mySearchTerms);
  });
  promises.push(myPromise);
});

Creating a Search Term

A search term is an object with the following properties:

    /**
     * Creates an instance of BaseSearchTerm.
     * @constructor
     * @param {Object} options - The options for creating the search term.
     * @param {string|Function} options.name - The name or function returning the name of the search term. This will be used to match the search term against a query.
     * @param {string|Function} [options.nameExtra=""] - The additional name or function returning the additional name of the search term. This will be added to the name but will not be used to match the search term against a query.
     * @param {string|Function} [options.description=""] - The description or function returning the description of the search term.
     * @param {Array<string>} [options.keywords=[]] - The array of keywords associated with the search term. This will be used to match the search term against a query.
     * @param {Array<Function>} [options.actions=[]] - The array of actions associated with the search term.
     * @param {*} options.dragData - The data associated with the drag action.
     * @param {string} options.type - The type of the search term. This will be split by space and used to match !type filters.
     * @param {Object} [options.data={}] - Additional data associated with the search term.
     * @param {string} options.img - The image URL associated with the search term.
     * @param {string|Array<string>} options.icon - The icon URL associated with the search term. If 2 icons are provided, they will be rendered on the right of the search term.
     * @param {Function} [options.onClick=null] - The function to handle click events.
     * @param {Function} [options.onDragStart=null] - The function to handle drag start events.
     * @param {Function} [options.onDragEnd=null] - The function to handle drag end events.
     * @param {Function} [options.match=null] - The function to match the search term against a query. If not provided, the name and keywords will be used to match the search term against a query.
     * @param {Function} [options.activateListeners=null] - The function to activate listeners for the search term.
     */
 

Here's an example of a search term, note that every parameter except name and type is optional:

    const BaseSearchTerm = CONFIG.SpotlightOmnisearch.SearchTerm;
    const mySearchTerm = new BaseSearchTerm({
        name: "My Search Term",
        nameExtra: "<i class='fas fa-dice'></i>",
        description: "My Search Term Description",
        keywords: ["my", "search", "term"],
        actions: [...myActions],
        dragData: { type: "myType", data: "myData" },
        type: "myType",
        data: { myData: "myData" },
        img: "path/to/image",
        icon: "fas fa-dice",
        onClick: (event) => console.log("Clicked", event),
        onDragStart: (event) => console.log("Drag Start", event),
        onDragEnd: (event) => console.log("Drag End", event),
        match: (query) => query === "my search term",
        activateListeners: (html) => console.log("Activated", html)
    });

Creating an Action

An action is an object with the following properties:

/**
 * Represents an action associated with a search term.
 * @typedef {Object} Action
 * @property {string} name - The name of the action.
 * @property {string} icon - The icon HTML associated with the action.
 * @property {Function} callback - The callback function to execute when the action is triggered.
 */

Here's an example of an action:

    const myAction = {
        name: "My Action",
        icon: "<i class='fas fa-dice'></i>"
        callback: (event) => console.log("Action Triggered", event)
    };