Skip to content

Commit 8c457a8

Browse files
committed
Added example gif and updated readme
1 parent f1418db commit 8c457a8

File tree

2 files changed

+17
-4
lines changed

2 files changed

+17
-4
lines changed

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,33 @@
55

66
# Commander - FoundryVTT at your fingertips
77

8-
Commander is a tool inspired 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.
8+
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.
99

10-
This module provides the command-line input and the API for registering new commands, and will provide some example and general-use commands. The command-line is opened by default by clicking Ctrl+Backtick (the ` right next to the 1 in english keyboards).
10+
This module provides the command-line input and the API for registering new commands, and will provide some example and general-use commands.
11+
12+
<img src="./media/cmd-example.gif" width="600" height="363" />
13+
14+
## Bundled Commands
15+
16+
* Command info (i)
17+
* Log commands the current use can use (cmd:allowed)
18+
* Open tab (go $tab)
19+
* Open compendium (comp $title)
20+
* Run macro by name (m $name)
21+
* Open character sheet by Player name (sheet:player $name)
22+
* Open character sheet by Actor name (sheet:name $name)
23+
* Apply active effect to selected tokens -just visual- (tae $effect)
1124

1225
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)!
1326

27+
> For information on how to add new commands, please refer to [The Wiki](https://github.com/ccjmk/commander/wiki)
28+
1429
## Executing Commands
1530

1631
You can open the Commander widget by pressing the corresponding keybinding, configurable in-game, with the default been Ctrl+Backtick. *(the ` right next to the 1 in english keyboards)*
1732

1833
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.
1934

20-
> For information on how to add new commands, please refer to [The Wiki](https://github.com/ccjmk/commander/wiki)
21-
2235
## Licensing
2336

2437
This project is being developed under the terms of the

media/cmd-example.gif

2.97 MB
Loading

0 commit comments

Comments
 (0)