From 69f3f394756c1b5ba67cac2f7c75da5ffce0d985 Mon Sep 17 00:00:00 2001 From: sudoxnym Date: Mon, 8 Dec 2025 21:49:34 +0100 Subject: [PATCH] styled readme --- README.md | 80 +++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 66 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index bff0fd1..d086c8d 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,82 @@ -# nightd +
-screen dimmer for android tv. keeps media playing while the screen goes dark. +# 🌙 nightd -## download +**screen dimmer for android tv** -[nightd.apk](https://github.com/sudoxnym/nightd/releases/latest) +[![GitHub release](https://img.shields.io/github/v/release/sudoxnym/nightd?color=00ffff&style=for-the-badge)](https://github.com/sudoxnym/nightd/releases/latest) +[![F-Droid](https://img.shields.io/badge/F--Droid-repo-b400ff?style=for-the-badge)](https://sudoxnym.github.io/fdroid-repo) +[![License](https://img.shields.io/badge/license-MIT-ff00ff?style=for-the-badge)](LICENSE) -## install +*blacks out the display while keeping media playing. perfect for falling asleep to music without screen burn or light pollution.* +--- + +
+ +## ✨ features + +- **dim mode** — single overlay layer for reduced brightness +- **black mode** — full blackout while audio continues +- **toggle hotkey** — cycles through off → dim → black +- **no root required** — just overlay permission +- **tv remote friendly** — works with key mapper + +## 📥 install + +### option 1: github releases ```bash adb install nightd.apk ``` +[⬇️ download latest apk](https://github.com/sudoxnym/nightd/releases/latest) -grant "display over other apps" permission when prompted. +### option 2: f-droid repo -## usage +add this repo to f-droid or neostore: +``` +https://sudoxnym.github.io/fdroid-repo/repo +``` -use [key mapper](https://github.com/keymapperorg/KeyMapper) to bind to a remote button. + + + + +## ⚙️ setup + +1. install the apk +2. open nightd and grant **"display over other apps"** permission +3. use [key mapper](https://github.com/keymapperorg/KeyMapper) to bind to a remote button + +### key mapper config set up an **activity** intent: -- **action:** `com.sudoxnym.nightd.TOGGLE` -- **package:** `com.sudoxnym.nightd` -- **class:** `com.sudoxnym.nightd.ToggleActivity` -other actions: `OFF`, `DIM`, `BLACK` +| field | value | +|-------|-------| +| action | `com.sudoxnym.nightd.TOGGLE` | +| package | `com.sudoxnym.nightd` | +| class | `com.sudoxnym.nightd.ToggleActivity` | -## license +**available actions:** +- `TOGGLE` — cycle through modes +- `DIM` — single layer dim +- `BLACK` — full blackout +- `OFF` — disable overlay -MIT +## 🎮 usage + +- press your mapped button to cycle: **off → dim → black → off** +- press **back** on remote to turn off overlay from any mode +- tap notification to disable + +## 📜 license + +MIT — do whatever you want with it + +--- + +
+ +made by [sudoxnym](https://sudoxreboot.com) ⚡ + +