Homescreen NPM

Homescreen

Homescreen is an application launcher intended for use in HTPC situation.

Installation

Install with npm:

$ npm install -g homescreen

Usage

Run with the homescreen command:

$ homescreen

Configuration

The configuration file tells homescreen which launchers to display. A configuration file can either be specified as a parameter at runtime, specified in the HOMESCREEN_CONFIG environment variable, or by putting a .homescreen.json file in the user's home directory.

Example

{
	"launchers": [
		{
			"title": "TV",
			"icon": "fa-tv",
			"cmd": "/path/to/executable/to/launch --with-params"
		},
		{...}
	]
}

Usage

Implicitly using the .homescreen.json file in your home directory:

$ homescreen

As an argument:

$ homescreen path/to/config/file.json

As an environment variable:

$ HOMESCREEN_CONFIG=path/to/config/file.json homescreen

Contributions

Contributions are welcome! Fork and send a PR and I'll see about merging.

Bugs and Feedback

If you see a bug or have a suggestion, feel free to create an issue here.

License

Unlicense. This is a Public Domain work.

"Make art not law" -Nina Paley