Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Get and set your OSX desktop background image programmatically.
JavaScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
LICENSE.md
README.md
index.js
package.json

README.md

osx-background

A Node module for getting and setting your desktop background image programmatically on your Mac!

Uses NodObjC and node-ffi under the hood, and should work on OSX 10.6 and above.

Installation

npm install osx-background

Usage

require('osx-background').get()

Returns the absolute path to the current desktop background image.

require('osx-background').set(filename)

Sets the background image to the chosen filename - returns true if successful, and false if it fails... I'm not very familiar with Objective-C, and I'm not quite sure how to check the error - pull requests are welcome if you feel it's important.

Something went wrong with that request. Please try again.