# My touchbar. My rules. [![GitHub release](https://img.shields.io/github/release/toxblh/MTMR.svg)](https://github.com/Toxblh/MTMR/releases) [![license](https://img.shields.io/github/license/Toxblh/MTMR.svg)](https://github.com/Toxblh/MTMR/blob/master/LICENSE) ![minimal system requirements](https://img.shields.io/badge/required-macOS%2010.12.2-blue.svg) ![travis](https://travis-ci.org/Toxblh/MTMR.svg?branch=master) _The TouchBar Customization App for your MacBook Pro_ My idea is to create a platform for creating plugins to customize the TouchBar. I very much like BTT and having a full custom TouchBar (my BTT preset), and I wanted to create it. It's my first Swift project for MacOS :) **Share your presets [here](https://github.com/Toxblh/MTMR-presets)**

Mackbook with touchbar

Discord Telegram

PayPal donate button Buy Me A Coffee My TouchBar My Rules (MTMR)

## Installation - Download lastest [release](https://github.com/Toxblh/MTMR/releases) (.dmg) from github - Or via Homebrew `brew cask install mtmr` - [Dario Prski](https://medium.com/@urdigitalpulse) has written a [fantastic article on medium](https://medium.com/@urdigitalpulse/customise-your-macbook-pro-touch-bar-966998e606b5) that goes into more detail on installing MTMR **On first install** you need to allow access for MTMR in Accessibility otherwise buttons like Esc, Volume, Brightness and other system keys won't work

screenshot 2019-02-24 at 23 19 20

🍏→ System Preferences → Security and Privacy → tab Privacy → Accessibility → MTMR

## Examples [MTMR presets](https://github.com/Toxblh/MTMR-presets)

Presets for touchbar

