Skip to content

Commit 0ece8c7

Browse files
committed
docs: update README and add release notes for v1.2.0
1 parent 084b5bd commit 0ece8c7

File tree

2 files changed

+55
-17
lines changed

2 files changed

+55
-17
lines changed

README.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,43 @@
1-
# <center>OnePlusPlusLauncher Xposed Module</center>
1+
# <center>OnePlusPlusLauncher</center>
22
![GitHub Release](https://img.shields.io/github/v/release/wizpizz/OnePlusPlusLauncher?style=for-the-badge)
33
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/wizpizz/OnePlusPlusLauncher/debug_build.yml?style=for-the-badge&label=DEBUG%20BUILD)
44
![GitHub License](https://img.shields.io/github/license/wizpizz/OnePlusPlusLauncher?style=for-the-badge)
55
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/wizpizz/OnePlusPlusLauncher/total?style=for-the-badge)
66
![GitHub Repo stars](https://img.shields.io/github/stars/wizpizz/OnePlusPlusLauncher?style=for-the-badge)
77

88

9-
## Overview
10-
119
OnePlusPlusLauncher is an Xposed/LSPosed module for the System Launcher on OxygenOS 15 that hooks into the application using the [YukiHookAPI](https://github.com/HighCapable/YuKiHookAPI) framework. It modifies app drawer search functions: automating keyboard display, enabling instant app launch from search, redirecting search actions to the app drawer, and providing optional fuzzy search.
1210

13-
- tested on System Launcher versions:
14-
- 15.4.13, 15.6.13, 15.8.13
15-
1611
**Please star the repository, if you enjoy using the module! It goes a long way ⭐**
1712

18-
## Features
13+
## 📦 Installation
14+
15+
**Before downloading, please check the release notes of the version you are downloading to see if it is compatible with your launcher version.**
16+
17+
1. Make sure your device is rooted and you have LSPosed installed.
18+
2. Download the latest release APK (or any other older release) from the [releases page](https://github.com/wizpizz/OnePlusPlusLauncher/releases)
19+
3. Install the APK on your device.
20+
4. Enable the module in the LSPosed manager and make sure System Launcher is enabled in the scope settings.
21+
5. Restart System Launcher.
22+
23+
(Restarting the launcher may be necessary for changes to take effect after toggling features.)
24+
25+
## ⚡ Features
1926

20-
* ⌨️ **Automatic Keyboard / Searchbar Focus:** Automatically displays the keyboard when the app drawer is opened and search is focused. Can be toggled separately for opening app drawer by swiping up or redirecting from the Global Search Button.
21-
* ↩️ **App Launch on Enter:** Launches the first search result directly when the "Enter" key or search action button on the keyboard is pressed.
22-
* 🔎 **Global Search Button Redirect:** Intercepts the search button in the homescreen that would normally open the dedicated global search app, redirecting to the main app drawer instead.
23-
* 📱 **Swipe Down Search Redirect:** Intercepts swipe down search gestures and redirects them to the app drawer instead of the default search interface. Includes optional auto focus for seamless search experience.
24-
* 🍑 **Fuzzy Search:** Replaces the default search logic with a ranked fuzzy search algorithm for more flexible matching.
25-
* ⚙️ **Configuration UI:** Allows toggling features individually, including auto focus options for different interaction methods.
27+
* ⌨️ **Automatic Keyboard / Searchbar Focus:** Automatically displays the keyboard when the app drawer is opened and search is focused. Can be toggled separately for opening app drawer by swiping up or redirecting from the Global Search Button.
28+
* ↩️ **App Launch on Enter:** Launches the first search result directly when the "Enter" key or search action button on the keyboard is pressed.
29+
* 🔎 **Global Search Button Redirect:** Intercepts the search button in the homescreen that would normally open the dedicated global search app, redirecting to the main app drawer instead.
30+
* 📱 **Swipe Down Search Redirect:** Intercepts swipe down search gestures and redirects them to the app drawer instead of the default search interface. Includes optional auto focus for seamless search experience.
31+
* 🍑 **Fuzzy Search:** Replaces the default search logic with a ranked fuzzy search algorithm for more flexible matching.
32+
* ⚙️ **Configuration UI:** Allows toggling features individually, including auto focus options for different interaction methods.
2633

27-
## To-Do
34+
## 🔮 To-Do
2835

29-
* Rewrite the module UI using Jetpack Compose instead of the current Android Views/XML implementation.
30-
* A decent app icon
36+
* Rewrite the module UI using Jetpack Compose instead of the current Android Views/XML implementation.
37+
* A decent app icon
38+
* And many other refactorings and improvements...
3139

32-
## Troubleshooting / Known Issues
40+
## 🔧 Troubleshooting / Known Issues
3341

3442
* **Compatibility / Launcher Updates:** Launcher updates may break hooks. Class names, field names, or method signatures might change, requiring updates to the module.
3543

docs/release.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# 🚀 OnePlusPlusLauncher v1.2.0 Release
2+
3+
## ⚠️ Important
4+
5+
**This version has only been tested on the latest launcher OxygenOS launcher version v15.8.17.**
6+
7+
With all the backwards compatibility with older versions of the launcher, the code was becoming more and more unorganized. The next release will have a lot of refactoring and how older versions of the launcher are handled will be modularized. This was not included in this release due to time constraints, and wanting to get out this release with the fix for the latest version of the launcher.
8+
9+
If you are using an older version of the launcher, please use an older release, or wait for the next release.
10+
11+
## 📝 Changelog
12+
13+
* ✨ New feature(s):
14+
* **Intercept/redirect Google Discover to app drawer**: When swiping left on the home screen, the app drawer will be opened and the search input will be focused (optional) instead of the Google Discover page.
15+
16+
* 🔧 Fixes:
17+
* Fixed the Global Search Button Redirect feature for the latest version of the launcher.
18+
19+
* Misc:
20+
* Several UI improvements.
21+
22+
## ⬇️ Installation
23+
24+
1. Make sure your device is rooted and you have LSPosed installed.
25+
2. Download the latest release APK from the assets section below or simply [click here](https://github.com/Xposed-Modules-Repo/com.wizpizz.onepluspluslauncher/releases/download/v1.2.0/app-release.apk)
26+
3. Install the APK on your device.
27+
4. Enable the module in the LSPosed manager and make sure System Launcher is enabled in the scope settings.
28+
5. Restart System Launcher.
29+
30+
(Restarting the launcher may be necessary for changes to take effect after toggling features.)

0 commit comments

Comments
 (0)