Coder Social home page Coder Social logo

oh-my-hammerspoon's Introduction

Oh-my-Hammerspoon!

A configuration framework for Hammerspoon

Very early work in progress, feedback very welcome.

Instructions

  1. Check out this repository onto your ~/.hammerspoon directory:

    git clone https://github.com/zzamboni/oh-my-hammerspoon.git ~/.hammerspoon
    
  2. Edit init.lua to enable/disable the plugins you want (at the moment they are all enabled by default).

  3. Copy init-local-sample.lua to init-local.lua and modify to change plugin configuration parameters or add your own arbitrary code.

Functionality included

This config has already replaced my use of the following apps:

  • ClipMenu - clipboard history, supporting both text and image entries. See clipboard.lua.
    • Shift-Cmd-v shows the clipboard menu.
  • Choosy and other URL dispatchers - allows opening URLs in different applications depending on regular expression matching. Great if you use site-specific browsers created with Epichrome or Fluid. See url_handling.lua.
  • Breakaway - automatically pause/unpause music when headphones are unplugged/replugged. Only for Spotify app at the moment, and it needs latest Hammerspoon built from source (which includes the audio device watcher). See headphones_watcher.lua.
  • Spectacle - window manipulation. Only some shortcuts implemented, those that I use, but others should be easy to add. See manipulation.lua.
    • Ctrl-Cmd-left/right/up/down - resize the current window to the corresponding half of the screen.
    • Ctrl-Alt-left/right/up/down - resize and move the current window to the previous/next horizontal/vertical third of the screen.
    • Ctrl-Alt-Cmd-F or Ctrl-Alt-Cmd-up - maximize the current window.
    • Ctrl-Alt-Cmd-left/right - move the current window to the previous/next screen (if more than one monitor is plugged in).
  • ShowyEdge - menu bar coloring to indicate the currently selected keyboard layout (again, only the indicators I use are implemented, but others are very easy to add). See menubar_indicator.lua.

It additionally provides the following functionality:

  • "Universal Archive" (universal_archive.lua) for archiving the current item in different applications. At the moment Evernote and Mail.app are supported.
  • Automatic/manual configuration reloading (hammerspoon_config_reload.lua)
    • Ctrl-Alt-Cmd-r - manual reload, or when any *.lua file in ~/.hammerspoon/ changes.
  • A color sampler/picker (colorpicker.lua)
    • Ctrl-Alt-Cmd-c toggles a full-screen color picker of the colors in hs.drawing.color (this is more impressive with a larger list of colors, like the one in PR#611). Clicking on any color will copy its name to the clipboard, Cmd-clicking copies its RGB code.
  • Mouse locator (mouse/locator.lua).
    • Ctrl-Alt-Cmd-d draws a red circle around the mouse for 3 seconds.
  • Skype mute/unmute (skype_mute.lua)
    • Ctrl-Alt-Cmd-Shift-v mutes/unmutes Skype, regardless of whether it's the frontmost application.

It has drawn inspiration and code from many other places, including:

oh-my-hammerspoon's People

Contributors

zzamboni avatar vbfischer avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.