Document public compatibility scope

This commit is contained in:
ajp_anton
2026-06-01 02:52:03 +00:00
parent 8afe6a00e8
commit 6d6ee64275
+16 -3
View File
@@ -4,8 +4,8 @@ StatusBarTweak is an Xposed/LSPosed module for Samsung SystemUI. It focuses on
making the status bar, lockscreen, and Always On Display more configurable while making the status bar, lockscreen, and Always On Display more configurable while
still keeping Samsung's own icons and visual style where possible. still keeping Samsung's own icons and visual style where possible.
The project is mainly built for personal Samsung devices and is still evolving. The project is currently tested only on a Samsung Galaxy Z Fold5 running One UI
Expect device- and One UI-version-specific behaviour. 8.0 / Android 16. Expect device- and One UI-version-specific behaviour.
## What It Does ## What It Does
@@ -48,11 +48,24 @@ The in-app clock page has the full syntax help and examples.
- A rooted Samsung device. - A rooted Samsung device.
- A modern Xposed implementation such as LSPosed. - A modern Xposed implementation such as LSPosed.
- Android/One UI versions close to the versions this module is tested on. - Xposed API 101 or newer.
- A Samsung/One UI version close to One UI 8.0 / Android 16.
This module hooks Samsung SystemUI internals. It is not expected to work on This module hooks Samsung SystemUI internals. It is not expected to work on
non-Samsung SystemUI, and updates to One UI may require fixes. non-Samsung SystemUI, and updates to One UI may require fixes.
## Device Compatibility
StatusBarTweak is Samsung-specific in its current form. Some lower-level ideas,
such as drawing a custom battery bar or parsing custom clock text, could be
ported elsewhere. The layout engine itself depends on Samsung's SystemUI,
lockscreen, AOD service, notification display modes, status icons, and status
chip implementation.
Plain Android or other OEM skins would need separate hooks and probably a
different source-collection layer. They should be treated as unsupported rather
than untested-compatible.
## Build ## Build
The project is a standard Gradle Android project: The project is a standard Gradle Android project: