Skip to content

Commit 8ea2d11

Browse files
ImUrXImUrX
committed
Merge branch 'main' into domain-socket-folder
2 parents f5155ec + 621772f commit 8ea2d11

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+1761
-4550
lines changed

‎.github/dependabot.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
version: 2
2+
updates:
3+
4+
- package-ecosystem: "github-actions"
5+
directory: "/"
6+
schedule:
7+
# Check for updates to GitHub Actions every week
8+
interval: "weekly"

‎.github/workflows/c-cpp.yml‎

Lines changed: 53 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: SlimeVR OpenVR Driver
22

3-
on: [ push, pull_request ]
3+
on: [ push, pull_request, workflow_dispatch ]
44

55
jobs:
66
build:
@@ -15,33 +15,30 @@ jobs:
1515
- os: windows-latest
1616
triplet: x64-windows-static-md
1717
target: ALL_BUILD
18-
release_dir: Release/driver # dir of driver binaries within env.CMAKE_BUILD_DIR, VS multi-config uses <CONFIG>/ subfolder
18+
release_dir: Release # dir of driver binaries within env.CMAKE_BUILD_DIR, VS multi-config uses <CONFIG>/ subfolder
1919
- os: ubuntu-latest
2020
triplet: x64-linux
2121
target: all
22-
release_dir: driver # makefile single config won't have subfolder
22+
release_dir: "" # makefile single config won't have subfolder
2323
env:
2424
# Indicates the CMake build directory where project files and binaries are being produced.
2525
CMAKE_BUILD_DIR: ${{ github.workspace }}/build
2626
# Indicates the location of the vcpkg as a Git submodule of the project repository.
2727
VCPKG_ROOT: ${{ github.workspace }}/vcpkg
2828

2929
steps:
30-
- uses: actions/checkout@v2
30+
- uses: actions/checkout@v5
3131
with:
3232
submodules: true
33-
33+
3434
- uses: lukka/get-cmake@latest
35-
36-
- name: Clone vcpkg
37-
uses: actions/checkout@v2
38-
with:
39-
repository: microsoft/vcpkg
40-
path: ${{ env.VCPKG_ROOT }}
41-
submodules: true
35+
36+
- name: Get submodule commit hashes
37+
id: submodule_hashes
38+
run: git submodule foreach --recursive git rev-parse HEAD > submodule_hashes.txt
4239

4340
- name: Restore vcpkg and its artifacts
44-
uses: actions/cache@v2
41+
uses: actions/cache@v4
4542
with:
4643
# The first path is where vcpkg generates artifacts while consuming the vcpkg.json manifest file.
4744
# The second path is the location of vcpkg (it contains the vcpkg executable and data files).
@@ -52,12 +49,11 @@ jobs:
5249
!${{ env.VCPKG_ROOT }}/buildtrees
5350
!${{ env.VCPKG_ROOT }}/packages
5451
!${{ env.VCPKG_ROOT }}/downloads
55-
# The key is composed in a way that it gets properly invalidated: this must happen whenever vcpkg's Git commit id changes, or the list of packages changes. In this case a cache miss must happen and a new entry with a new key with be pushed to GitHub the cache service.
52+
# The key is composed in a way that it gets properly invalidated: this must happen whenever vcpkg/submodule Git commit id changes, or the list of packages changes. In this case a cache miss must happen and a new entry with a new key with be pushed to GitHub the cache service.
5653
# The key includes: hash of the vcpkg.json file, the hash of the vcpkg Git commit id, and the used vcpkg's triplet. The vcpkg's commit id would suffice, but computing an hash out it does not harm.
5754
# Note: given a key, the cache content is immutable. If a cache entry has been created improperly, in order the recreate the right content the key must be changed as well, and it must be brand new (i.e. not existing already).
58-
key: |
59-
${{ hashFiles( 'vcpkg_manifest/vcpkg.json' ) }}-${{ hashFiles( '.git/modules/vcpkg/HEAD' )}}-${{ hashFiles( '${{ env.VCPKG_ROOT }}/.git/HEAD' )}}-${{ matrix.triplet }}-invalidate
60-
55+
key: ${{ matrix.triplet }}-${{ hashFiles( '**/vcpkg.json', '**/CMakeLists.txt' ) }}-${{ hashFiles( 'submodule_hashes.txt' )}}
56+
6157
- if: matrix.os == 'windows-latest'
6258
name: Set up vcpkg for Windows
6359
run: ${{ env.VCPKG_ROOT }}/bootstrap-vcpkg.bat
@@ -67,29 +63,61 @@ jobs:
6763
run: ${{ env.VCPKG_ROOT }}/bootstrap-vcpkg.sh
6864

