diff --git a/README.md b/README.md index a24bcf1..c4972ee 100644 --- a/README.md +++ b/README.md @@ -205,20 +205,57 @@ Misc. Script for use from PC/Notebook, while device is in TWRP. This lists features unique to NanoDroid. -#### nanodroid-overlay +#### NanoDroid-Overlay -The `nanodroid-overlay` script handles the following features +The `nanodroid-overlay` script handles the pseudo-debloat feature (Magisk-only) -* pseudo-debloat (Magisk-only) * show the list of pseudo-debloated apps * add or remove apps from the list of pseudo-debloated apps -* add system properties (Magisk-only) -* grant signature spoofing permission to microG and Play Store if required - * both in Magisk and System Mode -* issue `nanodroid-overlay --help` for the full list of options -Full details on the nanodroid-overlay Script [> Details](doc/NanoDroidOverlay.md) -Full details on the pseudo-debloat feature [> Details](doc/PseudoDebloat.md) +Full details on the Pseudo Debloat feature [> Details](doc/PseudoDebloat.md) +Full details on the NanoDroid-Overlay Script [> Details](doc/NanoDroidOverlay.md) + +#### NanoDroid-Prop + +The `nanodroid-prop` script utilizes Magisk's resetprop to alter system properties + + * add system properties (Magisk-only) + * both on-the-fly and permanently + * properties set by this script survive NanoDroid updates + +Full details on the NanoDroid-Prop Script [> Details](doc/NanoDroidProp.md) + +#### NanoDroid-Perm + +The `nanodroid-perm` script grants microG and Co. required permissions, if lacking + +Full details on the NanoDroid-Perm Script [> Details](doc/NanoDroidPerm.md) + +#### NanoDroid-UPD + +The `nanodroid-upd` script allows to update NanoDroid's custom apks + + * Play Store + * Fake Store + * OpenLauncher + +which can't be updated through Play/Yalp Store or F-Droid otherwise + +Full details on the NanoDroid-UPD Script [> Details](doc/NanoDroidUPD.md) + +#### NanoDroid-Util + +The `nanodroid-util` script contains the following features + + * show boot count + * fix OTA update issues (like non-working navbar) + * handle Audio Focus permission + * prevent apps from stealing audio output, for example listen to Music while playing Pokémon Go + * handle Read Clipboard permission + * modify Airplane Mode settings + * choose which radios are on or off in Airplane mode + +Full details on the NanoDroid-Util Script [> Details](doc/NanoDroidUtil.md) #### init scripts @@ -229,6 +266,9 @@ The following init scripts are bundled with NanoDroid * SD Card needs to be inserted upon boot * fstrim * trim file systems (may increase speed) +* logcat + * store logcat in /data/adb + * logs older than 7 days are deleted on every reboot * logscleaner * clean up log files * sqlite diff --git a/doc/NanoDroidOverlay.md b/doc/NanoDroidOverlay.md index f876667..97aae54 100644 --- a/doc/NanoDroidOverlay.md +++ b/doc/NanoDroidOverlay.md @@ -1,29 +1,10 @@ -# nanodroid-overlay Script +# NanoDroid-Overlay Script ## Purpose -The `nanodroid-overlay` Script, respectively it's shortcut `novl` is used by NanoDroid to perform various actions. +The `nanodroid-overlay` Script, respectively it's shortcut `novl` is used by NanoDroid to handle the Pseudo Debloat Feature. -### Magisk-Only Features - -The following features are **only** available, when NanoDroid is installed as Magisk Module: - -* Pseudo-Debloat Feature -* utilize Magisk's `resetprop` feature for on-the-fly and permanently adjusting system properties - -### General Features - -The following features are available in **both** Magisk and System Mode: - -* grant signature spoofing permissions to microG GmsCore / Play Store - * on pre-patched ROMs that is -* grant required permissions to Google Sync Adapters -* fix navigation bar, status bar or lock screen issues after OTA update -* change Airplane Mode radio settings -* prevent applications from stealing audio focus -* prevent applications from reading the clipboard -* display device's boot count - * requires Android 7.0 or newer +Full details on the Pseudo Debloat feature [> Details](doc/PseudoDebloat.md) ## Invocation @@ -35,9 +16,7 @@ or `novl [switch] [parameter(s)]` -## Feature overview - -### Pseudo-Debloat feature (Magisk-Only) +## Overview `-a`, `--add` [app] @@ -70,70 +49,3 @@ remove existing Overlays `-g`, `--genconfig` (re-)create config file from existing Overlays - -### Utilize resetprop (Magisk-Only) - -`-C`, `--cast` - -set properties required to enable the cast feature on some custom ROMs - -`-A`, `--add-prop` [prop] [value] - -add a system property both on-the-fly and permanently by adding it to NanoDroid's `system.prop` file - -`-R`, `--remove-prop` [prop] - -remove a system property from NanoDroid's `system.prop` file - -`-L`, `--list-prop` - -list all properties from NanoDroid's `system.prop` file - -### Grant signature spoofing permission - -`-p`, `--permission` - -grant signature spoofing permission to microG GmsCore and Play Store; grant permission to Google Sync Adapters (if they are installed) - -### Fix OTA-Update issues - -`-f`, `--fix-update` - -fix issues with the navigation bar, status bar or lock screen after applying an OTA update; for a detailed description about this check [> XDA](https://www.xda-developers.com/broken-navigation-bar-lock-screen-ota-update/) - -### Airplane Mode settings - -`-P`, `--airplane-mode` - -change Airplane Mode settings, this is interactive, user will be given instructions what to do. This allows to change which radios are disabled by Airplane Mode **and additionally** it instructs Android that it does **not** allow re-activation of **those** radios until Airplane Mode is switched off - -### Prevent audio focus stealing - -`-F`, `--audio-focus` [app] - -some apps stop audio playback of other apps, when you bring them in foreground (or activate them in multi window mode), with this you can prevent Android from allowing this; [app] is the application name in `com.organisation.application` format, for example `com.xda.labs` - -### Prevent clipboard reading - -`-B`, `--read-clipboard` [app] - -many apps have the permission to read the clipboard for no reason, with this you can prevent Android from allowing this; [app] is the application name in `com.organisation.application` format, for example `com.xda.labs` - -**Note:** don't do this in applications like Browsers or the-like, as you'll disable the whole copy-paste feature for those app(s) with this feature - -### Read boot count - -`-b`, `--boot-count` - -show how often the device was booted; requires Anroid 7.0 or newer - -### Update custom APKs - -`-U`, `--update-apks` - -update custom NanoDroid apks: - -* Fake Store -* Play Store -* MPV -* OpenLauncher diff --git a/doc/NanoDroidPerm.md b/doc/NanoDroidPerm.md new file mode 100644 index 0000000..d35691c --- /dev/null +++ b/doc/NanoDroidPerm.md @@ -0,0 +1,21 @@ +# NanoDroid-Perm Script + +## Purpose + +The `nanodroid-perm` Script, respectively it's shortcut `npem` is used by NanoDroid to grant signature spoofing permissions to microG GmsCore / Play Store + + * on pre-patched ROMs that is + +and also required permissions to the Google Sync Adapters (if installed). + +## Invocation + +From within a terminal on your device, for example `adb shell` or `Termux` invoke the script using either + +`nanodroid-perm` + +or + +`npem` + +there are no switch or parameters diff --git a/doc/NanoDroidProp.md b/doc/NanoDroidProp.md new file mode 100644 index 0000000..5e98461 --- /dev/null +++ b/doc/NanoDroidProp.md @@ -0,0 +1,33 @@ +# NanoDroid-Prop Script + +## Purpose + +The `nanodroid-prop` Script, respectively it's shortcut `nprp` is used by NanoDroid to utilize Magisk's `resetprop` feature for on-the-fly and permanently adjusting system properties. Properties set by this script survive NanoDroid updates + +## Invocation + +From within a terminal on your device, for example `adb shell` or `Termux` invoke the script using either + +`nanodroid-prop [switch] [parameter(s)]` + +or + +`nprp [switch] [parameter(s)]` + +## Overview + +`-C`, `--cast` + +set properties required to enable the cast feature on some custom ROMs + +`-A`, `--add-prop` [prop] [value] + +add a system property both on-the-fly and permanently by adding it to NanoDroid's `system.prop` file + +`-R`, `--remove-prop` [prop] + +remove a system property from NanoDroid's `system.prop` file + +`-L`, `--list-prop` + +list all properties from NanoDroid's `system.prop` file diff --git a/doc/NanoDroidUPD.md b/doc/NanoDroidUPD.md new file mode 100644 index 0000000..9f609d4 --- /dev/null +++ b/doc/NanoDroidUPD.md @@ -0,0 +1,25 @@ +# NanoDroid-UPD Script + +## Purpose + +The `nanodroid-upd` Script, respectively it's shortcut `nupd` is used by NanoDroid to update NanoDroid's custom apks + + * Fake Store + * Play Store + * OpenLauncher + +Applications are only updated if they are installed already during NanoDroid installation + +## Invocation + +From within a terminal on your device, for example `adb shell` or `Termux` invoke the script using either + +`nanodroid-upd [apk]` + +or + +`nupd [apk]` + +where **apk** can be + +`ps`, `playstore`, `fs`, `fakestore`, `ol`, `openlauncher` diff --git a/doc/NanoDroidUtil.md b/doc/NanoDroidUtil.md new file mode 100644 index 0000000..7477b33 --- /dev/null +++ b/doc/NanoDroidUtil.md @@ -0,0 +1,56 @@ +# NanoDroid-Util Script + +## Purpose + +The `nanodroid-util` Script, respectively it's shortcut `nutl` is used by NanoDroid to perform various actions: + +* fix navigation bar, status bar or lock screen issues after OTA update +* change Airplane Mode radio settings +* prevent applications from stealing audio focus +* prevent applications from reading the clipboard +* display device's boot count + * requires Android 7.0 or newer + +## Invocation + +From within a terminal on your device, for example `adb shell` or `Termux` invoke the script using either + +`nanodroid-util [switch] [parameter(s)]` + +or + +`nutl [switch] [parameter(s)]` + +## Feature overview + +### Fix OTA-Update issues + +`-f`, `--fix-update` + +fix issues with the navigation bar, status bar or lock screen after applying an OTA update; for a detailed description about this check [> XDA](https://www.xda-developers.com/broken-navigation-bar-lock-screen-ota-update/) + +### Airplane Mode settings + +`-P`, `--airplane-mode` + +change Airplane Mode settings, this is interactive, user will be given instructions what to do. This allows to change which radios are disabled by Airplane Mode **and additionally** it instructs Android that it does **not** allow re-activation of **those** radios until Airplane Mode is switched off + +### Prevent audio focus stealing + +`-F`, `--audio-focus` [app] + +some apps stop audio playback of other apps, when you bring them in foreground (or activate them in multi window mode), with this you can prevent Android from allowing this; [app] is the application name in `com.organisation.application` format, for example `com.xda.labs` + +### Prevent clipboard reading + +`-B`, `--read-clipboard` [app] + +many apps have the permission to read the clipboard for no reason, with this you can prevent Android from allowing this; [app] is the application name in `com.organisation.application` format, for example `com.xda.labs` + +**Note:** don't do this in applications like Browsers or the-like, as you'll disable the whole copy-paste feature for those app(s) with this feature + +### Read boot count + +`-b`, `--boot-count` + +show how often the device was booted; requires Anroid 7.0 or newer