Apply the auto-fixable lint rules and the formatter, and drop the Vite build artifacts.
This commit is contained in:
+6
-1
@@ -5,6 +5,7 @@ The Paarrot desktop client includes a powerful plugin system that allows you to
|
||||
## What are Plugins?
|
||||
|
||||
Plugins are small JavaScript modules that run inside Paarrot and can:
|
||||
|
||||
- Add custom commands
|
||||
- Modify the UI
|
||||
- React to Matrix events
|
||||
@@ -53,6 +54,7 @@ Use the search bar to filter plugins by name, description, author, or tags.
|
||||
⚠️ **Important Security Information**
|
||||
|
||||
Plugins run with access to your Matrix client and can:
|
||||
|
||||
- Read your messages
|
||||
- Send messages on your behalf
|
||||
- Access your room list
|
||||
@@ -79,6 +81,7 @@ Want to create your own plugin? Check out the [Plugin API Reference](docs/PLUGIN
|
||||
- `plugin-metadata.json` - Plugin information
|
||||
|
||||
2. Implement the plugin interface:
|
||||
|
||||
```javascript
|
||||
module.exports = {
|
||||
onLoad: async (context) => {
|
||||
@@ -87,7 +90,7 @@ module.exports = {
|
||||
},
|
||||
onUnload: async () => {
|
||||
// Cleanup when disabled
|
||||
}
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
@@ -98,6 +101,7 @@ module.exports = {
|
||||
## Plugin API
|
||||
|
||||
Plugins have access to:
|
||||
|
||||
- **Matrix Client**: Full matrix-js-sdk client instance
|
||||
- **React**: For building UI components
|
||||
- **Commands**: Register custom slash commands
|
||||
@@ -134,6 +138,7 @@ Check out the `example-plugin/` directory for a simple example, or the `plugins/
|
||||
### Performance Issues
|
||||
|
||||
If Paarrot becomes slow:
|
||||
|
||||
1. Disable plugins one by one to identify the culprit
|
||||
2. Check for memory leaks in the console
|
||||
3. Contact the plugin author with details
|
||||
|
||||
Reference in New Issue
Block a user