Skip to content

Commit 697516a

Browse files
README overhaul
1 parent 489f94a commit 697516a

File tree

2 files changed

+96
-54
lines changed

2 files changed

+96
-54
lines changed

.vscode/settings.json

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,6 @@
1111
"files.insertFinalNewline": true,
1212
"files.trimFinalNewlines": true,
1313
"files.trimTrailingWhitespace": true,
14-
// markdown
15-
"[markdown]": {
16-
"files.trimTrailingWhitespace": false
17-
},
1814
// html / xml
1915
"html.format.enable": true,
2016
"html.format.indentInnerHtml": true,

README.md

Lines changed: 96 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -5,72 +5,97 @@ This is an updated and enhanced `ViPER4Android FX 2.7` installer. \
55
It contains many useability enhancements and all the major fixes needed to run `ViPER4Android` on modern ROMs effortlessly.
66

77
![GitHub Latest Release (by date)](https://img.shields.io/github/v/release/programminghoch10/ViPER4AndroidRepackaged?label=latest&logo=github&display_name=release)
8-
![GitHub Latest Release Date](https://img.shields.io/github/release-date/programminghoch10/ViPER4AndroidRepackaged?logo=github)
9-
8+
![GitHub Latest Release Date](https://img.shields.io/github/release-date/programminghoch10/ViPER4AndroidRepackaged?logo=github) \
109
![GitHub Global Download Counter](https://img.shields.io/github/downloads/programminghoch10/Viper4AndroidRepackaged/total?logo=github)
11-
![GitHub Latest Download Counter](https://img.shields.io/github/downloads/programminghoch10/Viper4AndroidRepackaged/latest/total?logo=github)
12-
10+
![GitHub Latest Download Counter](https://img.shields.io/github/downloads/programminghoch10/Viper4AndroidRepackaged/latest/total?logo=github) \
1311
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/programminghoch10/ViPER4AndroidRepackaged/build.yml?logo=github%20actions&logoColor=white)
1412
![GitHub commits since last release](https://img.shields.io/github/commits-since/programminghoch10/ViPER4AndroidRepackaged/latest?logo=git&logoColor=white)
15-
![GitHub last commit](https://img.shields.io/github/last-commit/programminghoch10/ViPER4AndroidRepackaged?logo=git&logoColor=white)
16-
17-
![GitHub Repo stars](https://img.shields.io/github/stars/programminghoch10/ViPER4AndroidRepackaged?style=social)
13+
![GitHub last commit](https://img.shields.io/github/last-commit/programminghoch10/ViPER4AndroidRepackaged?logo=git&logoColor=white) \
14+
![GitHub Repo stars](https://img.shields.io/github/stars/programminghoch10/ViPER4AndroidRepackaged?style=social) \
1815
[![GitHub followers](https://img.shields.io/github/followers/programminghoch10?style=social)](https://github.com/programminghoch10)
1916

2017
## Features
2118

2219
* **Install `ViPER4Android` in one go** \
2320
No need for additional modules or multiple reboots.
2421
* **Quick install** \
25-
The installer is much faster, because a lot of unnecessary checks, conversions and pauses have been removed.
22+
The entire install procedure has been rewritten from the ground up
23+
to be quick, simple and robust.
2624
* **`ViPER4Android` APK included** \
27-
There is no longer a need for an active internet connection during install, as the [`ViPER4Android` APK](https://zackptg5.com/downloads/v4afx.apk) is included in the install zip.
25+
There is no longer a need for an active internet connection during install,
26+
as the [`ViPER4Android` APK](https://zackptg5.com/downloads/v4afx.apk)
27+
is included in the install zip.
2828
* **Automatic seamless ViPER driver install** \
29-
This installer installs the ViPER driver seamlessly during module installation, there is no need to have the app install the driver.
29+
This installer installs the ViPER driver seamlessly during module installation,
30+
there is no need to have the app install the driver.
3031
* **`MagiskPolicy` included** \
31-
The necessary `SELinux` rules for running on modern Android ROMs are included, there is no need for [`Audio Compatibility Patch`](https://github.com/Magisk-Modules-Repo/acp) anymore.
32+
The necessary `SELinux` rules for running on modern Android ROMs are included,
33+
there is no need for [`Audio Compatibility Patch`](https://github.com/Magisk-Modules-Repo/acp) anymore.
3234
* **Enforce the law** \
33-
This installer does not require switching `SELinux` to `permissive` temporarily for installing the APK, which mostly helps with devices where `permissive` has been disabled in the kernel.
35+
This installer does not require switching `SELinux` to
36+
[`permissive`](https://stopdisablingselinux.com/)
37+
temporarily for installing the APK,
38+
which mostly helps with devices where `permissive` has been disabled in the kernel.
3439
* **Old folder gone legacy** \
35-
The old folder `ViPER4Android` in your personal files has been redundant for long time already, as all files have been moved to the new scoped storage location anyways.
36-
This installer doesn't depend on the old folder anymore, you can safely delete it and not have it clutter your files anymore.
40+
The old folder `ViPER4Android` in your personal files has been redundant for long time already,
41+
as all files have been moved to the new scoped storage location anyways. \
42+
This installer doesn't depend on the old folder anymore,
43+
you can safely delete it and not have it clutter your files anymore.
3744
* **ViperFX, not AudioFX!** \
38-
Who needs [`LineageOS AudioFX`](https://github.com/LineageOS/android_packages_apps_AudioFX) anyways when you have `ViPER4Android` installed.
39-
This installer automatically disables [`LineageOS AudioFX`](https://github.com/LineageOS/android_packages_apps_AudioFX) during install and also reenables it during uninstall.
45+
Who needs [`LineageOS AudioFX`](https://github.com/LineageOS/android_packages_apps_AudioFX) anyways
46+
when you have `ViPER4Android` installed.
47+
This installer automatically disables
48+
[`LineageOS AudioFX`](https://github.com/LineageOS/android_packages_apps_AudioFX)
49+
during install and also reenables it during uninstall.
4050
* **Viper Atmos** \
41-
[Experience breakthrough audio that flows above and around you](https://github.com/LineageOS/android_hardware_samsung/blob/2359bd00227d706a9dda5378e7537b2e43e3c965/dap/res/values/strings.xml#L10)
51+
[Experience breakthrough audio that flows above and around you](https://github.com/LineageOS/android_hardware_samsung/blob/2359bd00227d706a9dda5378e7537b2e43e3c965/dap/res/values/strings.xml#L10)
4252
with `ViPER4Android`. \
43-
`Dolby Atmos` has become a simple
44-
[marketing term](https://www.youtube.com/watch?v=ua-JnXlDcTU)
53+
`Dolby Atmos` has become a simple
54+
[marketing term](https://www.youtube.com/watch?v=ua-JnXlDcTU)
4555
anyways, you don't need it anymore, you got somethin' better now!
4656
* **To AML or not to AML** \
47-
[`Audio Modification Library`](https://github.com/Magisk-Modules-Repo/aml) is not included, but is usually not needed either. But you can still combine `ViPER4Android` with other audio mods using [`Audio Modification Library`](https://github.com/Magisk-Modules-Repo/aml) if you want to.
57+
[`Audio Modification Library`](https://github.com/Magisk-Modules-Repo/aml) is not included,
58+
but is usually not needed either.
59+
You can still combine `ViPER4Android` with other audio mods
60+
using [`Audio Modification Library`](https://github.com/Magisk-Modules-Repo/aml) if you want to.
4861
* **Automatic VDC and IRS import** \
49-
If you have [bought a VDC file](https://t.me/vdcservice) or downloaded an IRS file
50-
which now lays in your Download directory,
62+
If you have [bought a VDC file](https://t.me/vdcservice) or downloaded an IRS file
63+
which now lays in your Download directory,
5164
you don't have to copy it over manually.
52-
The installer automatically finds and copies them to the correct place
53-
for `ViPER4Android` to find them
65+
The installer automatically finds and copies them to the correct place
66+
for `ViPER4Android` to find them
5467
and for you to enjoy the audiophile feeling.
5568
* **Original DDCs included** \
56-
If you have not yet bought a VDC file, this installer will automatically install all original `ViPER4Android` DDC files for you to enjoy them until you notice you can [buy even better ones](https://t.me/vdcservice).
69+
If you have not yet bought a VDC file,
70+
this installer will automatically install all original `ViPER4Android` DDC files
71+
for you to enjoy them
72+
until you notice you can [buy even better ones](https://t.me/vdcservice).
5773
* **IRS ([tax](https://www.youtube.com/results?search_query=kitboga+irs+scammer)) included** \
58-
[The whole pack of IRS files](https://drive.google.com/file/d/1Bii6ER0cNgHMspVozMIfYfFAu3l16d_-/view?usp=sharing) commonly distributed in the [`ViPER4Android` Telegram group](https://t.me/ViPER4AndroidFX) is included and will be automatically copied to the correct place. You can select an IRS in the convolver option.
74+
[The whole pack of IRS files](https://drive.google.com/file/d/1Bii6ER0cNgHMspVozMIfYfFAu3l16d_-/view?usp=sharing)
75+
commonly distributed in the
76+
[`ViPER4Android` Telegram group](https://t.me/ViPER4AndroidFX)
77+
is included and will be automatically copied to the correct place.
78+
You can select an IRS in the convolver option.
5979
* **`Legacy mode` for the win** \
6080
To this day I don't see why one would want to have `Legacy mode` disabled.
61-
Yes I know it's because a media app should send it's audio session id, but to be honest: Who cares?
81+
Yes I know it's because a media app should send it's audio session id, but to be honest:
82+
Who cares?
6283
`Legacy mode` just always works reliably and this is why this installer enables it by default.
6384
Does anyone remember the time when this option was called "`Process audio session 0`"?
6485
* **Opt-in instead of Opt-out** \
65-
`ViPER4Android 2.7` comes with `Crashlytics bug report metrics` enabled by default. Personally I don't like to send bug reports, so I always disable it. I think Opt-in is the way to go here.
86+
`ViPER4Android 2.7` comes with `Crashlytics bug report metrics` enabled by default.
87+
Personally I don't like to send bug reports, so I always disable it.
88+
I think Opt-in is the way to go here.
6689
This is why in this module `Crashlytics` is disabled by default and you may enable if it you wish to.
6790
* **Keep the vibes alive** \
68-
Measures have been put in place to ensure `ViPER4Android` doesn't get killed by the OOM-killer.
69-
Though should `ViPER4Android` stop working anyways, will automatically be restarted.
70-
This may be of great convenience on low ram devices, where the OOM-killer is very aggressive, even towards foreground services.
91+
Measures have been put in place to ensure `ViPER4Android` doesn't get killed by the OOM-killer.
92+
Though should `ViPER4Android` stop working anyways, it will automatically be restarted.
93+
This may be of great convenience on low ram devices
94+
where the OOM-killer is very aggressive,
95+
even towards foreground services.
7196
* **I know you're doing fine** \
7297
The notifications of `ViPER4Android` have been permanently disabled.
73-
There is no need for this permanent cluttering of the notifications list.
98+
There is no need for this permanent cluttering of the notifications list.
7499
([more](#where-is-the-notification))
75100

76101
## Install
@@ -79,7 +104,8 @@ It contains many useability enhancements and all the major fixes needed to run `
79104
1. Flash in [Magisk](https://github.com/topjohnwu/Magisk)/[Lygisk](https://github.com/programminghoch10/Lygisk)
80105
1. Reboot
81106

82-
The installer installs the `ViPER4Android` app for you. Don't install it yourself.
107+
The installer installs the `ViPER4Android` app for you.
108+
Don't install it yourself.
83109

84110
This mod is targeted at `LineageOS 20`. \
85111
It has been tested to work on:
@@ -89,35 +115,55 @@ It has been tested to work on:
89115
* `LineageOS 19.1` on `dreamlte`
90116
* `LineageOS 20.0` on `beyond1lte`, `beyond2lte`
91117

92-
_Please don't submit pull requests adding your device/ROM combination._
118+
_Please don't submit pull requests adding your device/ROM combination._ \
93119
_I will only add devices which I can test myself._
94120

121+
### Upgrade
122+
123+
Just install the update normally
124+
by clicking the update button within your `Magisk` app
125+
or do it manually following the [install instructions](#install)
126+
127+
A reboot is recommended afterwards,
128+
but usually not required.
129+
You can just postpone it
130+
and combine it with the next reboot that you'd do anyways.
131+
132+
### Reimport VDC/IRS files
133+
134+
For reimporting newly downloaded VDC or IRS files
135+
from your downloads directory,
136+
just follow the [upgrade instructions](#upgrade).
137+
138+
You don't need to restart afterwards,
139+
the new files will be available immediately.
140+
95141
## Bugs and support
96142

97-
I am not a ViPER dev, nor am I capable of fixing your broken install or ROM.
98-
If you have trouble to install ViPER4Android this way, please **do hesitate** to ask me.
143+
I am not a ViPER dev, nor am I capable of fixing your broken install or ROM. \
144+
If you have trouble to install ViPER4Android this way, please **do hesitate** to ask me. \
99145
Try to install it the normal way and if that doesn't work either,
100-
ask in the
101-
[ViPER4Android Telegram group](https://t.me/ViPER4AndroidFX)
102-
or the
103-
[ViPER4Android XDA Thread](https://forum.xda-developers.com/android/apps-games/app-viper4android-fx-2-6-0-0-t3774651)
146+
ask in the
147+
[ViPER4Android Telegram group](https://t.me/ViPER4AndroidFX)
148+
or the
149+
[ViPER4Android XDA Thread](https://forum.xda-developers.com/android/apps-games/app-viper4android-fx-2-6-0-0-t3774651)
104150
instead.
105151

106152
### Where is the notification?
107-
The notification has been disabled on purpose,
108-
as I don't see the necessity of it.
109-
I know the App-Info toggle to enable notifications does not work.
110-
If you really need it, run this command:
111-
`pm set-distracting-restriction com.pittvandewitt.viperfx`
153+
The notification has been disabled on purpose,
154+
as I don't see the necessity of it. \
155+
I know the App-Info toggle to enable notifications does not work. \
156+
If you really need it, run this command:
157+
`pm set-distracting-restriction com.pittvandewitt.viperfx`
112158

113159
## Thanks
114160

115-
If you want to invest into a great dev,
161+
If you want to invest into a great dev,
116162
go and [donate to @pittvandewitt](https://www.paypal.com/donate/?cmd=_s-xclick&hosted_button_id=53H9TP89FLWUU).
117163

118-
Thank you
119-
[@pittvandewitt](https://github.com/pittvandewitt)
164+
Thank you
165+
[@pittvandewitt](https://github.com/pittvandewitt)
120166
for keeping my absolute favorite mod alive for so long!
121-
If you read this [@pittvandewitt](https://t.me/pittvandewitt),
122-
please [message me on Telegram](https://t.me/programminghoch10),
167+
If you read this [@pittvandewitt](https://t.me/pittvandewitt),
168+
please [message me on Telegram](https://t.me/programminghoch10),
123169
so that we can make the next `ViPER4Android` version even more epic than it already is!

0 commit comments

Comments
 (0)