6965
- name: Configure CMake
70-
run: cmake -S "${{github.workspace}}" -B "${{env.CMAKE_BUILD_DIR}}" -DVCPKG_TARGET_TRIPLET=${{matrix.triplet}}
66+
run: cmake -S "${{github.workspace}}" -B "${{env.CMAKE_BUILD_DIR}}" -DVCPKG_TARGET_TRIPLET=${{matrix.triplet}} -DCMAKE_BUILD_TYPE=Release
7167

7268
- name: Build
7369
run: cmake --build "${{env.CMAKE_BUILD_DIR}}" --config Release --target "${{ matrix.target }}" -j 6 --
7470

7571
- name: Upload a build artifact
76-
uses: actions/upload-artifact@v2
72+
uses: actions/upload-artifact@v4
7773
with:
7874
# Artifact name
7975
name: slimevr-openvr-driver-${{ matrix.triplet }} # optional, default is artifact
8076
# A file, directory or wildcard pattern that describes what to upload
8177
# Using wildcards so that only the driver directory gets included (if you specify it, then it won't be included)
8278
path: |
83-
${{env.CMAKE_BUILD_DIR}}/${{ matrix.release_dir }}/*
79+
${{env.CMAKE_BUILD_DIR}}/${{ matrix.release_dir }}/driver/*
80+
${{env.CMAKE_BUILD_DIR}}/${{ matrix.release_dir }}/tests*
8481
8582
- name: Zip
8683
if: startsWith(github.ref, 'refs/tags/')
87-
working-directory: ${{env.CMAKE_BUILD_DIR}}/${{ matrix.release_dir }}
88-
run: cmake -E tar "cf" "${{env.CMAKE_BUILD_DIR}}/slimevr-openvr-driver-${{ matrix.triplet }}.zip" --format=zip -- ${{env.CMAKE_BUILD_DIR}}/${{ matrix.release_dir }}/slimevr
84+
working-directory: ${{env.CMAKE_BUILD_DIR}}/${{ matrix.release_dir }}/driver
85+
run: cmake -E tar "cf" "${{env.CMAKE_BUILD_DIR}}/slimevr-openvr-driver-${{ matrix.triplet }}.zip" --format=zip -- ${{env.CMAKE_BUILD_DIR}}/${{ matrix.release_dir }}/driver/slimevr
8986

90-
- name: Release
91-
uses: softprops/action-gh-release@v1
87+
- name: Upload to draft release
88+
uses: softprops/action-gh-release@v2
9289
if: startsWith(github.ref, 'refs/tags/')
9390
with:
91+
draft: true
92+
generate_release_notes: true
9493
files: "${{env.CMAKE_BUILD_DIR}}/slimevr-openvr-driver-${{ matrix.triplet }}.zip"
95-
94+
95+
test:
96+
name: Run tests
97+
needs: build
98+
runs-on: ${{ matrix.os }}
99+
strategy:
100+
fail-fast: false
101+
matrix:
102+
os: [windows-latest, ubuntu-latest]
103+
include:
104+
- os: windows-latest
105+
triplet: x64-windows-static-md
106+
target: RUN_TESTS
107+
- os: ubuntu-latest
108+
triplet: x64-linux
109+
target: test
110+
steps:
111+
- name: Download build artifact
112+
uses: actions/download-artifact@v5
113+
with:
114+
name: slimevr-openvr-driver-${{ matrix.triplet }}
115+
path: ${{ github.workspace }}
116+
- if: matrix.os == 'windows-latest'
117+
name: Run tests on Windows
118+
working-directory: ${{ github.workspace }}/
119+
run: .\tests.exe
120+
- if: matrix.os != 'windows-latest'
121+
name: Run tests on Unix
122+
working-directory: ${{ github.workspace }}/
123+
run: chmod +x ./tests && ./tests

‎.gitmodules‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,6 @@
44
[submodule "libraries/linalg"]
55
path = libraries/linalg
66
url = https://github.com/sgorsten/linalg.git
7+
[submodule "vcpkg"]
8+
path = vcpkg
9+
url = https://github.com/Microsoft/vcpkg.git

‎CMakeLists.txt‎

Lines changed: 48 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
cmake_minimum_required(VERSION 3.0.0)
1+
cmake_minimum_required(VERSION 3.5.0)
22

33
#if (NOT DEFINED VCPKG_TARGET_TRIPLET)
44
if(WIN32)
@@ -69,17 +69,56 @@ SET_SOURCE_FILES_PROPERTIES(${PROTO_SRC} ${PROTO_INCL} PROPERTIES GENERATED TRUE
6969

7070
find_package(simdjson CONFIG REQUIRED)
7171

72+
# libuv
73+
find_package(uvw CONFIG REQUIRED)
74+
75+
# Catch2
76+
find_package(Catch2 3 REQUIRED)
77+
7278
# Project
73-
file(GLOB_RECURSE HEADERS "${CMAKE_CURRENT_SOURCE_DIR}/src/*.hpp")
79+
set(DEPS_INCLUDES
80+
"${OPENVR_INCLUDE_DIR}"
81+
"${CMAKE_CURRENT_SOURCE_DIR}/libraries/linalg"
82+
"${CMAKE_CURRENT_SOURCE_DIR}/src/"
83+
)
84+
set(DEPS_LIBS
85+
"${OPENVR_LIB}"
86+
protobuf::libprotoc
87+
protobuf::libprotobuf
88+
protobuf::libprotobuf-lite
89+
simdjson::simdjson
90+
uvw::uvw
91+
)
92+
93+
# compile into a static lib
7494
file(GLOB_RECURSE SOURCES "${CMAKE_CURRENT_SOURCE_DIR}/src/*.cpp")
75-
add_library("${PROJECT_NAME}" SHARED "${HEADERS}" "${SOURCES}" ${PROTO_HEADER} ${PROTO_SRC})
76-
target_include_directories("${PROJECT_NAME}" PUBLIC "${OPENVR_INCLUDE_DIR}")
77-
target_include_directories("${PROJECT_NAME}" PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/libraries/linalg")
78-
target_include_directories("${PROJECT_NAME}" PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/src/")
79-
target_link_libraries("${PROJECT_NAME}" PUBLIC "${OPENVR_LIB}" protobuf::libprotoc protobuf::libprotobuf protobuf::libprotobuf-lite simdjson::simdjson)
95+
file(GLOB_RECURSE HEADERS "${CMAKE_CURRENT_SOURCE_DIR}/src/*.hpp")
96+
add_library("${PROJECT_NAME}_static" STATIC ${SOURCES} ${PROTO_HEADER} ${PROTO_SRC})
97+
target_link_libraries("${PROJECT_NAME}_static" PUBLIC ${DEPS_LIBS})
98+
set_property(TARGET "${PROJECT_NAME}_static" PROPERTY CXX_STANDARD 17)
99+
include_directories("${PROJECT_NAME}_static" PUBLIC ${DEPS_INCLUDES} ${Protobuf_INCLUDE_DIRS} ${CMAKE_CURRENT_BINARY_DIR})
100+
if(UNIX)
101+
target_compile_options("${PROJECT_NAME}_static" PRIVATE "-fPIC")
102+
target_link_libraries("${PROJECT_NAME}_static" PUBLIC atomic)
103+
endif()
104+
105+
# compile driver
106+
file(GLOB_RECURSE DRIVER_MAIN "${CMAKE_CURRENT_SOURCE_DIR}/src/DriverFactory.cpp")
107+
add_library("${PROJECT_NAME}" SHARED ${DRIVER_MAIN} ${HEADERS} ${PROTO_HEADER})
108+
target_link_libraries("${PROJECT_NAME}" PUBLIC "${PROJECT_NAME}_static")
80109
set_property(TARGET "${PROJECT_NAME}" PROPERTY CXX_STANDARD 17)
81-
include_directories(${Protobuf_INCLUDE_DIRS})
82-
include_directories(${CMAKE_CURRENT_BINARY_DIR})
110+
111+
# compile tests
112+
function(build_tests target_name test_dir)
113+
file(GLOB TESTS "${CMAKE_CURRENT_SOURCE_DIR}/${test_dir}/*.cpp" "${CMAKE_CURRENT_SOURCE_DIR}/${test_dir}/*.hpp")
114+
file(GLOB TESTS_COMMON "${CMAKE_CURRENT_SOURCE_DIR}/test/common/*.cpp" "${CMAKE_CURRENT_SOURCE_DIR}/test/common/*.hpp")
115+
add_executable(${target_name} ${TESTS} ${TESTS_COMMON} ${HEADERS} ${PROTO_HEADER})
116+
target_link_libraries(${target_name} PUBLIC "${PROJECT_NAME}_static" Catch2::Catch2WithMain)
117+
set_property(TARGET ${target_name} PROPERTY CXX_STANDARD 17)
118+
endfunction()
119+
build_tests(tests "test")
120+
build_tests(tests_integration "test/integration")
121+
add_test(NAME tests COMMAND "tests")
83122

84123
# IDE Config
85124
source_group(TREE "${CMAKE_CURRENT_SOURCE_DIR}/src" PREFIX "Header Files" FILES ${HEADERS})

‎README.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,16 @@ okay with this and that you are authorized to provide the above licenses.
3838

3939
### Building
4040

41-
To build the project with VSCode you need to install two things: [vcpkg](https://vcpkg.io/en/getting-started.html) and [VS Build Tools](https://visualstudio.microsoft.com/downloads/).
41+
Clone the repo with `git clone --recurse-submodules https://github.com/SlimeVR/SlimeVR-OpenVR-Driver` to clone with all libraries and [vcpkg](https://vcpkg.io/en/getting-started.html) registry.
42+
43+
To build the project with VSCode on Windows you need to install [VS Build Tools](https://visualstudio.microsoft.com/downloads/).
44+
45+
Run the bootstrap script to build vcpkg binary `.\vcpkg\bootstrap-vcpkg.bat` or `./vcpkg/bootstrap-vcpkg.sh`.
4246

4347
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.
4448

4549
For other systems and IDEs instructions are not available as of now, contributions are welcome.
50+
51+
### Updating vcpkg packages
52+
53+
To update vcpkg packages set the vcpkg registry submodule to a newer commit and rerun the bootstrap script.

‎driver/slimevr/resources/icons/tracker_status_error.b4bfb144.png‎

-572 Bytes
Loading

‎driver/slimevr/resources/icons/tracker_status_ready_alert.b4bfb144.png‎

-522 Bytes
Loading

‎driver/slimevr/resources/icons/tracker_status_ready_low.b4bfb144.png‎

-569 Bytes
Loading

‎driver/slimevr/resources/icons/tracker_status_standby.b4bfb144.png‎

-626 Bytes
Loading

‎driver/slimevr/resources/icons/tracker_status_standby_alert.b4bfb144.png‎

-709 Bytes
Loading

0 commit comments

Comments
 (0)