MTMR Documentation

Technical Documentation: Toxblh/MTMR

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`README.md`) Copy Section

My touchbar. My rules. [](https://github.com/Toxblh/MTMR/releases) [](https://github.com/Toxblh/MTMR/blob/master/LICENSE)

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.

Share your presets here

Visial editor for MTMR -> MTMR Designer
All thanks to @josetwentyfour

Installation Copy Chapter

• Download latest release (.dmg) from github
• Or via Homebrew brew install --cask mtmr
• Dario Prski has written a fantastic article on medium 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.

Examples Copy Chapter

MTMR presets

Customization Copy Chapter

MTMR preferences are stored in ~/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: Copy Chapter

Buttons

• escape
• exitTouchbar
• brightnessUp
• brightnessDown
• illuminationUp (keyboard illumination)
• illuminationDown (keyboard illumination)
• volumeDown
• volumeUp
• mute

Native Plugins

• timeButton
• battery
• cpu
• 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
• upnext (Calendar events)

Media Keys

• previous
• play
• next

AppleScript plugins

• sleep
• displaySleep

Custom buttons

• staticButton
• appleScriptTitledButton
• shellScriptTitledButton

Gestures Copy Chapter

By default you can enable basic gestures from application menu (status bar -> MTMR icon -> Volume/Brightness gestures):

• two finger slide: change you Volume
• three finger slide: change you Brightness

Custom gestures Copy Section

You can add custom actions for two/three/four finger swipes. To do it, you need to use swipe type:

"type": "swipe",
    "fingers": 2,            // number of fingers required (2,3 or 4)
    "direction": "right",    // direction of swipe (right/left)
    "minOffset": 10,          // optional: minimal required offset for gesture to emit event
    "sourceApple": {         // optional: apple script to run
        "inline": "beep"
    },
    "sourceBash": {          // optional: bash script to run
        "inline": "touch /Users/lobster/test"
    }

You may create as many swipe objects in the preset as you want.

Built-in slider types: Copy Chapter

• brightness
• volume

You can also make custom buttons using these types Copy Section

`staticButton`

"type": "staticButton",
 "title": "esc",

`appleScriptTitledButton`

{
    "type": "appleScriptTitledButton",
    "refreshInterval": 60, //optional
    "source": {
      "filePath": "~/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"
    },
  }

Note: You can change appleScriptTitledButton's icon by following these steps:

1. Declare dictionary of icons in alternativeImages field
2. Make you script return array of two values - {"TITLE", "IMAGE_LABEL"}
3. Make sure that your IMAGE_LABEL is declared in alternativeImages field

Example:

{
    "type": "appleScriptTitledButton",
    "source": {
      "inline": "if (random number from 1 to 2) = 1 then\n\tset val to {\"title\", \"play\"}\nelse\n\tset val to {\"title\", \"pause\"}\nend if\nreturn val"
    },
    "refreshInterval": 1,
    "image": {
      "base64": "iVBORw0KGgoAAAANSUhEUgA..."
    },
    "alternativeImages": {
      "play": {
        "base64": "iVBORw0KGgoAAAANSUhEUgAAAAAA..."
      },
      "pause": {
        "base64": "iVBORw0KGgoAAAANSUhEUgAAAIAA..."
      }
    }
  },

`shellScriptTitledButton`

Note: script may also use escape sequences to return colors (read https://misc.flogisoft.com/bash/tip_colors_and_formatting for more information)
"16 Colors" is the only mode supported presently. Buttons will set their own background color to the color returned.

Example of "CPU load" button which also changes color based on load value (Note: The native cpu plugin runs runs better):

/* Detailed source-code truncated for AI context efficiency. */

Groups Copy Chapter

{
  "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 Copy Chapter

`cpu`

Shows current CPU load in percent, changes color based on load value.
Has lower power consumption and higher stability than the shell-based solution.

{
  "type": "cpu",
  "refreshInterval": 3,
  "width": 80
}

`timeButton`

NOTE: Some values don't work properly: 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

{
  "type": "timeButton",
  "formatTemplate": "dd HH:mm",
  "locale": "en_GB",
  "timeZone": "UTC"
}

`weather`

Provider: https://openweathermap.org
Note: Register at https://openweathermap.org to get your API key
Note: Wait for 20 minutes or so for Openweathermap to activate your API key.
Note: Enable MTMR in "Location Services" in the "Security & Privacy" System Preferences pane

"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: Enable MTMR in "Location Services" in the "Security & Privacy" System Preferences pane

"type": "yandexWeather",
  "refreshInterval": 600 // in seconds

`currency`

Provider: https://coinbase.com

"type": "currency",
  "refreshInterval": 600, // in seconds
  "align": "right",
  "from": "BTC",
  "to": "USD",
  "full": true // £‣1.29$

`music`

{
  "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 tap starts the work timer, long-press to start the rest timer. Tap an in-progress timer to reset.

{
  "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 network usage

{
  "type": "network",
  "flip": true,
  "units": "dynamic" // or B/s, KB/s, MB/s, GB/s
},

`dock`

Dock plugin

{
  "type": "dock",
  "filter": "(^Xcode$)|(Safari)|(.*player)",
  "autoResize": true
},

`upnext`

Calendar next event plugin
Displays upcoming events from macOS Calendar. Does not display current event.

{
  "type": "upnext",
  "from": 0, // Lower bound of search range for next event in hours.        Default 0 (current time)(can be negative to view events in the past)
  "to": 12, // Upper bounds of search range for next event in hours.        Default 12 (12 hours in the future)
  "maxToShow": 3, // Limits the maximum number of events displayed.          Default 3 (the first 3 upcoming events)
  "autoResize": false // If true, widget will expand to display all events. Default false (scrollable view within "width")
},

Actions: Copy Chapter

Example: Copy Section

"actions": [
  {
    "trigger": "singleTap",
    "action": "hidKey",
    "keycode": 53
  }
]

Triggers: Copy Section

• singleTap
• doubleTap
• tripleTap
• longTap

Types Copy Section

• hidKey

  https://github.com/aosm/IOHIDFamily/blob/master/IOHIDSystem/IOKit/hidsystem/ev_keymap.h use only numbers

"action": "hidKey",
 "keycode": 53,

• keyPress

  https://eastmanreference.com/complete-list-of-applescript-key-codes

"action": "keyPress",
 "keycode": 1,

• appleScript

"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

"action": "shellScript",
 "executablePath": "/usr/bin/pmset",
 "shellArguments": ["sleepnow"], // optional

• openUrl

"action": "openUrl",
 "url": "https://google.com",

Additional parameters: Copy Chapter

• width restrict how much room a particular button will take

"width": 34

• align can stick the item to the side. default is center

"align": "left" // "left", "right" or "center"

• bordered you can do button without border

"bordered": "false" // "true" or "false"

• background allow to specify you button background color

"background": "#FF0000",

by using background with color "#000000" and bordered == false you can create button without gray background but with background when the button is pressed

• title specify button title

"title": "hello"

• image specify button icon

"image": {
    //Can be either of those
    "base64": "iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAMAAACdt4HsAAAABGdB...."
    //or
    "filePath": "~/img.png"
  }

• matchAppId displays the button only when active app's id matches given regexp

"matchAppId": "Safari"

Troubleshooting Copy Chapter

If you can't open preferences:

• Opening another program which can't edit text
  1. Open Terminal.app
  2. Put open -a TextEdit ~/Library/Application\ Support/MTMR/items.json command and press Enter

Buttons or gestures doesn't work:

• "After the last update my mtmr is not working anymore!"
• "Buttons sometimes do not trigger action"
• "ESC don't work"
• "Gestures don't work"

Re-tick or check a tick for access 🍏→ System Preferences → Security and Privacy → tab Privacy → Accessibility → MTMR

Credits Copy Chapter

Built by @Toxblh and @ReDetection.

--- METRICS ---

• Files Extracted: 1
• Estimated Token Budget: ~3273 tokens
• Canonical Reference: https://codewiki.google/github.com/Toxblh/MTMR