|
| 1 | +# CheekyChimp |
| 2 | + |
| 3 | +   |
| 4 | + |
| 5 | +[中文文档](../README.md) |
| 6 | + |
| 7 | +## Introduction |
| 8 | + |
| 9 | +CheekyChimp is a user script manager plugin designed for Obsidian's built-in browser, similar to the Tampermonkey extension in web browsers. It allows you to inject and run custom scripts in Obsidian's built-in browser, enhancing your browsing experience. |
| 10 | + |
| 11 | +## Demo |
| 12 | + |
| 13 | +Here's a demonstration video of the plugin: |
| 14 | + |
| 15 | + |
| 16 | + |
| 17 | +## Features |
| 18 | + |
| 19 | +- Run user scripts in Obsidian's built-in browser |
| 20 | +- Manage scripts with add, delete, enable/disable operations |
| 21 | +- Implements GM_* API series functions similar to Tampermonkey |
| 22 | +- Provides persistent storage for script data |
| 23 | +- Supports Chinese script names and content |
| 24 | +- User-friendly interface for script management |
| 25 | + |
| 26 | +## Installation |
| 27 | + |
| 28 | +### Manual Installation |
| 29 | + |
| 30 | +1. Download the latest release package |
| 31 | +2. Extract to your Obsidian plugins directory: `<vault>/.obsidian/plugins/` |
| 32 | +3. Restart Obsidian |
| 33 | +4. Enable the CheekyChimp plugin in settings |
| 34 | + |
| 35 | +## Usage |
| 36 | + |
| 37 | +1. After installation and enabling the plugin, you'll see the CheekyChimp icon in Obsidian's left sidebar |
| 38 | +2. Click the icon to open the CheekyChimp management panel |
| 39 | +3. Click the "Add Script" button to import new scripts |
| 40 | +4. When visiting relevant web pages in Obsidian's built-in browser, eligible scripts will run automatically |
| 41 | + |
| 42 | +## Example Scripts |
| 43 | + |
| 44 | +The plugin comes with several example scripts that you can find in the `examples` directory: |
| 45 | + |
| 46 | +1. **Night Mode Assistant** - Implements night mode for any website with whitelist support |
| 47 | +2. **Bilibili Video Speed Control** - Adds speed control functionality to Bilibili videos |
| 48 | + |
| 49 | +## Common Issues |
| 50 | + |
| 51 | +### Cross-Origin Issues |
| 52 | + |
| 53 | +Due to Obsidian's webview limitations, some cross-origin requests may not work properly and require special handling. |
| 54 | + |
| 55 | +### Script Compatibility |
| 56 | + |
| 57 | +Not all user scripts can run normally in Obsidian, as some scripts that depend on specific browser APIs may need modifications. |
| 58 | + |
| 59 | +## Contributing |
| 60 | + |
| 61 | +Pull requests and issues are welcome to help improve this project! |
| 62 | + |
| 63 | +## License |
| 64 | + |
| 65 | +This project is licensed under the [GPL-3.0](https://www.gnu.org/licenses/gpl-3.0.html) License. |
| 66 | + |
| 67 | +--- |
| 68 | + |
| 69 | +**CheekyChimp** - Make your Obsidian browsing experience more colorful! |
0 commit comments