Skip to content

Commit fc3c5e9

Browse files
authored
Version 2 update readme commit
1 parent 9c76211 commit fc3c5e9

File tree

1 file changed

+28
-30
lines changed

1 file changed

+28
-30
lines changed

README.md

Lines changed: 28 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
11
# Menu Disabler Plugin for KOReader
22

33
## Overview
4-
KOReader’s interface can feel cluttered or overwhelming, especially for new users. This plugin lets you customize the menu system by hiding any menu items you don’t need, helping you streamline your reading experience and focus on what matters most.
4+
KOReader’s interface can feel cluttered or overwhelming, especially for new users. This plugin lets you customize the menu system by hiding any menu items you don’t need, helping you streamline your reading experience and focus on what matters most.
55

66
![Menu Disabler Plugin Preview](https://github.com/user-attachments/assets/60db671c-e300-4b01-a230-5cc40e697f2a)
77
![Menu Disabler Plugin Layout](https://github.com/user-attachments/assets/b49946df-d7df-4020-ba3a-51ba979618d4)
88

9+
## Features
10+
- Hide Any Menu: Declutter your interface by toggling off unused Menus. (Ps: This just hides the menu, it doesn't disable native features)
11+
- Custom Profiles: Save and switch between unlimited profiles (e.g. "Minimalist", "Night Mode") instantly.
12+
- Quick Search: Find and hide specific settings fast with the built-in search bar.
13+
- Sync Layouts: One-tap button to copy your File Manager setup to the Reader.
14+
- Separate Controls: Customize File Manager and Reader menus independently.
15+
- Instant Reset: Restore defaults with a single click if you change your mind
916

1017
## Installation
1118
1. Download the plugin ZIP file from the [Releases page](https://github.com/JoeBumm/menu_customizer.koplugin/releases/)
@@ -17,50 +24,45 @@ KOReader’s interface can feel cluttered or overwhelming, especially for new us
1724
- **Kindle:** `/mnt/us/koreader/plugins/`
1825
4. Restart KOReader
1926

20-
### ⚠️ Known Issue: "NEW:" Labels Appearing on Menu Items
21-
22-
If you notice unexpected "NEW:" tags appearing on many menu entries (including core features like Book information or Status bar), this is a known KOReader backend issue related to how menu rendering works.
23-
24-
It occurs after customizing menus or using the Menu Disabler plugin, and can make KOReader appear broken — but it’s only a cosmetic problem.
25-
26-
Workaround:
27-
Reset the Menu Disabler plugin to default settings. This removes all incorrect labels.
28-
29-
For more details, see the related discussion:
30-
👉 Issue https://github.com/JoeBumm/Koreader-Menu-customizer/issues/2
31-
3227
## Usage
3328
### Accessing the Plugin
3429
1. Open KOReader's main menu
35-
2. Navigate to: **More tools → Menu Disabler**
30+
2. Navigate to: **More tools → Menu Disabler** (it's usually on the second page)
3631

3732
### Customizing Menus
38-
- **File Manager Menus:** (When in file browser)
33+
- **Customize File Manager Menus:** (When in file browser)
3934
- Select "Customize File Manager Menus"
40-
- Tap any menu item to enable/disable it
35+
- Tap any menu item to enable/disable it, and don't forge to save your changes
4136
- **Scroll to the last page and press Save**
42-
- **Reader Menus:** (When reading a document)
37+
- **Customize Reader Menus:** (When reading a document)
4338
- Select "Customize Reader Menus"
4439
- Tap any menu item to enable/disable it
4540
- **Scroll to the last page and press Save**
46-
- **Reset to Default:**
41+
- **Reset All Menus to Default:**
4742
- Tap **"Reset everything to Default"** to restore all menus (File Manager and Reader) to their original state.
4843
- This will remove any customizations you've made and reload the default KOReader menu structure.
4944
- A confirmation dialog will appear before changes are applied.
50-
- **Copy File-Manager to Reader:**
51-
- Tap **"Copy File-Manager settings to Reader"** to apply your current File Manager menu configuration to the Reader menus.
45+
- **Apply File Manager Layout to Reader:**
46+
- Tap **"Apply File Manager Layout to Reader"** to apply your current File Manager menu configuration to the Reader menus.
5247
- This is useful if you want a consistent menu layout across both modes. And it's fast if you are lazy.
5348
- You can still further customize the Reader menu after copying.
5449

50+
### Profiles (Layouts)
51+
New in v2.0! You can now save your setups.
52+
1. Select **Profiles (Save/Load/Delete)**.
53+
2. Tap **➕ Save Current Setup** to name and store your current File Manager & Reader configuration.
54+
3. Tap any saved profile folder to **Load** it instantly.
55+
5556
### Protected Items
56-
Some critical items cannot be disabled on some devices:
57-
- More Tools menu
58-
- Plugin Management
59-
- Patch Management
57+
To prevent boot loops and crashes, critical system menus are **Locked (🔒)** and cannot be disabled:
58+
* **Top-level Tabs** (Tools, Search, Settings, etc.)
59+
* **Navigation & Device** menus (Required for page turns and power management)
60+
* **OTA Updates** & **Plugin Management** (To ensure you can always update or fix the app)
6061

6162
### Saving Changes
62-
1. After making changes, tap **💾 Save Changes**
63-
2. **Restart KOReader** for changes to take effect
63+
1. After making edits, tap **💾 SAVE & APPLY ALL CHANGES** at the top of the menu.
64+
2. A prompt will appear asking you to **Restart KOReader**.
65+
3. You must restart manually for changes to take effect.
6466
3. Changes are automatically saved to:
6567
- `settings/filemanager_menu_order.lua`
6668
- `settings/reader_menu_order.lua`
@@ -91,14 +93,10 @@ Some critical items cannot be disabled on some devices:
9193
- Delete the entire `settings` directory (backup first if possible)
9294

9395
### Common Issues
94-
- **Changes not appearing?** After disabling a menu **Scroll to the last page and press Save** and Remember to restart KOReader after saving
95-
- **Menu items reappearing?** Some core menus are protected and cannot be disabled
9696
- **Plugin not showing?** Ensure the plugin folder is named exactly `menu_disabler.koplugin`
9797

9898
## Support
9999
For additional help:
100100
- Open an issue on this repo
101-
- Visit the [KOReader forums](https://github.com/koreader/koreader/discussions)
102-
- Check the `DEBUG.md` file for advanced troubleshooting
103101

104102
**Note:** Always back up your KOReader settings before making major changes.

0 commit comments

Comments
 (0)