README.md

Oxygen Customizer

Free and Open-Source Oxygen OS Customizer Application

Oxygen Customizer is an open-source Android application aimed at providing users with the ability to tweak and customize various aspects of Oxygen OS UI.

Furthermore, the open-source nature of Oxygen Customizer encourages community contributions and continuous improvement, ensuring a dynamic and evolving user experience.

Table of Contents

• Requirements
• Installation
• Permissions
• Contribution
• FAQ
• Credits
• License
• Disclaimer
• Donations

Caution

This app requires Magisk, KernelSU & APatch for root access and XPosed/LSPosed framework. Any alternative methods won't work.

🛠 Requirements

• Oxygen OS 14

• Magisk (Recommended) or KernelSU or APatch

• LSPosed

👨‍💻 Installation

1. Download and install the Oxygen Customizer app.

Installation for Magisk Users:

2. Enable the Xposed module in LSPosed app.

3. Open the app, grant root permission and follow the instructions.

4. Wait for it to finish generating rom specific module.

5. Reboot the device when prompted.

Installation for KernelSU/APatch Users:

2. Grant SuperSU/root permission for Oxygen Customizer & SystemUI from KernelSU app

3. Disable Unmount modules option if it's available in the app

4. Open the app, wait for it to finish generating rom specific module.

5. Reboot the device when prompted.

🔒 Permissions

This app requires the following permissions:

android.permission.ACCESS_NETWORK_STATE android.permission.INTERNET android.permission.ACCESS_FINE_LOCATION android.permission.ACCESS_COARSE_LOCATION android.permission.ACCESS_BACKGROUND_LOCATION Permissions to access the internet and location are required for fetching weather data and location-based services. These permissions are essential for the proper functioning of the Lockscreen Weather and are not used for any other purposes.

android.permission.USE_BIOMETRIC Permission to use biometric authentication is required for showing the Authentiation Prompt when enabled for Advanced Reboot Menu.

android.permission.VIBRATE Permission to vibrate the device is required for haptic feedback when using the app.

android.permission.WRITE_EXTERNAL_STORAGE android.permission.READ_EXTERNAL_STORAGE android.permission.MANAGE_EXTERNAL_STORAGE Permissions to read and write external storage are required for saving and loading custom images/fonts. These permissions are essential for the proper functioning of the app and are not used for any other purposes.

🤝 Contribution

We highly appreciate and welcome all forms of contributions, ranging from code, documentation, graphics, design suggestions, to bug reports. We encourage you to make the most of GitHub's collaborative platform by submitting Pull Requests, providing tutorials or other relevant content. Whatever you have to offer, we value and can utilize it effectively in our project.

🤓 FAQ

Do I need a root access for Oxygen Customizer to work?

• Yes, root access is required for Oxygen Customizer to function properly.

Which devices does Oxygen Customizer support?

• Oxygen Customizer exclusively supports Oxygen OS 14 and later versions. Compatibility with other devices or custom ROMs is not guaranteed.

Is Android version "xx" supported?

• Oxygen Customizer officially supports Android 14 and later versions. Compatibility with earlier Android versions is not provided, and there are no plans to introduce support for those versions.

I got bootloop. How do I fix it?

• Boot into Safe Mode and uninstall module.

What is the difference between Release build and Debug build?

• Release build is an optimized version intended for distribution to end-users, while Debug build includes additional features and information for debugging and development purposes.

Can I use Oxygen Customizer in conjunction with other customization apps?

• Yes, Oxygen Customizer can be used alongside other customization apps. However, it's important to note that conflicts or overlapping modifications may occur, which could affect the overall user experience.

I found a bug. How do I report it?

• To report a bug, please navigate to the Issues section. Create a new issue and ensure you select the Bug Report template. Provide as much detailed information as possible, including steps to reproduce the bug and any relevant error messages or screenshots.

How do I request a new feature?

• If you have a feature request, please go to the Issues section. Create a new issue and choose the Feature Request template. Be sure to include comprehensive details about the desired feature, its potential benefits, and any other relevant information that can assist in understanding and evaluating the request.

Where can I make a donation?

• You can donate via "PayPal", or via "Buy me a coffee".

❤ Credits

Thanks to:

• Android Open Source Project (AOSP) for Android source code.
• OnePlus for Oxygen OS.
• Material Icons for in-app icons.
• PixelXpert, @siavash79 for help with Xposed mods, and his great work with Pixel Xpert.
• Iconify, @Mahmud0808 for bringing the idea of Iconify and his great work.
• crDroid for Pulse Controller and some tweaks.
• OmniROM for the Weather Providers.
• Project Matrixx for some illustrations.
• SuperiorExtended for some tweaks and layouts.
• And everyone who contributed and translated... :)

© License

Oxygen Customizer is licensed under GPLv3. Please see LICENSE for the full license text.

📝 Disclaimer

Warning

• Please note that Oxygen Customizer may not be fully compatible with all custom OOS variants.
• I cannot be held responsible for any potential damage or issues that may occur to your device while using Oxygen Customizer.

⭐ Donations