diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..e6a62c1 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +*.webm filter=lfs diff=lfs merge=lfs -text +*.png filter=lfs diff=lfs merge=lfs -text diff --git a/README.md b/README.md index 5086f93..ca3c24d 100644 --- a/README.md +++ b/README.md @@ -19,9 +19,11 @@ or write your own. ### Home screen +![Home screen at 3:00 PM showing the following set of activities: Tux Math, Putt Putt Joins the Circus, Secret of Monkey Island, GCompris, Minecraft, Celeste, A Short Hike, Big Buck Bunny, and Lofi Beats.](./docs/readme/home-normal.png) + Activities can be made selectively available at certain times of day. -TODO: home screen at different times (bedtime vs afternoon) showing different applications +![Home screen at 9:00 PM showing Lofi Beats as the only available activity.](./docs/readme/home-normal.png) ### Time limits @@ -30,22 +32,39 @@ Activities can have configurable time limits, including: * total usage per day * cooldown periods before that particular activity can be restarted -TODO: GIF or video of GCompris a few seconds from closing, emphasizing: -* Countdown clock -* Warning messaging -* Automatic close at end of time -* Icon deliberately missing afterwards -- cooldown + ### Anything on Linux If it can run on Linux in *any way, shape, or form*, it can be supervised by `shepherd-launcher`. -TODO: show the following running with some subset of the above features highlighted: -* Media (Big Buck Bunny locally, YouTube via `mpv`) -* ScummVM games (Putt Putt, Secret of Monkey Island) -* Minecraft -* Steam games (Celeste, A Short Hike) +!["Big Buck Bunny" hosted within shepherd-launcher UI](./docs/readme/apps-media.jpg) + +> [Big Buck Bunny](https://peach.blender.org/) playing locally via `mpv` + +!["Putt Putt Joins the Circus" hosted within shepherd-launcher UI](./docs/readme/apps-puttputt.png) + +> [Putt Putt Joins the Circus](https://humongous.fandom.com/wiki/Putt-Putt_Joins_the_Circus) +> running via [ScummVM](https://www.scummvm.org/) + +!["The Secret of Monkey Island" hosted within shepherd-launcher UI](./docs/readme/apps-monkey.png) + +> [The Secret of Monkey Island](https://en.wikipedia.org/wiki/The_Secret_of_Monkey_Island) +> running via [ScummVM](https://www.scummvm.org/) + +![Minecraft hosted within shepherd-launcher UI](./docs/readme/apps-minecraft.jpg) + +> [Minecraft](https://www.minecraft.net/) running via the +> [mc-installer Snap](https://snapcraft.io/mc-installer) + +![Celeste hosted within shepherd-launcher UI](./docs/readme/apps-celeste.png) + +> [Celeste](https://www.celestegame.com/) running via Steam + +![A Short Hike hosted within shepherd-launcher UI](./docs/readme/apps-ashorthike.png) + +> [A Short Hike](https://ashorthike.com/) running via Steam Contributions are welcome for improvements and not yet implemented backends, such as: diff --git a/docs/readme/apps-ashorthike.png b/docs/readme/apps-ashorthike.png new file mode 100644 index 0000000..bae7318 --- /dev/null +++ b/docs/readme/apps-ashorthike.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:15cc537e452ef16c55098e2bc82fcb87a760b23a7fb59077dac00c7a39749cda +size 111178 diff --git a/docs/readme/apps-celeste.png b/docs/readme/apps-celeste.png new file mode 100644 index 0000000..1ab78b6 --- /dev/null +++ b/docs/readme/apps-celeste.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c92028ee61aed617789f9bd603ceb9300f61b7a73a1b002f4c3f6a77e53032a5 +size 134193 diff --git a/docs/readme/apps-media.jpg b/docs/readme/apps-media.jpg new file mode 100644 index 0000000..ee76071 Binary files /dev/null and b/docs/readme/apps-media.jpg differ diff --git a/docs/readme/apps-minecraft.jpg b/docs/readme/apps-minecraft.jpg new file mode 100644 index 0000000..4a21d47 Binary files /dev/null and b/docs/readme/apps-minecraft.jpg differ diff --git a/docs/readme/apps-monkey.png b/docs/readme/apps-monkey.png new file mode 100644 index 0000000..3c1320d --- /dev/null +++ b/docs/readme/apps-monkey.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fc36d426375c5d92202b1ba86fb0bdcbe3a5d3cf41d2feffa27b01dbab1abccd +size 100327 diff --git a/docs/readme/apps-puttputt.png b/docs/readme/apps-puttputt.png new file mode 100644 index 0000000..451112d --- /dev/null +++ b/docs/readme/apps-puttputt.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:51cc707191226f4b7a9f86345a7b1d7489908c00931214f48937f7b85625399b +size 262556 diff --git a/docs/readme/home-bedtime.png b/docs/readme/home-bedtime.png new file mode 100644 index 0000000..7e3627f --- /dev/null +++ b/docs/readme/home-bedtime.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:15092cb2c5ff8cfa6ecae1381af0933b43e94fae318ffc0b0aeb769dcafc1e07 +size 26903 diff --git a/docs/readme/home-normal.png b/docs/readme/home-normal.png new file mode 100644 index 0000000..bba6a12 --- /dev/null +++ b/docs/readme/home-normal.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fb3c2527d197b3d582199396d60b06664f1c98a28451a93d8def9d32656933ab +size 107103 diff --git a/docs/readme/tuxmath-expiring.webm b/docs/readme/tuxmath-expiring.webm new file mode 100644 index 0000000..86b559a --- /dev/null +++ b/docs/readme/tuxmath-expiring.webm @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a18e54591716d9ce89098d556c12c9e54e43645e15fa41ce4f3097218b7b2fe2 +size 1579062