<img src="./assets/logo.svg" width="100%">
[![GitHub Actions][github-actions-badge]](https://github.com/geofmureithi/plugy/actions)
[![GitHub Releases][github-release-svg]][github-release]
# plugy
plugy is a plugin system designed to enable the seamless integration of Rust-based plugins into your application. It provides a runtime environment for loading and executing plugins written in WebAssembly (Wasm), enabling dynamic extensibility and modularity in your Rust projects.
## Features
- Load and execute plugins compiled to WASM.
- Flexible runtime management of plugins.
- Calls to plugin functions are async.
- Easy-to-use macros for generating plugin interfaces.
## Getting Started
To use plugy in your Rust project, follow these steps:
1. Write your plugin trait:
```rust
#[plugy::plugin]
trait Greeter {
fn greet(&self) -> String;
}
```
2. Write your first plugin implementation
```rust
#[derive(Debug, Deserialize)]
struct FooPlugin;
#[plugin_impl]
impl Greeter for FooPlugin {
fn greet(&self) -> String {
"Hello From Foo Plugin".to_owned()
}
}
```
Compile it!
```
cargo build --target wasm32-unknown-unknown
```
3. Import and run
```rust
#[plugin_import(file = "target/wasm32-unknown-unknown/debug/foo_plugin.wasm")]
struct FooPlugin;
#[tokio::main]
async fn main() {
let runtime = Runtime::<Box<dyn Greeter>>::new().unwrap();
let handle = runtime.load(FooPlugin).await.unwrap();
let res = handle.greet().await;
assert_eq!(res, "Hello From Foo Plugin")
}
```
And you are set!
## Examples
Check out the [examples](./examples/) directory for sample usage of plugy.
## Contributing
Contributions to plugy are welcome! If you find a bug or want to propose a new feature, feel free to create an issue or submit a pull request.
License
This project is licensed under the GNU General Public License.
[github-actions-badge]: https://github.com/geofmureithi/plugy/workflows/build/badge.svg
[github-release]: https://github.com/geofmureithi/plugy/releases
[github-release-svg]: https://img.shields.io/github/release/geofmureithi/plugy.svg