https://github.com/ccjmk/commander

Command launcher for Foundry VTT for running and registering commands executable solely by keyboard
https://github.com/ccjmk/commander

foundry-vtt foundryvtt

Last synced: 4 months ago
JSON representation

Command launcher for Foundry VTT for running and registering commands executable solely by keyboard

• Host: GitHub
• URL: https://github.com/ccjmk/commander
• Owner: ccjmk
• License: other
• Created: 2022-01-27T20:00:12.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-09-02T15:03:00.000Z (over 2 years ago)
• Last Synced: 2023-05-11T02:10:15.846Z (over 1 year ago)
• Topics: foundry-vtt, foundryvtt
• Language: TypeScript
• Homepage:
• Size: 2.98 MB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Module Version](https://img.shields.io/github/v/release/ccjmk/commander?color=blue)

![FoundryVersion](https://img.shields.io/endpoint?url=https://foundryshields.com/version?url=https%3A%2F%2Fgithub.com%2Fccjmk%2Fcommander%2Freleases%2Flatest%2Fdownload%2Fmodule.json)

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/N4N88281M)

# Commander - FoundryVTT at your fingertips

Commander is a tool vaguely inspired by the likes of `Launchy` or `Wox`, and a similar feeling like `SearchAnywhere`, that lets you run commands from a shortcut-invoked prompt.

This module provides the command-line input and the API for registering new commands, and will provide some example and general-use commands.



## Bundled Commands

* Command info (info $command)

* Show commands the current user can use (help)

* Open tab (go $tab)

* Open compendium (comp $title)

* Run macro by name (m $name)

* Open character sheet by Player name (player $name)

* Open character sheet by Actor name (pc $name)

* Open non-player character sheet by name (npc $name)

* Apply active effect to selected tokens -just visual- (tae $effect)

It is not the intention of this module to provide commands specific to particular systems, but mostly the tooling and more generic commands applicable to anyone regardless of game system. If you have such a command that you want to share, [don't be afraid to open a pull request](https://github.com/ccjmk/commander/pulls)!

> For information on how to add new commands, please refer to [The Wiki](https://github.com/ccjmk/commander/wiki)

## Executing Commands

You can open the Commander widget by pressing (by default) `Alt+Q`. Shortcut is configurable ingame using the default keybinding menu.

Then you can start typing! Command suggestions will pop up as you type, you can auto-accept the selected suggestion with `Tab`/`Enter`, or select other suggestions using `Up` or `Down`. An `Enter` when no suggestion is selected sends the Command for execution, else it auto-fills that suggestion.

## Licensing

This project is being developed under the terms of the

[LIMITED LICENSE AGREEMENT FOR MODULE DEVELOPMENT] for Foundry Virtual Tabletop.

MIT - for more info please read the LICENSE file.

[LIMITED LICENSE AGREEMENT FOR MODULE DEVELOPMENT]: https://foundryvtt.com/article/license/