plux-lua-manager 0.1.2

Lua plugin manager for Plux
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

# Plux Lua Manager

[![Crates.io](https://img.shields.io/crates/v/plux-lua-manager)](https://crates.io/crates/plux-lua-manager)
[![Documentation](https://docs.rs/plux-lua-manager/badge.svg)](https://docs.rs/plux-lua-manager)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A high-performance Lua plugin manager for [Plux](https://crates.io/crates/plux-rs), providing a safe and efficient way to load, manage, and interact with Lua plugins.

## Installation

Add to your `Cargo.toml`:

```toml
[dependencies]
plux-rs = { version = "1.0.0", features = ["derive"] }
plux-lua-manager = "0.1.1"
```

## Features

The crate supports different Lua versions through feature flags:

- `lua54` (default): Use Lua 5.4
- `lua53`: Use Lua 5.3
- `lua52`: Use Lua 5.2
- `lua51`: Use Lua 5.1

## Quick Start

```rust
use plux_rs::{Loader, function::Request};
use plux_lua_manager::prelude::*;

// Declaring a function for lua plugin
#[plux_rs::function]
fn add(_: (), a: &i32, b: &i32) -> i32 {
    a + b
}

// Declaring a function for lua plugin
#[plux_rs::function]
fn sub(_: (), a: &i32, b: &i32) -> i32 {
    a - b
}

fn main() {
    let mut loader = Loader::new();
    loader.context(move |mut ctx| {
        // Registering functions for lua plugin
        ctx.register_function(add());
        ctx.register_function(sub());

        // Registering a entrypoint for lua plugin
        ctx.register_request(Request::new("main".to_string(), vec![], None));

        // Registering the manager
        ctx.register_manager(LuaManager::new()).unwrap();
    });

    // Loading a plugin
    let plugin = loader
        .load_plugin_now("my_plugin-v0.1.0.lua")
        .map(|bundle| loader.get_plugin_by_bundle(&bundle).unwrap())
        .unwrap();

    // Calling the 'main' request
    plugin.call_request("main", &[]).unwrap().unwrap();
}
```

## Plugin Structure

A typical plugin has the following structure:

```
my_plugin/
├── config.toml   # Plugin configuration
├── main.lua      # Main plugin code
└── ...           # Additional Lua modules/resources
```

### `config.toml` Example

```toml
name = "my_plugin"
description = "A sample plugin"
author = "Your Name"
version = "0.1.0"

# Dependencies
[dependencies]
other_plugin = "^1.0.0"

# Optional dependencies
[optional_dependencies]
optional_feature = "^2.0.0"
```

### `main.lua` Example

```lua
-- Declaring a function for Plux
function mul(a, b)
	return a * b;
end

function main()
	print("4 + 6 = " .. add(4, 6)); -- Use the function from Plux
	print("9 - 3 = " .. sub(9, 3)); -- Use the function from Plux
	print("8 * 3 = " .. mul(8, 3));
end

-- Returning the functions to Plux
return {
	{ name = "mul", inputs = {"a", "b"}, func = mul },
	{ name = "main", inputs = {}, func = main }
}
```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.