Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Adds new screenshot and clarifies README text.
  • Loading branch information
pg8wood committed Mar 13, 2018
1 parent d1d3928 commit 325c348
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 5 deletions.
Binary file not shown.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,28 @@ OSRS-touch-bar displays [Old School RuneScape](http://oldschool.runescape.com) i
![Touch bar screenshot](./touchBarScreenshot.png)

# Usage

On launch, your Touch Bar will display the interface shown above until you quit OSRS-touch-bar (even if you switch apps).

Should you need the Control Strip or other "normal" Touch Bar functionality, simply click one of the buttons in the app and the Touch Bar will update accordingly.
Should you need to access the Control Strip, simply enable it with the `Control Strip` toggle.

If you close the Touch Bar app, you can reload it with the `Reload` button.

Quitting the app will restore your original Control Strip settings.

<!--Centered Image-->
<p align="center">
<img src="./appScreenshot.png"/>
</p>

## Privileges
OSRS-touch-bar will request assistive access on first launch. This is required for the scripts OSRS-touch-bar uses to temporarily toggle the Control Stip's visibility while you are using the app.
Note: if you have your Touch Bar configured to show only the "Expanded Control Strip" or "F1, F2, etc. Keys", OSRS Touch Bar cannot display the RuneScape UI in the Touch Bar! This can be toggled in __System Preferences &rarr; Keyboard__.

## API Note
It should be noted that, like other "global" Touch Bar apps ([BetterTouchTool](https://www.boastr.net/), [Touch Bär](https://github.com/a2/touch-baer), etc), OSRS-touch-bar goes against Apple's guidelines.
It should be noted that, like other "global" Touch Bar apps ([BetterTouchTool](https://www.boastr.net/), [Touch Bär](https://github.com/a2/touch-baer), etc), OSRS-touch-bar goes against Apple's current Touch Bar guidelines.

In order to use OSRS-touch-bar in conjunction with the RuneScape client, a private API is necessary to circumvent Apple's restrictions on hiding the Control Strip. As such, OSRS-touch-bar links against a private Apple framework `DFRFoundation.framework`.

__tl;dr__ Apple probably wouldn't put this app on the Mac App Store solely because it hides the Control Strip.
__tl;dr__ Since the OSRS client doesn't have its own App Controls, this app adds its own App Controls in the (otherwise unused) Touch Bar space.

Happy 'Scaping!

Binary file modified appScreenshot.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 325c348

Please sign in to comment.