## Customization MTMR preferences are stored under `~/Library/Application\ Support/MTMR/items.json`. The pre-installed configuration contains less or more than you'll probably want, try to configure: ## Built-in button types: > Buttons - escape - exitTouchbar - brightnessUp - brightnessDown - illuminationUp (keyboard illumination) - illuminationDown (keyboard illumination) - volumeDown - volumeUp - mute > Native Plugins - timeButton - battery - currency - weather - yandexWeather - inputsource - music (tap for pause, longTap for next) - dock (half-long click to open app, full-long click to kill app) - nightShift - dnd (Don't disturb) - darkMode - pomodoro - network > Media Keys - previous - play - next > AppleScript plugins - sleep - displaySleep > Custom buttons - staticButton - appleScriptTitledButton - shellScriptTitledButton ## Gestures on central part: - two finger slide: change you Volume - three finger slide: change you Brightness ## Built-in slider types: - brightness - volume ### You can also make custom buttons using these types #### `staticButton` ```json "type": "staticButton", "title": "esc", ``` #### `appleScriptTitledButton` ```js { "type": "appleScriptTitledButton", "refreshInterval": 60, //optional "source": { "filePath": "/Users/toxblh/Library/Application Support/MTMR/iTunes.nowPlaying.scpt", // or "inline": "tell application \"Finder\"\rif not (exists window 1) then\rmake new Finder window\rset target of front window to path to home folder as string\rend if\ractivate\rend tell", // or "base64": "StringInbase64" } } ``` #### `shellScriptTitledButton` > Note: script may return also colors using escape sequences (read more here https://misc.flogisoft.com/bash/tip_colors_and_formatting) > Only "16 Colors" mode supported atm. If background color returned, button will pick it up as own background color. Example of "CPU load" button which also changes color based on load value. ```js { "type": "shellScriptTitledButton", "width": 80, "refreshInterval": 2, "source": { "inline": "top -l 2 -n 0 -F | egrep -o ' \\d*\\.\\d+% idle' | tail -1 | awk -F% '{p = 100 - $1; if (p > 30) c = \"\\033[33m\"; if (p > 70) c = \"\\033[30;43m\"; printf \"%s%4.1f%%\\n\", c, p}'" }, "action": "appleScript", "actionAppleScript": { "inline": "activate application \"Activity Monitor\"\rtell application \"System Events\"\r\ttell process \"Activity Monitor\"\r\t\ttell radio button \"CPU\" of radio group 1 of group 2 of toolbar 1 of window 1 to perform action \"AXPress\"\r\tend tell\rend tell" }, "align": "right", "image": { "base64": "iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAMAAACdt4HsAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAA/1BMVEUAAADaACbYACfYACfjABzXACjYACfXACjYACfYACfYACfYACfdACLYACfXACjYACfVACv/AADXACjYACfYACfXACjYACfXACjaACXYACfYACfVACvYACfYACfZACbZACbYACfYACfZACb/AADYACfYACfVACrXACjVACu/AEDYACfYACfYACfXACjXACjYACfXACjYACfYACfYACfXACjYACfXACjYACfYACfZACbYACfYACfMADPYACfYACfYACfYACfYACfZACbXACjYACfYACfRAC7XACjYACfZACbWACnXACjXACjYACfTACzZACb/AADYACfYACfYACcAAAA+zneGAAAAU3RSTlMAItK+CVPjh3xUxPwPiGDQGAMtSKmN3Vk+wPQG/e26oIJBnwJCdiuAHgTmw+6BX+IgfaqLUvKOW8VKnagK+vBwYrhlc/urCznvhSyUbOEXPAFjGh/ektAAAAABYktHRACIBR1IAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4ggWETQWgEDcSgAAAqVJREFUWMPtl4ly2jAQhsUNNlcw5r4SICEHLSQhCQRyX73T/u//LpUlLIyxbMAznWmn/0ywo5U+27tr7ZoQuwLBUJidRKIxPhKLRtgxHAoGiLfiQIKdKFCTxjGpQmEDCSC+BiAFpNlJBsgaxyyQYQNpIPUf8AcAOzktD+iaoQJQNI5FoMAGdCCv5XZclpfKFXiqUi5Jllf1mvdyQzW96gigd4h6o+mhRp1O0x3vvwa1VSWeqrZU1Jyeogy01ggSVQsoO/i/gjq9/u6u+2LDXq2jshqLHNCgdsCVwO0NILdi0oDmuoAmoImhQDzFRPNnb36L7U43NVfc2EH2D9h5t9OePyIF5IU9uIhvkyN7iiXmQUIOj8x/lB6f0bTaQ3ZA+9iaNCH2Lpg6btsBIRJOpJl0E9ABTvof5kqEGeCjMaN/AnRMgM5XJcI2J1J1gf6S48Tb2Ae6JkAjdgmAeJ1XAOJ1Xg8wGJ6elXwAzkeGjy62BgxG3MuXnoCIkmEq8EQyAUPgajyhPxJAga9SIiRqzwMOuAbGZDrDjQRgKkpiqiPgFphM74B7d4BKy2cyy1RcBvSodUb/HiSAIl+VlEfh8cm4wvPL9nnw+gbc+kkkUVioO95etwe8PBuP8vQoBzg7UQAe5t7syZwoCaMA3AN30wlzh3MYJYkkADeYTckYuJYlkiSVBeCKZtSY/gxlqezlxEt+pdFg6zBesPXn1ih8Aj5vkAels9PhYCkPsl++kg0AQu4dyuqmugIQm+qS5Nv6N+D7wm7d1skPc4xu666Fhd6BxU6r+jub8tNaWNxK29EhsdpR/sVn7FlLm0txPdgni+JrFNd3p+K67MQtyrsp3w2G7xbHd5Plv83z3Wj6b3V9N9ssFv7afaa//ZPn3wD4/vje8PP/N7TebS0hgZhEAAAAJXRFWHRkYXRlOmNyZWF0ZQAyMDE4LTA4LTIyVDE3OjUyOjIyKzAyOjAwc2qUYAAAACV0RVh0ZGF0ZTptb2RpZnkAMjAxOC0wOC0yMlQxNzo1MjoyMiswMjowMAI3LNwAAAAZdEVYdFNvZnR3YXJlAHd3dy5pbmtzY2FwZS5vcmeb7jwaAAAAAElFTkSuQmCC" }, "bordered": false } ``` ## Groups ```js { "type": "group", "align": "center", "bordered": true, "title": "stats", "items": [ { "type": "play" }, { "type": "mute" }, ... ] } ``` To close a group, use the button: ``` { "type": "close", "width": 64 }, ``` ## Native plugins #### `timeButton` > Attention! Works not all: https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations > formatTemplate examples: https://www.datetimeformatter.com/how-to-format-date-time-in-swift/ > locale examples: https://gist.github.com/jacobbubu/1836273 ```js { "type": "timeButton", "formatTemplate": "dd HH:mm", "locale": "en_GB", "timeZone": "UTC" } ``` #### `weather` > Provider: https://openweathermap.org \ > Note: you need to register on https://openweathermap.org to get your API key \ > Note: you may need to wait for near 20 mins until your API key will be activated by Openweathermap \ > Note: you need to allow using "Location Services" in your Mac OS "Security & Privacy" settings for MTMR ```js "type": "weather", "refreshInterval": 600, // in seconds "units": "metric", // or imperial "icon_type": "text" // or images "api_key": "" // you can get the key on openweather ``` #### `yandexWeather` (experimental) > Provider: https://yandex.ru/pogoda. One click to open up weather forecast in your browser. \ > Note: you need to allow using "Location Services" in your Mac OS "Security & Privacy" settings for MTMR ```js "type": "yandexWeather", "refreshInterval": 600 // in seconds ``` #### `currency` > Provider: https://coinbase.com ```js "type": "currency", "refreshInterval": 600, // in seconds "align": "right", "from": "BTC", "to": "USD", "full": true // £‣1.29$ ``` #### `music` ```js { "type": "music", "align": "center", "width": 80, // Optional "bordered": false, // Optional "refreshInterval": 2, // in seconds. Optional. Default 5 seconds "disableMarquee": true // to disable marquee effect. Optional. Default false }, ``` #### `pomodoro` > Pomodoro plugin. One click to start the work timer, longclick to start the rest timer. Click in progress for reset. ```js { "type": "pomodoro", "workTime": 1200, // set time work in seconds. Default 1500 (25 min) "restTime": 600 // set time rest in seconds. Default 300 (5 min) }, ``` #### `network` > Network plugin. The plugin to show usage a network ```js { "type": "network", "flip": true }, ``` #### `dock` > Dock plugin ```js { "type": "dock", "filter": "(^Xcode$)|(Safari)|(.*player)", "autoResize": true }, ``` ## Actions: - `hidKey` > https://github.com/aosm/IOHIDFamily/blob/master/IOHIDSystem/IOKit/hidsystem/ev_keymap.h use only numbers ```json "action": "hidKey", "keycode": 53, ``` - `keyPress` ```json "action": "keyPress", "keycode": 1, ``` - `appleScript` ```js "action": "appleScript", "actionAppleScript": { "inline": "tell application \"Finder\"\rif not (exists window 1) then\rmake new Finder window\rset target of front window to path to home folder as string\rend if\ractivate\rend tell", // "filePath" or "base64" will work as well }, ``` - `shellScript` ```js "action": "shellScript", "executablePath": "/usr/bin/pmset", "shellArguments": ["sleepnow"], // optional ``` - `openUrl` ```js "action": "openUrl", "url": "https://google.com", ``` ## LongActions If you want to longPress for some operations, it is similar to the configuration for Actions but with additional parameters, for example: ```js "longAction": "hidKey", "longKeycode": 53, ``` - longAction - longKeycode - longActionAppleScript - longExecutablePath - longShellArguments - longUrl ## Additional parameters: - `width` restrict how much room a particular button will take ```json "width": 34 ``` - `align` can stick the item to the side. default is center ```js "align": "left" // "left", "right" or "center" ``` - `bordered` you can do button without border ```js "bordered": "false" // "true" or "false" ``` ### Roadmap - [x] Create the first prototype with TouchBar in Storyboard - [x] Put in stripe menu on startup the application - [x] Find how to simulate real buttons like brightness, volume, night shift and etc. - [x] Time in touchbar! - [x] First the weather plugin - [x] Find how to open full-screen TouchBar without the cross and stripe menu - [x] Find how to add haptic feedback - [x] Add icon and menu in StatusBar - [x] Hide from Dock - [x] Status menu: "preferences", "quit" - [x] JSON or another approch for save preset, maybe in `~/Library/Application Support/MTMR/` - [x] Custom buttons size, actions by click - [x] Layout: [always left, NSSliderView for center, always right] - [x] System for autoupdate (https://sparkle-project.org/) - [ ] Overwrite default values from item types (e.g. title for brightness) - [ ] Custom settings for paddings and margins for buttons - [ ] XPC Service for scripts - [ ] UI for settings - [ ] Import config from BTT Settings: - [ ] Interface for plugins and export like presets - [x] Startup at login - [ ] Show on/off in Dock - [ ] Show on/off in StatusBar - [ ] On/off Haptic Feedback Maybe: - [ ] Refactoring the application into packages (AppleScript, JavaScript? and Swift?) ## Credits Built by [@Toxblh](https://patreon.com/toxblh) and [@ReDetection](http://patreon.com/ReDetection). [![Analytics](https://ga-beacon.appspot.com/UA-96373624-2/mtmr?pixel)](https://github.com/igrigorik/ga-beacon)