rustbridge-cli 0.7.0

Build tool and code generator for rustbridge
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

# rustbridge Java JNI Consumer Template

A minimal Java 17+ project template for consuming rustbridge plugins using JNI.

> **Note:** For Java 21+, prefer the FFM template which has better performance for JSON workloads.

## Prerequisites

- **Java 17+** - JNI requires Java 17 or later (LTS)
- **Gradle 8.0+** - Build tool
- **A rustbridge plugin** - Your `.rbp` bundle file
- **JNI bridge library** - Built from rustbridge

## Quick Start

1. **Copy this template** to your project location
2. **Build the JNI bridge**:
   ```bash
   cd /path/to/rustbridge
   cargo build --release -p rustbridge-jni
   ```
3. **Install rustbridge Java libraries**:
   ```bash
   cd /path/to/rustbridge/rustbridge-java
   ./gradlew publishToMavenLocal
   ```
4. **Update java.library.path** in `build.gradle.kts` to point to where `librustbridge_jni.so` is located
5. **Add your plugin bundle** - Copy your `.rbp` file to the project root
6. **Update Main.java** - Set `bundlePath` to your `.rbp` file
7. **Run**:
   ```bash
   ./gradlew run
   ```

## Library Path

JNI requires the native library to be in `java.library.path`. You can set this via:

```bash
java -Djava.library.path=/path/to/rustbridge/target/release -jar myapp.jar
```

Or set `LD_LIBRARY_PATH` (Linux) / `DYLD_LIBRARY_PATH` (macOS):

```bash
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/path/to/rustbridge/target/release
```

## Documentation

- [rustbridge Documentation](https://github.com/jrobhoward/rustbridge)
- [Java JNI Guide](https://github.com/jrobhoward/rustbridge/blob/main/docs/using-plugins/JAVA_JNI.md)