You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
NanoDroid/doc/AlterInstallation.md

158 lines
3.9 KiB
Markdown

# Alter Installation
## Configuration File
To alter the installation you can create the file
`.nanodroid-setup`
on your device, in one of the following directories
* `/sdcard` (internal storage)
* `/external_sd` (TWRP path to SD Card (if any))
* directory containing the zip file
* `/data` (fallback)
create it manually with the following content for the **full** package
```
nanodroid_microg=1
nanodroid_gmscore=0
nanodroid_fdroid=1
nanodroid_apps=1
nanodroid_play=10
nanodroid_overlay=1
nanodroid_zelda=1
nanodroid_mapsv1=1
nanodroid_init=1
nanodroid_gsync=0
nanodroid_swipe=0
nanodroid_forcesystem=0
nanodroid_nlpbackend=100
nanodroid_bash=1
nanodroid_nano=1
nanodroid_utils=1
nanodroid_fonts=1
nanodroid_override=0
```
the **microG** package supports the following options (nanodroid_microg is always 1)
```
nanodroid_gmscore=0
nanodroid_play=10
nanodroid_overlay=0
nanodroid_mapsv1=1
nanodroid_gsync=0
nanodroid_swipe=0
nanodroid_forcesystem=0
nanodroid_nlpbackend=100
```
the **F-Droid** (nanodroid_fdroid is always 1) and **Bromite WebView** pckage supports the following options
```
nanodroid_forcesystem=0
```
where `1` means `on` and `0` means `off`. If no `.nanodroid-setup` is found, the [default settings](.nanodroid-setup) will be used (equals to the example above), if your `.nanodroid-setup` file exists, but is missing entries, those entries will be added, using the default values.
Alternatively you can also use the NanoDroid-SetupWizard package instead of manual creation of the configuration file.
## Detailed Description
`nanodroid_microg=[0|1|2]`
whether to provide **microG**
* 0 = don't install microG at all
* 1 = install microG GmsCore, GsfProxy and DroidGuard Helper and Nominatim Geocoder Backend
* 2 = install microG GmsCore and Nominatim Geocoder Backend only
* note: OpenSource purists setting; this will leave you
* without Push Messaging support through GCM
* without the ability to pass SafetyNet attestation
`nanodroid_gmscore=[0|1]`
which microG GmsCore to install
* 0 = install NanoDroid's [custom microG GmsCore](https://github.com/Nanolx/android_packages_apps_GmsCore)
* 1 = install [official microG GmsCore](https://github.com/microg/android_packages_apps_GmsCore)
`nanodroid_fdroid=[0|1]`
whether to provide **F-Droid**
`nanodroid_apps=[0|1]`
whether to provide included applications [> Details](doc/Applications.md)
`nanodroid_override=[0|1]`
whether to override an already existing app.
`0` means that a ROM app is preferred against a NanoDroid app, where `1` means the NanoDroid app is prefered. This applies to included applications [> Details](doc/Applications.md)
`nanodroid_play=[0|1|2|3][0|1]`
what app store to use:
* 1st item
* 0 = No App Store
* 1 = Play Store
* 2 = Yalp Store
* 3 = Aurora Store
* 2nd item
* 0 = without Fake Store
* 1 = with Fake Store
`nanodroid_overlay=[0|1]`
whether to populate the overlay to pseudo-debloat `/system` applications (Magisk-only)
`nanodroid_zelda=[0|1]`
whether to provide The Legend of Zelda ringtones and sounds
`nanodroid_mapsv1=[0|1]`
whether to provide **microG** Maps API v1
`nanodroid_init=[0|1]`
whether to provide init scripts
`nanodroid_gsync=[0|1]`
whether to provide Google Sync Adapters
`nanodroid_swipe=[0|1]`
whether to provide Swipe libraries
`nanodroid_forcesystem=[0|1]`
whether to force system mode installation, regardless whether Magisk is installed
`nanodroid_nlpbackend=[0|1][0|1][0|1]`
what location backends for microG to install
* 1st element 0|1 = Déjà Vu location backend
* 2nd element 0|1 = Ichnaea (Mozilla) location backend
* 3rd element 0|1 = Apple location backend
`nanodroid_bash=[0|1]`
whether to install GNU Bash Shell
`nanoroid_nano=[0|1]`
whether to install GNU Nano Editor
`nanodroid_utils=[0|1]`
whether to install Shell Utils from util-linux and bsdmainutils
`nanodroid_fonts=[0|1]`
whether to install [NanoDroid-Font](NanoDroidFont.md) script and Nintendo Fonts