+
+## Features
+
+- One-tap timers (1/5/10/15/30 min by default), plus custom ones with hours, minutes
+ and seconds. Long-press any timer to delete it.
+- **Quick Settings tile** "Color break": starts a break of the last length used; tap
+ again to end it early.
+- **Launcher shortcuts**: long-press the app icon to start a timer directly.
+- **Countdown notification** with *Grayscale now* and *+5 min*.
+- **Color apps** (optional): apps like your gallery or camera are always shown in
+ color. Uses an accessibility service that only sees which app is in front.
+- Reboot-safe: a running break is re-armed, or grayscale restored if time ran out.
+
+No internet permission, no tracking, no dependencies beyond the Shizuku client library.
+
+## Setup: the one permission
+
+Grayscale is a secure system setting (`accessibility_display_daltonizer*`), so the app
+needs `WRITE_SECURE_SETTINGS`. Android has no switch for it in Settings; grant it once:
+
+- **Shizuku**: start [Shizuku](https://shizuku.rikka.app/), open GrayPause, tap
+ *Grant with Shizuku*. Shizuku can be stopped afterwards.
+- **adb**:
+ ```
+ adb shell pm grant com.lpw.graypause android.permission.WRITE_SECURE_SETTINGS
+ ```
+
+The grant survives reboots and app updates (not an uninstall).
+
+## Building
+
+Standard Gradle project (JDK 17+, Android SDK 36):
+
+```
+gradle assembleRelease # or ./gradlew
+```
+
+`build.sh` is an alternative Gradle-free debug build used to develop the app directly
+on a phone in Termux (native `aapt2`/`javac`/`apksigner`, `d8` from the SDK). It needs no
+Android Studio, and `tools/ZipAlign.java` stands in for `zipalign`.
+
+## F-Droid
+
+Store texts, icon and screenshots are in `fastlane/metadata/android/en-US/` (F-Droid
+reads them from the source tree). The draft fdroiddata recipe is
+`fdroid/com.lpw.graypause.yml`; releases are tagged `vX.Y`.
+
+## License
+
+GPL-3.0-or-later, see [LICENSE](LICENSE).
diff --git a/app/build.gradle b/app/build.gradle
new file mode 100644
index 0000000..9c4d73c
--- /dev/null
+++ b/app/build.gradle
@@ -0,0 +1,39 @@
+plugins {
+ id "com.android.application"
+}
+
+android {
+ namespace "com.lpw.graypause"
+ compileSdk 36
+
+ defaultConfig {
+ applicationId "com.lpw.graypause"
+ minSdk 33
+ targetSdk 36
+ versionCode 5
+ versionName "1.4"
+ }
+
+ buildTypes {
+ release {
+ minifyEnabled false
+ }
+ }
+
+ compileOptions {
+ sourceCompatibility JavaVersion.VERSION_17
+ targetCompatibility JavaVersion.VERSION_17
+ }
+
+ // F-Droid: no Google-encrypted dependency metadata blob in the APK.
+ dependenciesInfo {
+ includeInApk false
+ includeInBundle false
+ }
+}
+
+dependencies {
+ def shizuku = "13.1.5"
+ implementation "dev.rikka.shizuku:api:$shizuku"
+ implementation "dev.rikka.shizuku:provider:$shizuku"
+}
diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml
new file mode 100644
index 0000000..3523cb6
--- /dev/null
+++ b/app/src/main/AndroidManifest.xml
@@ -0,0 +1,86 @@
+
+
+Grayscale makes a phone much less tempting to pick up. The hard part is the moment you need color for a minute — a photo, a map, a chart — and then forget to turn grayscale back on.
+ +GrayPause gives you color breaks: grayscale switches off for the time you choose and comes back on by itself.
+ +-
+
- One-tap timers — 1, 5, 10, 15, 30 min by default. Add your own with hours, minutes and seconds; delete any of them. +
- Quick Settings tile — starts a break of the last length you used; tap again to end it early. +
- App shortcuts — long-press the launcher icon to start a timer without opening the app. +
- Countdown notification with "Grayscale now" and "+5 min" buttons. +
- Color apps (optional) — pick apps such as your gallery or camera that are always shown in color. Grayscale switches off while one of them is open and back on when you leave it. +
- Survives reboots: a running break is resumed, or grayscale restored if the time is up. +
One-time setup. Android only lets system apps switch grayscale, so GrayPause needs the WRITE_SECURE_SETTINGS permission. It cannot be granted from Settings, only once, either:
+-
+
- with Shizuku running: tap "Grant with Shizuku" in the app, or +
- over adb: adb shell pm grant com.lpw.graypause android.permission.WRITE_SECURE_SETTINGS +
The permission is kept across reboots and updates; Shizuku is not needed afterwards.
+ +Accessibility service. The optional "Color apps" feature uses an accessibility service only to learn which app is in the foreground. It does not read screen content, and nothing leaves your device: GrayPause has no internet permission.
diff --git a/fastlane/metadata/android/en-US/images/icon.png b/fastlane/metadata/android/en-US/images/icon.png new file mode 100644 index 0000000..8474d73 Binary files /dev/null and b/fastlane/metadata/android/en-US/images/icon.png differ diff --git a/fastlane/metadata/android/en-US/images/phoneScreenshots/1_main.jpg b/fastlane/metadata/android/en-US/images/phoneScreenshots/1_main.jpg new file mode 100755 index 0000000..6436b3b Binary files /dev/null and b/fastlane/metadata/android/en-US/images/phoneScreenshots/1_main.jpg differ diff --git a/fastlane/metadata/android/en-US/images/phoneScreenshots/2_notification.jpg b/fastlane/metadata/android/en-US/images/phoneScreenshots/2_notification.jpg new file mode 100755 index 0000000..7fec7e3 Binary files /dev/null and b/fastlane/metadata/android/en-US/images/phoneScreenshots/2_notification.jpg differ diff --git a/fastlane/metadata/android/en-US/short_description.txt b/fastlane/metadata/android/en-US/short_description.txt new file mode 100644 index 0000000..9e810f2 --- /dev/null +++ b/fastlane/metadata/android/en-US/short_description.txt @@ -0,0 +1 @@ +Keep your phone in grayscale, take short color breaks that end by themselves diff --git a/fastlane/metadata/android/en-US/title.txt b/fastlane/metadata/android/en-US/title.txt new file mode 100644 index 0000000..fd7c12c --- /dev/null +++ b/fastlane/metadata/android/en-US/title.txt @@ -0,0 +1 @@ +GrayPause diff --git a/fdroid/com.lpw.graypause.yml b/fdroid/com.lpw.graypause.yml new file mode 100644 index 0000000..4efd343 --- /dev/null +++ b/fdroid/com.lpw.graypause.yml @@ -0,0 +1,26 @@ +# Draft for https://gitlab.com/fdroid/fdroiddata (metadata/com.lpw.graypause.yml). +Categories: + - System + - Theming +License: GPL-3.0-or-later +AuthorName: metaheavens +SourceCode: https://metaheavens.de/forgejo/metaheavens/graypause +IssueTracker: https://metaheavens.de/forgejo/metaheavens/graypause/issues + +AutoName: GrayPause + +RepoType: git +Repo: https://metaheavens.de/forgejo/metaheavens/graypause.git + +Builds: + - versionName: '1.4' + versionCode: 5 + commit: v1.4 + subdir: app + gradle: + - yes + +AutoUpdateMode: Version +UpdateCheckMode: Tags +CurrentVersion: '1.4' +CurrentVersionCode: 5 diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..34e2ae5 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,5 @@ +org.gradle.jvmargs=-Xmx1536m -Dfile.encoding=UTF-8 +android.useAndroidX=true +android.nonTransitiveRClass=true +# AGP 8.6 has not caught up with API 36 yet; it builds fine, this only silences the warning. +android.suppressUnsupportedCompileSdk=36 diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..a4b76b9 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..e2847c8 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.11.1-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..f5feea6 --- /dev/null +++ b/gradlew @@ -0,0 +1,252 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s +' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..9b42019 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,94 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..d46d182 --- /dev/null +++ b/settings.gradle @@ -0,0 +1,16 @@ +pluginManagement { + repositories { + google() + mavenCentral() + gradlePluginPortal() + } +} +dependencyResolutionManagement { + repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) + repositories { + google() + mavenCentral() + } +} +rootProject.name = "GrayPause" +include ":app" diff --git a/tools/ZipAlign.java b/tools/ZipAlign.java new file mode 100644 index 0000000..b9a0d2c --- /dev/null +++ b/tools/ZipAlign.java @@ -0,0 +1,55 @@ +import java.io.*; +import java.util.*; +import java.util.zip.*; + +/** + * Minimal zipalign: copies a zip, padding STORED entries so their data is 4-byte aligned, + * and appends any extra files given after the output path (compressed, at the zip root). + */ +public class ZipAlign { + public static void main(String[] a) throws IOException { + try (ZipFile in = new ZipFile(a[0]); + CountingOut cnt = new CountingOut(new BufferedOutputStream(new FileOutputStream(a[1]))); + ZipOutputStream out = new ZipOutputStream(cnt)) { + for (ZipEntry e : Collections.list(in.entries())) { + ZipEntry n = new ZipEntry(e.getName()); + n.setMethod(e.getMethod()); + n.setTime(946684800000L); // 2000-01-01, inside the DOS date range (no extra timestamp field) + if (e.getMethod() == ZipEntry.STORED) { + n.setSize(e.getSize()); + n.setCompressedSize(e.getSize()); + n.setCrc(e.getCrc()); + out.flush(); + long dataStart = cnt.count + 30 + n.getName().getBytes("UTF-8").length; + int pad = (int) ((4 - dataStart % 4) % 4); + if (pad > 0) n.setExtra(padExtra(pad)); + } + out.putNextEntry(n); + in.getInputStream(e).transferTo(out); + out.closeEntry(); + } + for (int i = 2; i < a.length; i++) { + File f = new File(a[i]); + ZipEntry n = new ZipEntry(f.getName()); + n.setTime(946684800000L); + out.putNextEntry(n); + try (InputStream fin = new FileInputStream(f)) { fin.transferTo(out); } + out.closeEntry(); + } + } + } + + // An extra field needs a 4-byte header, so use one field of pad+4 bytes (Android's 0xD935 alignment tag). + static byte[] padExtra(int pad) { + byte[] x = new byte[pad + 4]; + x[0] = 0x35; x[1] = (byte) 0xD9; x[2] = (byte) pad; + return x; + } + + static class CountingOut extends FilterOutputStream { + long count; + CountingOut(OutputStream o) { super(o); } + @Override public void write(int b) throws IOException { out.write(b); count++; } + @Override public void write(byte[] b, int off, int len) throws IOException { out.write(b, off, len); count += len; } + } +}