Skip to content

Commit 0ad0bc9

Browse files
committed
Update readme with some mroe instructions, and less excitable promises
1 parent af9c8ee commit 0ad0bc9

File tree

3 files changed

+18
-4
lines changed

3 files changed

+18
-4
lines changed

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ReaServe
22

3-
A standalone C++ REAPER extension plugin that exposes REAPER's full API over TCP via JSON-RPC 2.0.
3+
A standalone C++ REAPER extension plugin that exposes common REAPER operations over TCP via JSON-RPC 2.0, with Lua scripting support for full API access.
44

55
Control REAPER from any language — Python, Go, Node.js, Rust, or anything that can open a TCP socket.
66

@@ -14,6 +14,8 @@ Control REAPER from any language — Python, Go, Node.js, Rust, or anything that
1414
3. Restart REAPER
1515
4. You should see "ReaServe: TCP server started on port 9876" in the REAPER console
1616

17+
![Reaper Startup Message](files/img.png)
18+
1719
## Configuration
1820

1921
On first load, ReaServe creates `reaserve.ini` in your REAPER resource path:
@@ -30,11 +32,23 @@ bind=0.0.0.0
3032
python examples/python_client.py
3133
```
3234

33-
Or with netcat:
34-
3535
```bash
36-
echo -ne "\x00\x00\x00\x3a{\"jsonrpc\":\"2.0\",\"id\":1,\"method\":\"ping\",\"params\":{}}" | nc localhost 9876
36+
go run examples/go_client.go
37+
```
38+
39+
If you have installed hte plugin correctly, both should print the JSON-RPC response:
40+
3741
```
42+
$ go run go_client.go
43+
44+
Ping: {"pong":true,"version":"0.1.0"}
45+
46+
Project: 120 BPM, 4 tracks
47+
48+
Added track: {"index":4,"success":true,"track_count":5}
49+
```
50+
51+
![Reaper Undo History](files/undo-history.png)
3852

3953
## Protocol
4054

files/undo-history.png

20.1 KB
Loading

files/welcome-message.png

13.7 KB
Loading

0 commit comments

Comments
 (0)