rpgx-dioxus 0.1.5

Dioxus plugin for the RPGX engine
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

# RPGX Dioxus Plugin

This package provides the Dioxus integration for the RPGX game engine, enabling reactive user interfaces for grid-based RPGs using the [Dioxus](https://dioxuslabs.com/) Rust framework.

## Features

- Seamless integration with RPGX core engine
- Reactive UI components for RPGs
- Support for both desktop and web platforms via Dioxus

## Example

```rust
use rpgx::prelude::*;
use rpgx_dioxus::components::engine::Engine as EngineComponent;
let library = Library::new(/* Configure library */)
let engine = Engine::new(/* Configure engine */)
rsx! {
    div { class: "rpgx",
        EngineComponent {
            engine: engine.clone(),
            library: library.clone(),
            square_size: 30,
        }
    }
}
```

## Prerequisites

- Rust toolchain
- [`dioxus-cli`](https://github.com/DioxusLabs/cli) for development and building

Install Dioxus CLI:

```sh
cargo install --locked dioxus-cli
```

## Development

To start the Dioxus application in development mode:

```sh
make dev-dioxus-desktop
# or for web
make dev-dioxus-web
```

## Building

To build the Dioxus application for production:

```sh
make build-dioxus-desktop
# or for web
make build-dioxus-web
```

## Usage

Import and use the Dioxus driver components in your Dioxus app to render and interact with RPGX game state.

## License

RPGX is licensed under the [MIT License](../../../LICENSE).