Skip to content

Commit 1084b40

Browse files
committed
Update build instructions and fix protobuf java package
1 parent f655719 commit 1084b40

File tree

3 files changed

+14
-3
lines changed

3 files changed

+14
-3
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,4 @@ vcpkg_installed/
2929
# Project-specific
3030
build/*
3131
out/
32+
/.vscode

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,18 @@ Run the bootstrap script to build vcpkg binary `.\vcpkg\bootstrap-vcpkg.bat` or
4646

4747
After installing vcpkg if you're on Windows, you need to run `vcpkg integrate install` command from the vcpkg folder to integrate it for VSCode.
4848

49-
For other systems and IDEs instructions are not available as of now, contributions are welcome.
49+
Then you will need to run `cmake -B build` once to setup CMake.
50+
51+
Finally, everytime you want to build binaries, just run `cmake --build build --config Release`. The newly built binary will be in the build/release directory.
52+
53+
For other systems and IDEs, instructions are not available as of now, but contributions are welcome.
5054

5155
### Updating vcpkg packages
5256

53-
To update vcpkg packages set the vcpkg registry submodule to a newer commit and rerun the bootstrap script.
57+
To update vcpkg packages set the vcpkg registry submodule to a newer commit and rerun the bootstrap script.
58+
59+
### Updating protobuf messages
60+
61+
You can modify the protobuf messages for communication between the server and this driver at [src\bridge\ProtobufMessages.proto](src\bridge\ProtobufMessages.proto)
62+
63+
To update the protobuf messages on the server, you will need to install [protoc](https://protobuf.dev/installation/) (we use version 4.31.1), then make sure that your SlimeVR-Server and SlimeVR-OpenVR-Driver repositories are in the same parent directory and run `protobuf_update.bat` located at `SlimeVR-Server\server\desktop`

src/bridge/ProtobufMessages.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ package messages;
4747
* recieve messages this frame.
4848
*/
4949

50-
option java_package = "dev.slimevr.bridge";
50+
option java_package = "dev.slimevr.desktop.platform";
5151
option java_outer_classname = "ProtobufMessages";
5252
option optimize_for = LITE_RUNTIME;
5353

0 commit comments

Comments
 (0)