pg8wood / osrs-touch-bar

Enables Touch Bar support on any Old School RuneScape client ⚔️🏹

OSRS Touch Bar

OSRS Touch Bar displays Old School RuneScape interface icons and maps them to the corresponding function keys in-game.

Download

View the latest release

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 to access the Control Strip, simply enable it with the Control Strip toggle.

The Touch Bar buttons can be resized with the Fit Buttons to Touch Bar button.

Quitting the app will restore your original Control Strip settings.

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 → Keyboard.

Customization

The Touch bar can be customized similarly to how the Control Strip is customized in System Preferences. You may add, remove, and reorder as many buttons as you wish.

API Note

It should be noted that, like other "global" Touch Bar apps (BetterTouchTool, Touch Bär, 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 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!

osrs-touch-bar's Issues

Button functions are confusing

The way the app works with System Preferences is confusing. The app should either directly work with the defaults API or the System Preferences interaction should be more streamlined and the user should know which buttons will launch external applications.

Control Strip Doesn't Reload in Packaged App

When running the packaged app, it seems that the app sandboxing is enforced more heavily--to the point where the scripts can't write a file.

This can likely be solved by creating a file in the Documents directory and passing that handle to the scripts.

[Request] Read keyCode from plist

If we have custom key mapping (such as esc to close inventory) the Touch Bar won't work. If it read the keyCode from a plist instead, users could customize the values.

Buttons clipping window

The App View's buttons clip on some 13" Macs.

Account Management Icon

As of 9/27, Jagex has changed the Ignore List interface to the Account Management interface. While I don't expect anyone to need a quick switch to Account Management via the Touch Bar, the icon should be updated for consistency.

[Request] - Port to Runelite

Since Runelite is its own app, do you think it would be reasonable to take over its app control? Then you wouldn't need the global framework and you could have a version that complies with apples guidelines.

The only reason I ask is because I use this app quite a bit but I frequently forget to open it so when I go to switch panes it is not there.

macOS Catalina Notarization needed

Let's avoid those scary warning messages that will appear on apps that aren't notarized by Apple.

See: https://developer.apple.com/news/?id=09032019a

macOS 10.14.5 security update prevents keypresses from firing

Hello, I am using runelite and when pressing the keys in the touch bar nothing happes, if i try using the funtion keys it works.

What could be the cause of this?

Greetings

[Request] - Add support for rearranging, blacklisting, and resizing

Wanted to do some vorkath on my MBP w/touchbar and stumbled upon this. Noticed that the buttons are relatively small for switching without paying attention. I'm gonna take a swing at it but I need to switch between my inventory and my spell book and they are 3 buttons apart and non-rearrangeable. Do you think this would be possible? The progress you have, though, looks great!

[Bug] - Was moving around the different icons and the spacing is off between two icons

I removed the combat styles and it returned to normal. I placed it back and then there was a gap.

Edit: just found out the image format is HEIC so I'm gonna figure that out and post it.

Edit2: should be good

Window is vertically resizable

The window size shouldn't be changeable. As such, if the user resizes the window vertically, the UI breaks.

Control Strip Button's Hitbox is Off

The Control Strip button's clickable area doesn't quite line up with the button's frame, so there are some dead spots where clicking the button doesn't do anything.