Skip to content

Commit

Permalink
Merge pull request #7 from pilgrimtabby/web-rework-hotkeys
Browse files Browse the repository at this point in the history
Added explanations for changes introduced in rework-hotkeys and made other minor revisions
  • Loading branch information
pilgrimtabby authored Jun 1, 2024
2 parents 4897850 + 43d5dd8 commit b5f16ed
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 12 deletions.
12 changes: 9 additions & 3 deletions 02-create-splits.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,30 @@ Now that your video's connected, let's make some splits!

## Taking screenshots

Press the Take Screenshot button to take a screenshot of the currently displayed video frame.
Press the Take Screenshot button to take a screenshot of the currently displayed video frame.

<figure>
<img src="images/take-screenshot.png" class="square-image" alt="Take screenshot">
</figure>

By default, split images are read from and saved to your home directory. Choose a custom folder by clicking the Select Split Image Folder button.
By default, split images are read from and saved to your home directory. Choose a custom folder by clicking the Select Split Image Folder button:

<figure>
<img src="images/select-folder.png" class="square-image" alt="Select split image folder">
</figure>

You can also browse the contents of the current folder by clicking on the folder's path:

<figure>
<img src="images/open-folder.png" class="square-image" alt="Open current split images folder">
</figure>

{: .tip }
Press the Reset Splits button at any time to reload all images from your splits folder, allowing new and modified images to show up in Pilgrim Autosplitter.

## Editing images

Your speedgame may not have a reliable, repeatable frame for each split — that's fine! Almost every split has some on-screen element that is consistent, like an icon or some text. Take this example from The Legend of Zelda: Ocarina of Time:
Your speedgame may not have a reliable, repeatable frame for each split — that's fine! All you need is some on-screen element that is consistent, like an icon or some text. Take this example from The Legend of Zelda: Ocarina of Time:

<figure>
<img src="images/example-screenshot.png" class="square-image" alt="A problematic split">
Expand Down
36 changes: 27 additions & 9 deletions 04-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ nav_order: 5

# Settings

To open the settings menu, go to the "Pilgrim Autosplitter" context menu and click `Settings`.

{: .tip }
You can also open the settings menu by pressing `ctrl+.` (on Windows) or `cmd+.` (on Mac).

This is the settings menu:

<figure>
Expand Down Expand Up @@ -92,20 +97,30 @@ Default: `disabled`
## Global hotkeys

If enabled, hotkeys will work no matter what app is in focus.
If disabled, hotkeys will only work when Pilgrim Autosplitter is in focus.
If disabled, hotkeys will only work when Pilgrim Autosplitter is in focus. (For an exception to this behavior, see [Toggle global](#toggle-global).)

Default: `enabled`

## Check for updates

When enabled, Pilgrim Autosplitter will automatically check if a new version has been released on launch.

Upgrading to a new version doesn't erase your settings; they are saved by the system.

Default: `enabled`

# Hotkeys

Pilgrim Autosplitter has 9 optional hotkeys.
Pilgrim Autosplitter has 9 optional hotkeys.

Each hotkey can be assigned to only one key (i.e. NOT a combination of keys, such as `ctrl+m`). Similarly, each key can only be used for one hotkey.
A hotkey can only be bound to one key (i.e. you CANNOT use a combination of keys, such as `ctrl+m`).

{: .note }
If you assign the same key to more than one hotkey, the highest hotkey in the list will take precedence. For instance, if you assign `space` to the `start / split` hotkey and the `screenshot` hotkey, pressing `space` will trigger a split, but will not take a screenshot.
The same key can be used for more than one hotkey. For instance, you could bind the same key to `split` and `screenshot`. Then, every time Pilgrim Autosplitter splits, it will take a screenshot too.

{: .warning }
Using the same key for hotkeys that do opposite things (e.g. `skip` and `undo`) may result in unexpected behavior. Use common sense!

## Start / split
## Split
Go to the next split. This is the key Pilgrim Autosplitter presses when a split image is matched.

## Reset splits
Expand All @@ -126,16 +141,19 @@ Go forward one split.

## Previous split

Go back one split. This hotkey is included along with `undo` so you can scroll through splits without affecting the speedrun timer.
Go back one split. This hotkey is included along with [undo split](#undo-split) so you can scroll through splits without affecting the speedrun timer.

## Next split

Go forward one split. This hotkey is included along with `skip` so you can scroll through splits without affecting the speedrun timer.
Go forward one split. This hotkey is included along with [skip split](#skip-split) so you can scroll through splits without affecting the speedrun timer.

## Screenshot

Take a screenshot.

## Toggle global

Enabled or disable [global hotkeys](#global-hotkeys). Convenient if you like to use the keyboard during speedruns.
Enable or disable [global hotkeys](#global-hotkeys). Convenient if you like to use the keyboard during speedruns.

{: .note }
If you assign this hotkey, it is always enabled, even when [global hotkeys](#global-hotkeys) are disabled.
Binary file added images/open-folder.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/settings-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b5f16ed

Please sign in to comment.