jgrubb / fusuma

window management for OSX

fusuma

fusuma has been written in MacRuby, and who doesn't like Ruby? there are no nibs/xibs, no compiled binaries or anything else you get when you make a regular OSX project with Apple's tools.

so shut down XCode, pop open Vim/Emacs/Sublime/TextMate/nano(?) and jump in!

---

fusuma can

• keep track of unique windows and applications
• position and resize any window
• activate and set focus to any window
• automatically tile and organize your windows based on the configured layout's rules
• assign global hot keys for any of the above actions

fusuma can't

• remove window decorations from another application

---

how does it work?

example configuration 'configuration.json':

{
  "layouts": [                               # layouts are matched to active displays
    "small_workspace",                       # primary monitor
    "large_workspace"                        # secondary monitor
  ],
  "keymap": {                                # keymap actions reference methods in keymap.rb
    "set_main_window": "RETURN+COMMAND+SHIFT",
    "activate_window_1": "1+COMMAND+SHIFT",
    "activate_window_2": "2+COMMAND+SHIFT,
    "swap_focused_window_with_main": "SPACE+COMMAND+SHIFT",
    "remove_all_windows": "Q+COMMAND+SHIFT",
    "rotate_layout_counterclockwise": "K+COMMAND+SHIFT",   # *** WARNING ***
    "rotate_layout_clockwise": "J+COMMAND+SHIFT",          # these keymaps are global, map carefully.
    "activate_previous_window": "H+COMMAND+SHIFT",         # *** WARNING ***
    "activate_next_window": "L+COMMAND+SHIFT",
    "zoom_active_window": "Z+COMMAND+SHIFT"
  }
}

example layout 'my_layout.json'

{
  "name": "my_layout",                       # each layout defines its own scale so
  "scale": {                                 # we can use the same layout with many
    "origin": [ 0, 0 ],                      # different display dimensions.
    "size": [ 120, 120 ]
  },                                         # each layout's frame defines the layout
  "frames": [                                # for each window (and maximum number of
    [                                        # windows that can be controlled).
      {
        "position": [ 0, 0 ],                # if there is 1 window in the layout,
        "dimensions": [ 120, 120 ]           # frame 1 will maximize the window.
      }
    ],
    [
      {
        "position": [ 60, 0 ],
        "dimensions": [ 60, 120 ]            # if there are two windows in the layout,
      },                                     # frame 2 will split the desktop down the
      {                                      # middle with the 'main' window on the
        "position": [ 0, 0 ],                # and the secondary window on the left
        "dimensions": [ 60, 120 ]
      }
    ]
  ]
}

---

todo

• clean up and documentation (this is an ongoing todo item)
• some default layouts and more keymaps
• multi-layout/monitor support
• observer to notify fusuma when a window opens/closes/changes state
• fix sizing of fixed-ratio windows like terminals and editors with fixed width fonts like MacVim/Emacs (if this is even possible)
• finish packaging/configuration (yawn)

---

wanna help/play?

• download and install the latest MacRuby
• it's recommended (but not required) that you install afloat and turn off window shadows
• fork fusuma
• run './build_app' to build the latest version
• run 'open fusuma.app' (or double click it)
• hax (the most important step!)

---

license

Copyright (C) 2012 Gino Lucero

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.