mirror of
https://github.com/sudoxnym/nightd.git
synced 2026-07-14 18:22:02 +00:00
styled readme
This commit is contained in:
parent
86827b4dd3
commit
69f3f39475
1 changed files with 66 additions and 14 deletions
80
README.md
80
README.md
|
|
@ -1,30 +1,82 @@
|
||||||
# nightd
|
<div align="center">
|
||||||
|
|
||||||
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)
|
[](https://github.com/sudoxnym/nightd/releases/latest)
|
||||||
|
[](https://sudoxnym.github.io/fdroid-repo)
|
||||||
|
[](LICENSE)
|
||||||
|
|
||||||
## install
|
*blacks out the display while keeping media playing. perfect for falling asleep to music without screen burn or light pollution.*
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
## ✨ 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
|
```bash
|
||||||
adb install nightd.apk
|
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.
|
<a href="https://sudoxnym.github.io/fdroid-repo">
|
||||||
|
<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" height="60">
|
||||||
|
</a>
|
||||||
|
|
||||||
|
## ⚙️ 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:
|
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
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|
made by [sudoxnym](https://sudoxreboot.com) ⚡
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue