|
| 1 | +# BlueStacks Root GUI |
| 2 | + |
| 3 | +This is an AIO application designed to simplify the configuration part of my original tutorial on how to [root BlueStacks](https://github.com/RobThePCGuy/Root-Bluestacks-with-Kitsune-Mask/) with Kitsune Mask. If you want to do things manually, then the original repo is where you go. This tool will allow you to toggle root access and read/write (R/W) modes for BlueStacks instances. It provides an intuitive interface for managing these settings without manually editing configuration files. |
| 4 | + |
| 5 | +## Features |
| 6 | + |
| 7 | +- Reads Windows Registry to auto-detect the right directories and lists them individually for you to pick. |
| 8 | +- Toggles root access (`Root: On/Off`) for individual instances. |
| 9 | +- Toggles file system read/write access (`R/W: On/Off`) for individual instances. |
| 10 | +- Updates the current status of root and R/W modes dynamically in the GUI. |
| 11 | + |
| 12 | +## Installation |
| 13 | + |
| 14 | +1. **Download the Executable**: |
| 15 | + - Download the latest `.exe` file from the [Releases](https://github.com/RobThePCGuy/BlueStacks-Root-GUI/releases) section. |
| 16 | + |
| 17 | +2. **Run the App**: |
| 18 | + - Double-click the `.exe` file to open the GUI. |
| 19 | + - No installation is required. |
| 20 | + |
| 21 | +3. **Requirements**: |
| 22 | + - Ensure BlueStacks is installed on your system. |
| 23 | + - The app detects BlueStacks configuration and instance files automatically. |
| 24 | + |
| 25 | +--- |
| 26 | + |
| 27 | +## Usage Instructions |
| 28 | + |
| 29 | +1. Open the app by running the `.exe` file. |
| 30 | +2. The app will automatically detect available BlueStacks instances and display them in the GUI. |
| 31 | +3. Select an instance by checking its corresponding checkbox. |
| 32 | +4. Use the following buttons: |
| 33 | + - **Toggle Root**: Toggles root access (`On`/`Off`) for the selected instance. |
| 34 | + - **Toggle R/W**: Toggles read/write mode (`On`/`Off`) for the selected instance. |
| 35 | +5. Observe the status updates (`Root: On/Off` and `R/W: On/Off`) next to each instance. |
| 36 | +6. Close the app when finished. |
| 37 | + |
| 38 | +--- |
| 39 | + |
| 40 | +## Requirements |
| 41 | + |
| 42 | +- **BlueStacks**: The app is designed to work with BlueStacks Android Emulator. |
| 43 | +- **Windows**: This app runs on Windows systems. |
| 44 | + |
| 45 | +--- |
| 46 | + |
| 47 | +## Troubleshooting |
| 48 | + |
| 49 | +### Common Issues |
| 50 | + |
| 51 | +1. **Error: Configuration file not found**: |
| 52 | + - Ensure BlueStacks is installed and running. |
| 53 | + - Verify that the `bluestacks.conf` file exists in the expected directory. |
| 54 | + |
| 55 | +2. **Status not updating**: |
| 56 | + - Restart the app to refresh instance detection. |
| 57 | + - Ensure the `.bstk` files are not locked by another process. |
| 58 | + |
| 59 | +3. **Permissions error**: |
| 60 | + - Run the app as an administrator to ensure it can modify the necessary files. |
| 61 | + |
| 62 | +--- |
| 63 | + |
| 64 | +## Development |
| 65 | + |
| 66 | +### For Developers |
| 67 | + |
| 68 | +1. Clone the repository: |
| 69 | + ```bash |
| 70 | + git clone https://github.com/your-repo-name.git |
| 71 | + cd your-repo-name |
| 72 | + ``` |
| 73 | + |
| 74 | +2. Install dependencies: |
| 75 | + ```bash |
| 76 | + pip install -r requirements.txt |
| 77 | + ``` |
| 78 | + |
| 79 | +3. Run the app: |
| 80 | + ```bash |
| 81 | + python main.py |
| 82 | + ``` |
| 83 | + |
| 84 | +4. Build the `.exe` file: |
| 85 | + ```bash |
| 86 | + pyinstaller --onefile --windowed main.py |
| 87 | + ``` |
| 88 | + |
| 89 | +--- |
| 90 | + |
| 91 | +## Contributions |
| 92 | + |
| 93 | +Contributions are welcome! Feel free to open an issue or submit a pull request. |
0 commit comments