Skip to content

Commit 866498b

Browse files
authored
Update README.md
1 parent 9314db7 commit 866498b

1 file changed

Lines changed: 79 additions & 66 deletions

File tree

README.md

Lines changed: 79 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -2,76 +2,89 @@
22

33
![GUI Screenshot](https://github.com/user-attachments/assets/10f965eb-e1cc-4d61-9b6f-0cbb484a4ef0)
44

5-
> [!IMPORTANT]
6-
> This is an unofficial modification for the BlueStacks Android emulator. If you encounter any issues, please open a GitHub issue.
5+
This tool allows you to toggle root access and enable read/write (R/W) permissions for your BlueStacks instances. It automatically detects both master and cloned instances, eliminating the need to manually edit configuration files as described in my original guide: **[Root BlueStacks with Kitsune Mask](https://github.com/RobThePCGuy/Root-Bluestacks-with-Kitsune-Mask/)**.
6+
7+
## ✨ Features
8+
9+
- **Auto-detection:** Quickly identifies BlueStacks instances from the Windows Registry.
10+
- **Root Toggle:** Enables or disables root access **(`Root: On/Off`)** in `bluestacks.conf`.
11+
- **Read/Write Permissions:** Easily sets filesystem permissions **(`R/W: On/Off`)** per instance.
12+
- **Dynamic Status Updates:** Real-time GUI updates reflect current root and R/W states.
13+
14+
## 📥 Installation
15+
16+
1. **Download** the latest executable (`.exe`) from the **[Releases](https://github.com/RobThePCGuy/BlueStacks-Root-GUI/releases)** page.
17+
2. **Run** the downloaded `.exe` file (portable—no formal installation needed).
18+
3. **Prerequisites:**
19+
**Fully Uninstall BlueStacks:**
20+
- Use the official tool to completely **[uninstall all previous BlueStacks installations](https://support.bluestacks.com/hc/en-us/articles/360057724751-How-to-uninstall-BlueStacks-5-BlueStacks-X-and-BlueStacks-Services-completely-from-your-PC)**.
21+
- Download the latest BlueStacks version from the official website: **[BlueStacks](https://www.bluestacks.com/)**.
22+
23+
## 🎯 Usage
24+
25+
1. Launch the downloaded `.exe` file.
26+
2. The GUI auto-detects and lists all available BlueStacks instances.
27+
3. Select the instances you wish to modify.
28+
4. Use provided toggles:
29+
- **Toggle Root** – Switch this **ON** only until you have installed Kitsune to **`/system`**.
30+
- **Toggle R/W** – This must be **ON** for the instance to remain rooted.
31+
5. Download the **[Kitsune Mask](https://github.com/1q23lyc45/KitsuneMagisk/releases)** apk file.
32+
6. Launch the instance from the Multi-Instance Manager and install the apk.
33+
7. You should see the Kitsune Mask application; click on it to run.
34+
8. Root using **Kitsune Mask**:
35+
- Once open, look to the top under the Kitsune Mask section and select the **Install** option.
36+
- At the top right, tap the **Next** link to proceed.
37+
- Select the **Direct Install to /system** option.
38+
39+
>[!NOTE]
40+
> If the **Direct Install to /system** option is missing, do not select **Direct Install**.
741
>
8-
> *As of February 16th, 2025, this tool works as expected. However, it's important to note that this method is not compatible with Nougat instances. This README will be updated if that changes.*
42+
> Completely close and reopen the Kitsune Mask app. This usually resolves the issue.
943
10-
This GUI streamlines the configuration process outlined in my guide to [rooting BlueStacks](https://github.com/RobThePCGuy/Root-Bluestacks-with-Kitsune-Mask/). While it simplifies certain steps, **both repositories** are still required for complete rooting because the linked repository contains the core rooting process. This tool lets you toggle root access and enable read/write permissions for the filesystem within the `bluestacks.conf` file of selected BlueStacks instances, providing a user-friendly alternative to manual editing.
44+
9. Click Next and watch the install log for any errors.
45+
10. Allow Kitsune Mask to finish installing, then close the BlueStacks emulator.
46+
11. Use the provided toggles:
47+
- **Toggle Root** – Switch this **OFF** once the Kitsune Mask install has been completed.
48+
- **Toggle R/W** – This must be **ON** for the instance to remain rooted.
49+
12. Close the BlueStacks-Root-Gui.
1150

12-
## Features
51+
## ⚠️ Troubleshooting
1352

14-
- Automatically detects BlueStacks instances via the Windows Registry and displays them for selection.
15-
- Toggles root access (`Root: On/Off`) in `bluestacks.conf` for selected instances.
16-
- Toggles read/write (`R/W: On/Off`) filesystem permissions for selected instances.
17-
- Dynamically updates the displayed root and R/W status in the GUI.
53+
### Common Issues:
54+
- **Configuration not found:**
55+
**Fully Uninstall BlueStacks:**
56+
- Use the official tool to completely **[uninstall all previous BlueStacks installations](https://support.bluestacks.com/hc/en-us/articles/360057724751-How-to-uninstall-BlueStacks-5-BlueStacks-X-and-BlueStacks-Services-completely-from-your-PC)**.
57+
- Download the latest BlueStacks version from the official website: **[BlueStacks](https://www.bluestacks.com/)**.
58+
- **Permissions errors**: Run the GUI as an administrator.
1859

19-
### Roadmap
20-
- Download the latest version of BlueStacks
21-
- Download the latest version of Magisk Delta
22-
- Integrate ADB-based rooting directly within the GUI.
60+
## 👩‍💻 Development
2361

24-
## Installation
62+
### Getting Started:
63+
64+
**Clone the repo:**
65+
```bash
66+
git clone https://github.com/RobThePCGuy/BlueStacks-Root-GUI.git
67+
cd BlueStacks-Root-GUI
68+
```
69+
70+
**Install dependencies:**
71+
```bash
72+
pip install -r requirements.txt
73+
```
74+
75+
**Run the application:**
76+
```bash
77+
python main.py
78+
```
79+
80+
**Build executable:**
81+
```bash
82+
pyinstaller --onefile --windowed --icon=main.ico main.py
83+
```
84+
85+
The built executable will be located in the `dist/` folder.
86+
87+
## 🤝 Contributing
88+
89+
Contributions are highly encouraged! Please open issues or submit pull requests to enhance this project.
2590

26-
1. **Download:** Get the latest `.exe` release from the [Releases](https://github.com/RobThePCGuy/BlueStacks-Root-GUI/releases) page.
27-
2. **Run:** Double-click the downloaded `.exe` file. The application is portable and requires no formal installation.
28-
3. **Prerequisites:**
29-
- BlueStacks must already be installed.
30-
- Refer to my main rooting guide ([Root BlueStacks](https://github.com/RobThePCGuy/Root-Bluestacks-with-Kitsune-Mask/)) to complete the rooting process.
31-
32-
## Usage
33-
34-
1. Run the `.exe` file.
35-
2. The GUI will automatically detect and list available BlueStacks instances.
36-
3. Select the instance(s) you want to modify.
37-
4. Use the buttons:
38-
- **Toggle Root:** Enables or disables root access.
39-
- **Toggle R/W:** Enables or disables read/write permissions.
40-
5. The GUI displays the current `Root` and `R/W` status for each instance.
41-
6. After installing Kitsune Mask and completing the system partition installation steps described in the linked tutorial, you can **disable `Root` while leaving `R/W` enabled** if desired.
42-
7. Close the application when finished.
43-
44-
## Troubleshooting
45-
46-
**Common Issues:**
47-
48-
- **"Configuration file not found":** Ensure that BlueStacks is installed. Confirm that the `bluestacks.conf` file exists in the correct directory (the GUI should handle this automatically). If the problem persists, open a GitHub issue.
49-
- **Status not updating:** Restart the application. Ensure BlueStacks is not running (it could be locking the `.bstk` files).
50-
- **Permissions error:** Run the application as an administrator.
51-
52-
## Development
53-
54-
**For Developers:**
55-
56-
1. **Clone:**
57-
```bash
58-
git clone https://github.com/RobThePCGuy/BlueStacks-Root-GUI.git
59-
cd BlueStacks-Root-GUI
60-
```
61-
2. **Dependencies:**
62-
```bash
63-
pip install -r requirements.txt
64-
```
65-
3. **Run:**
66-
```bash
67-
python main.py
68-
```
69-
4. **Build (exe):**
70-
```bash
71-
pyinstaller --onefile --windowed --icon=main.ico main.py
72-
```
73-
The output file will be located inside the `dist/` folder.
74-
75-
## Contributing
76-
77-
Contributions are welcome! Please open an issue or submit a pull request.

0 commit comments

Comments
 (0)