Skip to content

Commit 0a33e4d

Browse files
author
Aaron Gotwalt
committed
Verified running in 1.9.3, added readme
1 parent ebefd9c commit 0a33e4d

File tree

4 files changed

+33
-3
lines changed

4 files changed

+33
-3
lines changed

.ruby-version

Lines changed: 0 additions & 1 deletion
This file was deleted.

Procfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
web: pushd assets; python -m SimpleHTTPServer 3100
1+
web: pushd assets; python -m SimpleHTTPServer 3169
22
daemon: bundle exec bin/ghosty daemon

Readme.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Ghosty
2+
Ghosty is a ghost for your Sonos system. It wakes up at night and plays scary noises at low volumes on randomly selected speakers. It covers its tracks, and tries not to play so frequently that it becomes predictable. Really, the only way to know for sure that it's responsible for the sound you're hearing is to watch the Sonos controller as it's happening.
3+
4+
Ghosty turns any Sonos-powered home into the haunted house of the future. This is meant to be funny, not mean spirited. Please use it in hilarious, good-natured ways.
5+
6+
## Requirements
7+
* Ruby
8+
* Python (used to serve audio assets)
9+
10+
## Configuration
11+
*./config.yml* is used to configure runtime parameters.
12+
13+
* **port** sets the HTTP port that the daemon will expect files to be served from.
14+
* **valid_hours** controls the hours during which the ghost is active.
15+
* **minimum_frequency** controls how frequently the ghost will appear.
16+
17+
## Running
18+
For normal ghost operations, `foreman start` will start a simple HTTP server to serve files and launch the daemon, which will randomly schedule plays. Ghosty keeps a log of plays in *./ghosty.log*.
19+
20+
## CLI Methods
21+
* `ghosty daemon` - starts the scheduling daemon
22+
* `ghosty trigger` - immediately triggers a single play
23+
* `ghosty cli` - launches an IRB session with classes preloaded
24+
25+
## Contributing
26+
27+
1. Fork it
28+
2. Create your feature branch (`git checkout -b my-new-feature`)
29+
3. Commit your changes (`git commit -am 'Add some feature'`)
30+
4. Push to the branch (`git push origin my-new-feature`)
31+
5. Create new Pull Request

config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
port: 3100
1+
port: 3169
22
valid_hours:
33
- 20
44
- 21

0 commit comments

Comments
 (0)