Skip to content

Commit

Permalink
Update user manual to include Linux info
Browse files Browse the repository at this point in the history
  • Loading branch information
pilgrimtabby committed Jul 18, 2024
1 parent bfe1b09 commit 4688194
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 15 deletions.
4 changes: 2 additions & 2 deletions 02-create-splits.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ Your speedgame may not have a reliable, repeatable frame for each split — that
I want to split when I pick up a heart piece, but my screen won't look exactly like this every time. However, the words on the screen are always in the same spot. Let's use this knowledge to make a split image that will always match.

{: .tip }
There are lots of free image editors, but these work well with Pilgrim Autosplitter:
There are lots of free image editors, but these work well for our purposes:
For Windows: [paint.net](https://www.getpaint.net/)
For MacOS: [krita](https://krita.org/en/download/)
For MacOS/Linux: [krita](https://krita.org/en/download/)

I'll use Krita in this example. In Krita, press `cmd+o` and select the screenshot. You should see a window like this:

Expand Down
2 changes: 1 addition & 1 deletion 04-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ If disabled, hotkeys will only work when Pilgrim Autosplitter is in focus. (For
Default: `enabled`

{: .note }
For global hotkeys to work on MacOS, you need to give Terminal [accessibility privileges](https://support.apple.com/guide/mac-help/allow-accessibility-apps-to-access-your-mac-mh43185/mac) in Privacy and Security in System Settings. This allows Pilgrim Autosplitter to monitor your keyboard for inputs even when it's not in focus. If this doesn't work, you can also run Pilgrim Autosplitter as root.
For global hotkeys to work on MacOS, you need to give Terminal [accessibility privileges](https://support.apple.com/guide/mac-help/allow-accessibility-apps-to-access-your-mac-mh43185/mac) in Privacy and Security in System Settings. If that doesn't work, you can also run Pilgrim Autosplitter as root. In addition, on Linux you must run Pilgrim Autosplitter as root. This allows Pilgrim Autosplitter to monitor your keyboard for inputs even when the app's not in focus.

## Check for updates

Expand Down
4 changes: 2 additions & 2 deletions 05-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ nav_order: 5
You can download the latest build or the source code [here](https://github.com/pilgrimtabby/pilgrim-autosplitter/releases/).

{: .important }
The source code is compatible with Windows and MacOS. However, the built app is currently not available for Intel-based Macs. See [this page](https://github.com/pilgrimtabby/pilgrim-autosplitter/?tab=readme-ov-file#installation) for more details.
The source code works on Windows, MacOS, and Linux. However, the built app is currently not available for Intel-based Macs or AMD Linux builds. See [this page](https://github.com/pilgrimtabby/pilgrim-autosplitter/?tab=readme-ov-file#installation) for more details.

Even if you can't use the built app, running the source code is straightforward if you follow this [step-by-step guide](https://github.com/pilgrimtabby/pilgrim-autosplitter/?tab=readme-ov-file#installation).
Even if you can't use the built app, running the source code is straightforward following this [step-by-step guide](https://github.com/pilgrimtabby/pilgrim-autosplitter/?tab=readme-ov-file#installation).

If you have any questions or concerns, please feel free to [open an issue](https://github.com/pilgrimtabby/pilgrim-autosplitter/issues) on Pilgrim Autosplitter's repository page or email me directly at [email protected].
8 changes: 4 additions & 4 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@
title: Pilgrim Autosplitter
email: [email protected]
description: >- # this means to ignore newlines until "baseurl:"
Finally, an image-based autosplitter for console, Windows PC, and MacOS!
Set up global hotkeys, customize split images, choose from
different themes, and never touch a keyboard during a speedrun
again — even when streaming from or playing on MacOS.
A multi-platform image-based speedrun autosplitter including Windows,
MacOS and Linux. Set up global hotkeys, customize split images, choose
from different themes, and never touch a keyboard during a speedrun
again.
domain: pilgrimtabby.github.io
baseurl: /pilgrim-autosplitter/ # the subpath of your site, e.g. /blog
url: https://pilgrimtabby.github.io # the base hostname & protocol for your site, e.g. http://example.com
Expand Down
12 changes: 6 additions & 6 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,18 @@ title: Overview
<link rel="stylesheet" href="css/main.css">
</header>

# Pilgrim Autosplitter for MacOS: User Manual
# Pilgrim Autosplitter: User Manual

Finally, an image-based speedrun autosplitter compatible with MacOS!
Finally, a multi-platform image-based speedrun autosplitter!

<figure>
<img src="images/demo.gif" class="massive-image" alt="A simple demonstration">
</figure>

Pilgrim Autosplitter was designed to fill the gap left by other image-based speedrun autosplitters, which are generally incompatible with MacOS.
Pilgrim Autosplitter was designed to fill the gap left by other image-based speedrun autosplitters, which generally only run on Windows.

Bring your best speedgame whether you're running on console, MacOS, or PC.
Bring your best speedgame on Windows, MacOS, and Linux (and whether you game on console or computer).

Compatible with MacOS and Windows.
Compatible with Windows, MacOS, and Linux.

[Get the latest release](https://github.com/pilgrimtabby/pilgrim-autosplitter/releases), or [check out the source code](https://github.com/pilgrimtabby/pilgrim-autosplitter/).
[Get the latest release](https://github.com/pilgrimtabby/pilgrim-autosplitter/releases/latest), or [check out the source code](https://github.com/pilgrimtabby/pilgrim-autosplitter/).

0 comments on commit 4688194

Please sign in to comment.