refactor: reorganize and rename settings (#1307)

Co-authored-by: Pun Butrach <[email protected]> Co-authored-by: Ushie <[email protected]>
ReVanced · Oct 15, 2023 · 196d9fe · 196d9fe
1 parent e960fcc
commit 196d9fe
Show file tree

Hide file tree

Showing 20 changed files with 272 additions and 258 deletions.
diff --git a/assets/i18n/en_US.json b/assets/i18n/en_US.json
@@ -128,12 +128,10 @@
         "none": "None",
         "noneTooltip": "Deselect all patches",
 
-        "loadPatchesSelection": "Load patches selection",
-        "noSavedPatches": "No saved patches for the selected app.\nPress Done to save current selection.",
+        "loadPatchesSelection": "Load patch selection",
+        "noSavedPatches": "No saved patch selection for the selected app.\nPress Done to save the current selection.",
         "noPatchesFound": "No patches found for the selected app",
-        "setRequiredOption": "Some patches require options to be set:\n\n{patches}\n\nPlease set them before continuing.",
-
-        "selectAllPatchesWarningContent": "You are about to select all patches, that includes non-suggested patches and can cause unwanted behavior."
+        "setRequiredOption": "Some patches require options to be set:\n\n{patches}\n\nPlease set them before continuing."
     },
     "patchOptionsView": {
         "viewTitle": "Patch options",
@@ -152,10 +150,10 @@
     },
     "patchItem": {
         "unsupportedDialogText": "Selecting this patch may result in patching errors.\n\nApp version: {packageVersion}\nSupported versions:\n{supportedVersions}",
-        "unsupportedPatchVersion": "Patch is not supported for this app version. Enable the experimental toggle in settings to proceed.",
+        "unsupportedPatchVersion": "Patch is not supported for this app version.",
         "unsupportedRequiredOption": "This patch contains a required option that is not supported by this app",
 
-        "patchesChangeWarningDialogText": "It is recommended to use the default selection of patches because changing it may cause unexpected issues.\n\nIf you know what you are doing, you can enable \"Enable changing selection\" in the settings.",
+        "patchesChangeWarningDialogText": "It is recommended to use the default patch selection and options. Changing them may result in unexpected issues.\n\nYou'll need to turn on \"Allow changing patch selection\" in settings before changing any patch selection.",
         "patchesChangeWarningDialogButton": "Use default selection"
     },
     "installerView": {
@@ -187,10 +185,9 @@
 
         "appearanceSectionTitle": "Appearance",
         "teamSectionTitle": "Team",
-        "infoSectionTitle": "Info",
+        "debugSectionTitle": "Debugging",
         "advancedSectionTitle": "Advanced",
         "exportSectionTitle": "Import & export",
-        "logsSectionTitle": "Logs",
 
         "themeModeLabel": "App theme",
         "systemThemeLabel": "System",
@@ -204,15 +201,15 @@
         "englishOption": "English",
 
         "sourcesLabel": "Sources",
-        "sourcesLabelHint": "Configure your custom sources",
+        "sourcesLabelHint": "Configure your sources",
         "sourcesIntegrationsLabel": "Integrations source",
         "sourcesResetDialogTitle": "Reset",
-        "sourcesResetDialogText": "Are you sure you want to reset custom sources to their default values?",
-        "apiURLResetDialogText": "Are you sure you want to reset API URL to its default value?",
-        "sourcesUpdateNote": "Note: ReVanced Patches will be updated to the latest version automatically.\n\nThis will reveal your IP address to the server.",
+        "sourcesResetDialogText": "Are you sure you want to reset your sources to their default values?",
+        "apiURLResetDialogText": "Are you sure you want to reset your API URL to its default value?",
+        "sourcesUpdateNote": "Note: Patches will be updated to the latest version automatically.\n\nThis will reveal your IP address to the server.",
 
         "apiURLLabel": "API URL",
-        "apiURLHint": "Configure your custom API URL",
+        "apiURLHint": "Configure your API URL",
         "selectApiURL": "API URL",
         "hostRepositoryLabel": "Repository API",
         "orgPatchesLabel": "Patches organization",
@@ -222,21 +219,20 @@
         "contributorsLabel": "Contributors",
         "contributorsHint": "A list of contributors of ReVanced",
 
-        "logsLabel": "Logs",
-        "logsHint": "Share Manager's logs",
+        "logsLabel": "Share logs",
+        "logsHint": "Share ReVanced Manager logs",
 
-        "enablePatchesSelectionLabel": "Enable changing selection",
-        "enablePatchesSelectionHint": "Enable changing the selection of patches.",
-        "enablePatchesSelectionWarningText": "Changing the default selection of patches may cause unexpected issues.\n\nEnable anyways?",
+        "enablePatchesSelectionLabel": "Allow changing patch selection",
+        "enablePatchesSelectionHint": "Allow changing the selection of patches",
+        "enablePatchesSelectionWarningText": "Changing the selection of patches may cause unexpected issues.\n\nEnable anyways?",
         "disablePatchesSelectionWarningText": "You are about to disable changing the selection of patches.\nThe default selection of patches will be restored.\n\nDisable anyways?",
 
         "autoUpdatePatchesLabel": "Auto update patches",
-        "autoUpdatePatchesHint": "Automatically update ReVanced Patches to the latest version",
-        "experimentalUniversalPatchesLabel": "Experimental universal patches support",
-        "experimentalUniversalPatchesHint": "Display all applications to use with universal patches, loading list of apps may be slower",
-        "experimentalPatchesLabel": "Experimental patches support",
-        "experimentalPatchesHint": "Enable usage of unsupported patches in any app version",
-        "enabledExperimentalPatches": "Experimental patches support enabled",
+        "autoUpdatePatchesHint": "Automatically update patches to the latest version",
+        "universalPatchesLabel": "Show universal patches",
+        "universalPatchesHint": "Display all apps and universal patches (may slow down the app list)",
+        "versionCompatibilityCheckLabel": "Version compatibility check",
+        "versionCompatibilityCheckHint": "Restricts patches to supported versions",
 
         "aboutLabel": "About",
         "snackbarMessage": "Copied to clipboard",
@@ -246,54 +242,52 @@
         "deleteTempDirHint": "Delete unused temporary files",
         "deletedTempDir": "Temporary files deleted",
 
-        "exportPatchesLabel": "Export patches selection",
-        "exportPatchesHint": "Export patches selection to a JSON file",
-        "exportedPatches": "Patches selection exported",
-        "noExportFileFound": "No patches selection to export",
+        "exportPatchesLabel": "Export patch selection",
+        "exportPatchesHint": "Export patch selection to a JSON file",
+        "exportedPatches": "Patch selection exported",
+        "noExportFileFound": "No patch selection to export",
 
-        "importPatchesLabel": "Import patches selection",
-        "importPatchesHint": "Import patches selection from a JSON file",
-        "importedPatches": "Patches selection imported",
+        "importPatchesLabel": "Import patch selection",
+        "importPatchesHint": "Import patch selection from a JSON file",
+        "importedPatches": "Patch selection imported",
 
-        "resetStoredPatchesLabel": "Reset patches",
-        "resetStoredPatchesHint": "Reset the stored patches selection",
+        "resetStoredPatchesLabel": "Reset patch selection",
+        "resetStoredPatchesHint": "Reset the stored patch selection",
+        "resetStoredPatchesDialogTitle": "Reset patch selection?",
+        "resetStoredPatchesDialogText": "The default selection of patches will be restored..",
+        "resetStoredPatches": "Patch selection has been reset",
 
-        "resetStoredOptionsLabel": "Reset options",
+        "resetStoredOptionsLabel": "Reset patch options",
         "resetStoredOptionsHint": "Reset all patch options",
-
-        "resetStoredPatchesDialogTitle": "Reset patches selection?",
-        "resetStoredPatchesDialogText": "Resetting patches selection will remove all selected patches.",
-        "resetStoredPatches": "Patches selection has been reset",
-
-        "resetStoredOptionsDialogTitle": "Reset options?",
-        "resetStoredOptionsDialogText": "Resetting options will remove all saved options.",
+        "resetStoredOptionsDialogTitle": "Reset patch options?",
+        "resetStoredOptionsDialogText": "Resetting patch options will remove all saved options.",
         "resetStoredOptions": "Options have been reset",
 
-        "deleteLogsLabel": "Delete logs",
-        "deleteLogsHint": "Delete collected manager logs",
+        "deleteLogsLabel": "Clear logs",
+        "deleteLogsHint": "Delete collected ReVanced Manager logs",
         "deletedLogs": "Logs deleted",
 
         "regenerateKeystoreLabel": "Regenerate keystore",
-        "regenerateKeystoreHint": "Regenerate the keystore used to sign the app",
+        "regenerateKeystoreHint": "Regenerate the keystore used to sign apps",
 
         "regenerateKeystoreDialogTitle": "Regenerate keystore?",
-        "regenerateKeystoreDialogText": "Patched apps signed with the old keystore will no longer be able to update.",
+        "regenerateKeystoreDialogText": "Patched apps signed with the old keystore will no longer be able to be updated.",
         "regeneratedKeystore": "Keystore regenerated",
 
         "exportKeystoreLabel": "Export keystore",
-        "exportKeystoreHint": "Export keystore used to sign apps",
+        "exportKeystoreHint": "Export the keystore used to sign apps",
         "exportedKeystore": "Keystore exported",
         "noKeystoreExportFileFound": "No keystore to export",
 
         "importKeystoreLabel": "Import keystore",
-        "importKeystoreHint": "Import keystore used to sign apps",
+        "importKeystoreHint": "Import a keystore used to sign apps",
         "importedKeystore": "Keystore imported",
 
-        "selectKeystorePassword": "Keystore Password",
-        "selectKeystorePasswordHint": "Select keystore password used to sign the apk",
+        "selectKeystorePassword": "Keystore password",
+        "selectKeystorePasswordHint": "Select keystore password used to sign apps",
 
         "jsonSelectorErrorMessage": "Unable to use selected JSON file",
-        "keystoreSelectorErrorMessage": "Unable to use selected KEYSTORE file"
+        "keystoreSelectorErrorMessage": "Unable to use selected keystore file"
     },
     "appInfoView": {
         "widgetTitle": "App info",

diff --git a/docs/2_4_settings.md b/docs/2_4_settings.md
@@ -2,37 +2,41 @@
 
 ReVanced Manager has settings that can be configured to your liking.
 
-## ⭐ Essential settings
+## 🎛️ Essential settings
 
-- ### 🔗 API URL
+- ### 🪛 Allow changing patch selection
 
-  API to use to fetch updates and ReVanced Patches from.
+  Allows the user to change the patch selection from the default selection.
 
-- ### 🧬 Sources
+- ### 🔍 Version compatibility check
 
-  Override the API and download ReVanced Patches from a different source.
+  Constrains patches to supported app versions. Disable this to patch any version of an app.
 
-- ### 🧪 Experimental ReVanced Patches support
+  > [!WARNING]
+  > Disabling this may cause issues if the patches are not compatible with the app version.  
 
-  Disable checking for the version of the app when applying ReVanced Patches.
+- ### 🧑‍🔬 Show universal patches
+
+  Reveals patches which can be applied to any app.
 
   > [!WARNING]  
-  > This may cause issues if the ReVanced Patches are not compatible with the app version.
+  > These patches may not work on all apps.
 
-- ### 🧑‍🔬 Experimental universal support
+- ### 🧬 Sources
 
-  This will show or hide ReVanced Patches, which are not meant for any app in particular but apply to all apps
+  Override the API and download patches from a different source.
 
-  > [!WARNING]  
-  > Because the patches generalize the app, they may not work on all apps.
+- ### 🔗 API URL
+
+  API to use to fetch updates and patches from.  
 
 - ### 💾 Imports & Exports
 
   You can import, export or reset the following settings:
 
   - 🔑 Keystore
-  - 📄 ReVanced Patches selection
-  - ⚙️ Options
+  - 📄 Patch selection
+  - ⚙️ Patch options
 
   > [!NOTE]  
   > This is particularly useful if you want to backup or reset your settings.
@@ -45,4 +49,4 @@ ReVanced Manager has settings that can be configured to your liking.
 
 The next page will bring you back to the usage page.
 
-Continue: [🛠️ Usage](2_usage.md)
+Continue: [🛠️ Usage](2_usage.md)
diff --git a/fonts/custom-icons.ttf b/fonts/custom-icons.ttf
diff --git a/lib/services/manager_api.dart b/lib/services/manager_api.dart
@@ -244,12 +244,12 @@ class ManagerAPI {
     await _prefs.setBool('universalPatchesEnabled', value);
   }
 
-  bool areExperimentalPatchesEnabled() {
-    return _prefs.getBool('experimentalPatchesEnabled') ?? false;
+  bool isVersionCompatibilityCheckEnabled() {
+    return _prefs.getBool('versionCompatibilityCheckEnabled') ?? true;
   }
 
-  Future<void> enableExperimentalPatchesStatus(bool value) async {
-    await _prefs.setBool('experimentalPatchesEnabled', value);
+  Future<void> enableVersionCompatibilityCheckStatus(bool value) async {
+    await _prefs.setBool('versionCompatibilityCheckEnabled', value);
   }
 
   Future<void> setKeystorePassword(String password) async {
@@ -677,7 +677,7 @@ class ManagerAPI {
   Future<List<String>> getDefaultPatches() async {
     final List<Patch> patches = await getPatches();
     final List<String> defaultPatches = [];
-    if (areExperimentalPatchesEnabled() == false) {
+    if (isVersionCompatibilityCheckEnabled() == false) {
       defaultPatches.addAll(
         patches
             .where(

diff --git a/lib/ui/views/installer/installer_viewmodel.dart b/lib/ui/views/installer/installer_viewmodel.dart
@@ -198,9 +198,9 @@ class InstallerViewModel extends BaseViewModel {
       'Patches: ${_patches.map((p) => p.name).toList().join(", ")}',
 
       '\n~ Settings',
-      'Enabled changing patches: ${_managerAPI.isPatchesChangeEnabled()}',
-      'Enabled universal patches: ${_managerAPI.areUniversalPatchesEnabled()}',
-      'Enabled experimental patches: ${_managerAPI.areExperimentalPatchesEnabled()}',
+      'Allow changing patch selection: ${_managerAPI.isPatchesChangeEnabled()}',
+      'Show universal patches: ${_managerAPI.areUniversalPatchesEnabled()}',
+      'Version compatibility check: ${_managerAPI.isVersionCompatibilityCheckEnabled()}',
       'Patches source: ${_managerAPI.getPatchesRepo()}',
       'Integration source: ${_managerAPI.getIntegrationsRepo()}',
 

diff --git a/lib/ui/views/patcher/patcher_viewmodel.dart b/lib/ui/views/patcher/patcher_viewmodel.dart
@@ -190,7 +190,7 @@ class PatcherViewModel extends BaseViewModel {
       this.selectedPatches.clear();
       this.selectedPatches.addAll(patches.where((patch) => !patch.excluded));
     }
-    if (!_managerAPI.areExperimentalPatchesEnabled()) {
+    if (!_managerAPI.isVersionCompatibilityCheckEnabled()) {
       this.selectedPatches.removeWhere((patch) => !isPatchSupported(patch));
     }
     if (!_managerAPI.areUniversalPatchesEnabled()) {

diff --git a/lib/ui/views/patches_selector/patches_selector_viewmodel.dart b/lib/ui/views/patches_selector/patches_selector_viewmodel.dart
@@ -169,7 +169,7 @@ class PatchesSelectorViewModel extends BaseViewModel {
             .where(
               (element) =>
                   !element.excluded &&
-                  (_managerAPI.areExperimentalPatchesEnabled() ||
+                  (_managerAPI.isVersionCompatibilityCheckEnabled() ||
                       isPatchSupported(element)),
             ),
       );
@@ -281,7 +281,7 @@ class PatchesSelectorViewModel extends BaseViewModel {
         this.selectedPatches.addAll(
               patches.where((patch) => selectedPatches.contains(patch.name)),
             );
-        if (!_managerAPI.areExperimentalPatchesEnabled()) {
+        if (!_managerAPI.isVersionCompatibilityCheckEnabled()) {
           this.selectedPatches.removeWhere((patch) => !isPatchSupported(patch));
         }
       } else {

diff --git a/lib/ui/views/settings/settings_view.dart b/lib/ui/views/settings/settings_view.dart
@@ -6,8 +6,8 @@ import 'package:google_fonts/google_fonts.dart';
 import 'package:revanced_manager/ui/views/settings/settingsFragment/settings_update_theme.dart';
 import 'package:revanced_manager/ui/views/settings/settings_viewmodel.dart';
 import 'package:revanced_manager/ui/widgets/settingsView/settings_advanced_section.dart';
+import 'package:revanced_manager/ui/widgets/settingsView/settings_debug_section.dart';
 import 'package:revanced_manager/ui/widgets/settingsView/settings_export_section.dart';
-import 'package:revanced_manager/ui/widgets/settingsView/settings_info_section.dart';
 import 'package:revanced_manager/ui/widgets/settingsView/settings_team_section.dart';
 import 'package:revanced_manager/ui/widgets/shared/custom_sliver_app_bar.dart';
 import 'package:stacked/stacked.dart';
@@ -46,15 +46,16 @@ class SettingsView extends StatelessWidget {
                     physics: NeverScrollableScrollPhysics(),
                     children: const [
                       SUpdateThemeUI(),
-                      // SUpdateLanguageUI(),
                       // _settingsDivider,
-                      STeamSection(),
+                      // SUpdateLanguageUI(),
                       _settingsDivider,
                       SAdvancedSection(),
                       _settingsDivider,
                       SExportSection(),
                       _settingsDivider,
-                      SInfoSection(),
+                      STeamSection(),
+                      _settingsDivider,
+                      SDebugSection(),
                     ],
                   ),
                 ],

diff --git a/lib/ui/views/settings/settings_viewmodel.dart b/lib/ui/views/settings/settings_viewmodel.dart
@@ -135,12 +135,12 @@ class SettingsViewModel extends BaseViewModel {
     notifyListeners();
   }
 
-  bool areExperimentalPatchesEnabled() {
-    return _managerAPI.areExperimentalPatchesEnabled();
+  bool isVersionCompatibilityCheckEnabled() {
+    return _managerAPI.isVersionCompatibilityCheckEnabled();
   }
 
-  void useExperimentalPatches(bool value) {
-    _managerAPI.enableExperimentalPatchesStatus(value);
+  void useVersionCompatibilityCheck(bool value) {
+    _managerAPI.enableVersionCompatibilityCheckStatus(value);
     notifyListeners();
   }
 

diff --git a/lib/ui/widgets/homeView/latest_commit_card.dart b/lib/ui/widgets/homeView/latest_commit_card.dart
@@ -75,7 +75,7 @@ class _LatestCommitCardState extends State<LatestCommitCard> {
 
         const SizedBox(height: 16),
 
-        // ReVanced Patches
+        // Patches
         CustomCard(
           child: Row(
             mainAxisAlignment: MainAxisAlignment.spaceBetween,
@@ -84,7 +84,7 @@ class _LatestCommitCardState extends State<LatestCommitCard> {
                 child: Column(
                   crossAxisAlignment: CrossAxisAlignment.start,
                   children: <Widget>[
-                    const Text('ReVanced Patches'),
+                    const Text('Patches'),
                     const SizedBox(height: 4),
                     Row(
                       children: <Widget>[