Created Plugins (markdown)

leafspark 2024-08-22 20:10:22 -07:00
parent c953394b3f
commit e73593371f
1 changed files with 29 additions and 0 deletions

29
Plugins.md Normal file

@ -0,0 +1,29 @@
The AutoGGUF plugin system allows users to extend and customize the functionality of the AutoGGUF application. Plugins can add new features, modify existing behaviors, and integrate with the core application.
## Plugin Structure
A plugin is a Python file placed in the `plugins` directory. Each plugin should contain a main class that defines the plugin's functionality.
### Basic Plugin Template
```python
class MyPlugin:
def init(self, autogguf_instance):
# This method is called after the plugin is loaded
# You can use it to set up your plugin or modify the AutoGGUF instance
pass
def __data__(self):
# This method should return metadata about your plugin
return {
"name": "My Plugin",
"description": "This is an example plugin.",
"supported_versions": ["*"],
"author": "Your Name",
"version": "1.0.0"
}
# Add your custom methods and attributes here
# These replace the ones in the AutoGGUF class if the name matches
def my_custom_method(self):
print("This is a custom method from the plugin")