mirror of
https://github.com/SlimeVR/SlimeVR-Server.git
synced 2026-11-22 01:51:20 -08:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8cd7b164fc |
No files matched your search
@@ -1,15 +0,0 @@
|
||||
# Copy to .env.local to report to Sentry from local builds.
|
||||
# Read by the gui (vite), electron and server (gradle) builds. Real environment variables win.
|
||||
# Rebuild after changing it, the values are baked in at build time.
|
||||
|
||||
# Forces a Sentry release. Without it only clean tagged builds report.
|
||||
# Source maps are never uploaded for a forced release.
|
||||
SENTRY_RELEASE=v0.0.0-local
|
||||
|
||||
# Keeps local events out of production alerts and release health. Defaults to production.
|
||||
SENTRY_ENVIRONMENT=development
|
||||
|
||||
# Leave a DSN empty to disable that part.
|
||||
SENTRY_GUI_DSN=
|
||||
SENTRY_ELECTRON_DSN=
|
||||
SENTRY_SERVER_DSN=
|
||||
@@ -3,12 +3,3 @@
|
||||
*.png binary
|
||||
*.webp binary
|
||||
*.gif binary
|
||||
|
||||
*.ftl -linguist-detectable
|
||||
|
||||
# GUI assets (gui/app-next/src/assets)
|
||||
gui/app-next/src/assets/**/*.webp filter=lfs diff=lfs merge=lfs -text
|
||||
gui/app-next/src/assets/**/*.webm filter=lfs diff=lfs merge=lfs -text
|
||||
gui/app-next/src/assets/**/*.gltf filter=lfs diff=lfs merge=lfs -text
|
||||
gui/app-next/src/assets/**/*.glb filter=lfs diff=lfs merge=lfs -text
|
||||
gui/app-next/src/assets/**/*.ogg filter=lfs diff=lfs merge=lfs -text
|
||||
@@ -19,6 +19,14 @@
|
||||
# Some server code~
|
||||
/server/ @ButterscotchV @loucass003 @Erimelowo
|
||||
|
||||
/server/src/main/java/dev/slimevr/autobone/ @ButterscotchV
|
||||
/server/src/main/java/dev/slimevr/poserecorder/ @ButterscotchV
|
||||
/server/src/main/java/dev/slimevr/posestreamer/ @ButterscotchV
|
||||
|
||||
/server/src/main/java/dev/slimevr/osc/ @Erimelowo
|
||||
/server/src/main/java/dev/slimevr/tracking/processor/ @Erimelowo
|
||||
/server/src/main/java/dev/slimevr/filtering/ @Erimelowo
|
||||
|
||||
/bindings-provider/ @ImSapphire
|
||||
|
||||
# Linux files
|
||||
|
||||
+31
-35
@@ -82,26 +82,27 @@ jobs:
|
||||
node-version-file: '.node-version'
|
||||
cache: 'pnpm'
|
||||
- name: GUI Lint
|
||||
run: pnpm i && pnpm run lint
|
||||
run: pnpm i && cd gui && pnpm run lint
|
||||
|
||||
server-checks:
|
||||
name: Server Checks
|
||||
java-checks:
|
||||
name: Java Checks
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v6
|
||||
with:
|
||||
submodules: recursive
|
||||
- name: Set up JDK 25
|
||||
uses: actions/setup-java@v5
|
||||
- name: Set up JDK 17
|
||||
uses: actions/setup-java@v6
|
||||
with:
|
||||
java-version: '25'
|
||||
distribution: 'temurin'
|
||||
java-version: '17'
|
||||
distribution: 'adopt'
|
||||
- name: Setup Gradle
|
||||
uses: gradle/actions/setup-gradle@v6
|
||||
- name: Server Spotless Check
|
||||
- name: Java Spotless Check
|
||||
run: ./gradlew spotlessCheck --build-cache
|
||||
|
||||
|
||||
build-server-jar:
|
||||
name: Build Desktop Server
|
||||
runs-on: ubuntu-latest
|
||||
@@ -112,19 +113,17 @@ jobs:
|
||||
submodules: recursive
|
||||
- name: Get tags
|
||||
run: git fetch --tags origin --recurse-submodules=no --force
|
||||
- name: Set up JDK 25
|
||||
uses: actions/setup-java@v5
|
||||
- name: Set up JDK 17
|
||||
uses: actions/setup-java@v6
|
||||
with:
|
||||
java-version: '25'
|
||||
distribution: 'temurin'
|
||||
java-version: '17'
|
||||
distribution: 'adopt'
|
||||
- name: Setup Gradle
|
||||
uses: gradle/actions/setup-gradle@v6
|
||||
- name: Build ShadowJar
|
||||
run: ./gradlew :server:desktop:shadowJar --build-cache
|
||||
env:
|
||||
SENTRY_SERVER_DSN: ${{ vars.SENTRY_SERVER_DSN }}
|
||||
- name: Test with Gradle
|
||||
run: ./gradlew :server:core:jvmTest
|
||||
run: ./gradlew :server:desktop:test
|
||||
- name: Upload Server Jar
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
@@ -153,12 +152,9 @@ jobs:
|
||||
- name: Build JS
|
||||
env:
|
||||
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
|
||||
SENTRY_GUI_DSN: ${{ vars.SENTRY_GUI_DSN }}
|
||||
SENTRY_ELECTRON_DSN: ${{ vars.SENTRY_ELECTRON_DSN }}
|
||||
SENTRY_SERVER_DSN: ${{ vars.SENTRY_SERVER_DSN }}
|
||||
run: pnpm i && pnpm run build
|
||||
run: pnpm i && cd gui && pnpm run build
|
||||
- name: Tar GUI Dist
|
||||
run: tar -czf slimevr-gui-dist.tar.gz -C gui/electron/out .
|
||||
run: tar -czf slimevr-gui-dist.tar.gz -C gui/out .
|
||||
- name: Upload GUI Dist
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
@@ -203,19 +199,21 @@ jobs:
|
||||
name: gui-dist
|
||||
- name: Extract GUI for Electron
|
||||
shell: bash
|
||||
run: mkdir -p gui/electron/out && tar -xzf slimevr-gui-dist.tar.gz -C gui/electron/out
|
||||
run: mkdir -p gui/out && tar -xzf slimevr-gui-dist.tar.gz -C gui/out
|
||||
- name: Run Electron Builder
|
||||
shell: bash
|
||||
env:
|
||||
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
|
||||
run: |
|
||||
mkdir -p gui/electron/dist/artifacts/linux/ \
|
||||
gui/electron/dist/artifacts/win \
|
||||
gui/electron/dist/artifacts/mac
|
||||
mkdir -p gui/dist/artifacts/linux/ \
|
||||
gui/dist/artifacts/win \
|
||||
gui/dist/artifacts/mac
|
||||
VERSION=$(git --no-pager tag --sort -taggerdate --points-at HEAD | head -1)
|
||||
[ -z "$VERSION" ] && VERSION="0.0.0"
|
||||
VERSION="${VERSION#v}"
|
||||
echo "Building version: $VERSION"
|
||||
pnpm i
|
||||
cd gui/electron
|
||||
cd gui
|
||||
pnpm exec electron-builder --${{ matrix.platform }} \
|
||||
${{ matrix.platform == 'macos' && '--universal' || '' }} \
|
||||
--config.extraMetadata.version="$VERSION" \
|
||||
@@ -223,7 +221,7 @@ jobs:
|
||||
- name: Collect and Rename Artifacts
|
||||
shell: bash
|
||||
run: |
|
||||
SRC_DIR="${{ github.workspace }}/gui/electron/dist/artifacts"
|
||||
SRC_DIR="${{ github.workspace }}/gui/dist/artifacts"
|
||||
DEST_DIR="${{ github.workspace }}/release-out"
|
||||
mkdir -p "$DEST_DIR"
|
||||
|
||||
@@ -262,11 +260,11 @@ jobs:
|
||||
submodules: recursive
|
||||
- name: Get tags
|
||||
run: git fetch --tags origin --recurse-submodules=no --force
|
||||
- name: Set up JDK 25
|
||||
uses: actions/setup-java@v5
|
||||
- name: Set up JDK 17
|
||||
uses: actions/setup-java@v6
|
||||
with:
|
||||
java-version: '25'
|
||||
distribution: 'temurin'
|
||||
java-version: '17'
|
||||
distribution: 'adopt'
|
||||
- name: Setup Gradle
|
||||
uses: gradle/actions/setup-gradle@v6
|
||||
- name: Download GUI Dist
|
||||
@@ -274,16 +272,16 @@ jobs:
|
||||
with:
|
||||
name: gui-dist
|
||||
- name: Extract GUI for Android
|
||||
run: mkdir -p gui/electron/out && tar -xzf slimevr-gui-dist.tar.gz -C gui/electron/out
|
||||
run: mkdir -p gui/out && tar -xzf slimevr-gui-dist.tar.gz -C gui/out
|
||||
- name: Build APK
|
||||
run: ./gradlew :server:android:build --build-cache
|
||||
env:
|
||||
SENTRY_SERVER_DSN: ${{ vars.SENTRY_SERVER_DSN }}
|
||||
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
|
||||
ANDROID_STORE_FILE: ${{ secrets.ANDROID_STORE_FILE }}
|
||||
ANDROID_STORE_PASSWD: ${{ secrets.ANDROID_STORE_PASSWD }}
|
||||
ANDROID_KEY_ALIAS: ${{ secrets.ANDROID_KEY_ALIAS }}
|
||||
ANDROID_KEY_PASSWD: ${{ secrets.ANDROID_KEY_PASSWD }}
|
||||
- name: Test with Gradle
|
||||
run: ./gradlew test
|
||||
- name: Prepare APK
|
||||
run: cp server/android/build/outputs/apk/release/*.apk ./SlimeVR-android.apk
|
||||
- name: Upload APK
|
||||
@@ -296,8 +294,6 @@ jobs:
|
||||
if: startsWith(github.ref, 'refs/tags/')
|
||||
run: ./gradlew :server:android:bundleRelease
|
||||
env:
|
||||
SENTRY_SERVER_DSN: ${{ vars.SENTRY_SERVER_DSN }}
|
||||
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
|
||||
ANDROID_STORE_FILE: ${{ secrets.ANDROID_GPLAY_STORE_FILE }}
|
||||
ANDROID_STORE_PASSWD: ${{ secrets.ANDROID_GPLAY_STORE_PASSWD }}
|
||||
ANDROID_KEY_ALIAS: ${{ secrets.ANDROID_GPLAY_KEY_ALIAS }}
|
||||
|
||||
@@ -0,0 +1,36 @@
|
||||
name: Test Crowdin Sync (Dry Run)
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
dry_run:
|
||||
description: 'Perform a dry run (logs changes without modifying repository)'
|
||||
type: boolean
|
||||
default: true
|
||||
localization_branch:
|
||||
description: 'Branch to target for translations'
|
||||
type: string
|
||||
default: 'l10n_main'
|
||||
|
||||
jobs:
|
||||
test-crowdin:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v6
|
||||
with:
|
||||
submodules: recursive
|
||||
|
||||
- name: Test Crowdin Synchronization
|
||||
uses: crowdin/github-action@v2
|
||||
with:
|
||||
upload_sources: true
|
||||
upload_translations: false
|
||||
download_translations: true
|
||||
localization_branch_name: ${{ inputs.localization_branch }}
|
||||
dry_run: ${{ inputs.dry_run }}
|
||||
create_pull_request: false
|
||||
env:
|
||||
CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}
|
||||
CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
|
||||
CROWDIN_API_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
|
||||
@@ -3,6 +3,7 @@ on:
|
||||
push:
|
||||
branches:
|
||||
- pontoon
|
||||
- l10n_main
|
||||
jobs:
|
||||
pull_request:
|
||||
if: ${{ github.repository == 'SlimeVR/SlimeVR-Server' }}
|
||||
@@ -17,5 +18,5 @@ jobs:
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.PONTOON_BOT_KEY }}
|
||||
run: |
|
||||
gh_pr_up() { gh pr create "$@" --label "Area: Translation" --base main || gh pr edit "$@"; }
|
||||
gh_pr_up --title "New Pontoon translations" --body "Please don't squash me 🥺"
|
||||
gh_pr_up() { gh pr create "$@" --draft --base main || gh pr edit "$@"; }
|
||||
gh_pr_up --title "New translations" --body "Please don't squash me 🥺"
|
||||
@@ -1,14 +1,44 @@
|
||||
# This workflow will rebase `pontoon` with `main` changes, it's for making the
|
||||
# Pontoon bot not try making commits to main
|
||||
# This workflow will rebase `l10n_main` and `pontoon` with `main` changes, it's for making the
|
||||
# translation bots not try making commits to main
|
||||
|
||||
name: Rebase pontoon branch to main
|
||||
name: Rebase translation branches to main
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
||||
jobs:
|
||||
rebase:
|
||||
rebase-l10n:
|
||||
if: ${{ github.repository == 'SlimeVR/SlimeVR-Server' }}
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
with:
|
||||
ref: l10n_main
|
||||
submodules: recursive
|
||||
# Get all the git history for rebasing
|
||||
fetch-depth: 0
|
||||
- name: Rebase
|
||||
run: |
|
||||
git config --local user.name "slimevr-bot"
|
||||
git config --local user.email '[email protected]'
|
||||
git fetch origin main
|
||||
git rebase origin/main
|
||||
git submodule update
|
||||
- name: Push rebase
|
||||
uses: github-actions-x/[email protected]
|
||||
with:
|
||||
github-token: ${{ secrets.PONTOON_BOT_KEY }}
|
||||
push-branch: "l10n_main"
|
||||
commit-message: "update"
|
||||
force-push: "true"
|
||||
name: "slimevr-bot"
|
||||
email: "[email protected]"
|
||||
|
||||
rebase-pontoon:
|
||||
if: ${{ github.repository == 'SlimeVR/SlimeVR-Server' }}
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
|
||||
+6
-16
@@ -4,12 +4,8 @@
|
||||
# Syncthing ignore file
|
||||
.stignore
|
||||
|
||||
# Ignore .idea, except shared project inspection profiles and run configurations
|
||||
.idea/*
|
||||
!.idea/inspectionProfiles/
|
||||
!.idea/inspectionProfiles/*.xml
|
||||
!.idea/runConfigurations/
|
||||
!.idea/runConfigurations/*.xml
|
||||
# Ignore .idea
|
||||
.idea
|
||||
|
||||
# Ignore .fleet
|
||||
.fleet
|
||||
@@ -29,7 +25,9 @@
|
||||
.settings
|
||||
|
||||
# Node Stuff
|
||||
/node_modules
|
||||
node_modules/
|
||||
dist/
|
||||
stats.html
|
||||
.husky
|
||||
|
||||
# kotlin stuff
|
||||
@@ -37,6 +35,7 @@
|
||||
|
||||
# ignore gradle build folder
|
||||
build/
|
||||
server/desktop/config/
|
||||
|
||||
# created by clangd for index cache
|
||||
.cache/
|
||||
@@ -45,9 +44,6 @@ build/
|
||||
.direnv/
|
||||
.devenv
|
||||
|
||||
# Git worktrees
|
||||
.worktree/
|
||||
|
||||
# Ignore Android local properties
|
||||
local.properties
|
||||
|
||||
@@ -57,9 +53,3 @@ vrconfig.yml.tmp
|
||||
|
||||
# Nixos
|
||||
.bin/
|
||||
|
||||
.env.local
|
||||
|
||||
|
||||
# Fuck claude
|
||||
.claude
|
||||
-6
@@ -1,6 +0,0 @@
|
||||
<component name="InspectionProjectProfileManager">
|
||||
<profile version="1.0">
|
||||
<option name="myName" value="Project Default" />
|
||||
<inspection_tool class="ConvertLongToDuration" enabled="false" level="WARNING" enabled_by_default="false" />
|
||||
</profile>
|
||||
</component>
|
||||
-7
@@ -1,7 +0,0 @@
|
||||
<component name="InspectionProjectProfileManager">
|
||||
<settings>
|
||||
<option name="PROJECT_PROFILE" value="Project Default" />
|
||||
<option name="USE_PROJECT_PROFILE" value="true" />
|
||||
<version value="1.0" />
|
||||
</settings>
|
||||
</component>
|
||||
-11
@@ -1,11 +0,0 @@
|
||||
<component name="ProjectRunConfigurationManager">
|
||||
<configuration default="false" name="SlimeVR Desktop" type="JetRunConfigurationType" factoryName="Kotlin">
|
||||
<module name="SlimeVR_Server.server.desktop.main" />
|
||||
<option name="MAIN_CLASS_NAME" value="dev.slimevr.desktop.Main" />
|
||||
<option name="VM_PARAMETERS" value="--enable-native-access=ALL-UNNAMED" />
|
||||
<option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/server/desktop" />
|
||||
<method v="2">
|
||||
<option name="Make" enabled="true" />
|
||||
</method>
|
||||
</configuration>
|
||||
</component>
|
||||
+10
-16
@@ -24,26 +24,21 @@ Now you can open the codebase in [IDEA](https://www.jetbrains.com/idea/download/
|
||||
|
||||
### Java (server)
|
||||
|
||||
Before contributing to the server, read [server/README.md](server/README.md) for an overview of its architecture and design guidelines.
|
||||
|
||||
The Java code is built with `gradle`, a CLI tool that manages java projects and their
|
||||
dependencies.
|
||||
- You can run the server by running `./gradlew :server:desktop:run` in your IDE's terminal.
|
||||
- You can run the server by running `./gradlew run` in your IDE's terminal.
|
||||
- To compile the code, run `./gradlew shadowJar`. The result will
|
||||
be at `server/desktop/build/libs/slimevr.jar` (you can ignore `server.jar`).
|
||||
be at `server/build/libs/slimevr.jar` (you can ignore `server.jar`).
|
||||
|
||||
(Note: Your IDE may be able to do all of the above for you.)
|
||||
|
||||
### Electron (gui)
|
||||
|
||||
- Activate corepack (included with Node.js) via `corepack enable`
|
||||
(might require launching Git Bash as administrator on Windows)
|
||||
- Make sure you're at the root of the repository.
|
||||
- Activate corepack (included with Node.JS) via `corepack enable` (might require administrator permissions)
|
||||
- Run `pnpm i` in your IDE's terminal to download and install dependencies.
|
||||
- To launch the GUI in dev mode, run `pnpm gui`.
|
||||
- If you get an "Electron uninstall" error, run `node .\gui\electron\node_modules\electron\install.js`.
|
||||
- Finally, to compile for production, run `pnpm package:build` under `gui/electron`.
|
||||
The result will be in `gui/dist/artifacts/`. Content will change depending on the platform.
|
||||
- Finally, to compile for production, run `pnpm package:build`. The result
|
||||
will be at `dist/artifacts/` content will change depending of the platform.
|
||||
|
||||
## Code style
|
||||
|
||||
@@ -92,7 +87,7 @@ Eclipse will only do a subset of the checks in `spotless`, so you may still want
|
||||
### Electron (gui)
|
||||
|
||||
We use ESLint and Prettier to format GUI code.
|
||||
- Make sure you're at the root of the repository.
|
||||
- First, go into the GUI's directory with your terminal by running `cd gui`.
|
||||
- To check code formatting, run `pnpm run lint`.
|
||||
- To fix code formatting, run `pnpm run lint:fix` and `pnpm run format`
|
||||
|
||||
@@ -122,9 +117,8 @@ licensed under `GPL-v3`.
|
||||
We use discord *a lot* to coordinate and discuss development. Come join us at
|
||||
https://discord.gg/SlimeVR!
|
||||
|
||||
## Use of AI, LLM, and code generation
|
||||
**Submission of any content directly from AI is strictly forbidden in all SlimeVR repositories**, including code, documentation, translation, images, sounds, etc. Including, but not limited to: vibe-coding, snippets generated by LLM, AI-generated icons, copilot auto-complete, commit descriptions, PR notes, issues texts and comments. If your auto-complete system suggest next word, function name or variable name - it's okay to use, if it suggest a whole code snipped - it's not allowed.
|
||||
## Use of AI
|
||||
We DO NOT accept contributions that are generated with AI (for example, "vibe-coding").
|
||||
|
||||
An exception is using translation tools to communicate with us if you're unable to properly express yourself in English. Please leave a comment that your post was translated and from which language. Submissions of machine translations to repositories are forbidden.
|
||||
|
||||
AI is allowed for things such as research, debugging, and questions, if no output of AI is submitted.
|
||||
If you do use AI, and you believe your usage of AI is reasonable, you must clearly disclose
|
||||
how you used AI in your submission.
|
||||
@@ -22,8 +22,6 @@ Latest setup instructions are [in our docs](https://docs.slimevr.dev/server/inde
|
||||
## Building & Contributing
|
||||
For information on building and contributing to the codebase, see [CONTRIBUTING.md](CONTRIBUTING.md).
|
||||
|
||||
For an overview of the server architecture and design guidelines, see [server/README.md](server/README.md).
|
||||
|
||||
## Translating
|
||||
|
||||
Translation is done via Pontoon at [i18n.slimevr.dev](https://i18n.slimevr.dev/). Please join our [Discord translation forum](https://discord.com/channels/817184208525983775/1050413434249949235) to coordinate.
|
||||
|
||||
@@ -68,8 +68,8 @@ AlignConsecutiveTableGenDefinitionColons:
|
||||
AlignEscapedNewlines: Right
|
||||
AlignOperands: DontAlign
|
||||
AlignTrailingComments:
|
||||
Kind: Always
|
||||
OverEmptyLines: 2
|
||||
Kind: Never
|
||||
OverEmptyLines: 0
|
||||
AllowAllArgumentsOnNextLine: true
|
||||
AllowAllParametersOfDeclarationOnNextLine: true
|
||||
AllowBreakBeforeNoexceptSpecifier: Never
|
||||
@@ -140,7 +140,7 @@ EmptyLineAfterAccessModifier: Never
|
||||
EmptyLineBeforeAccessModifier: LogicalBlock
|
||||
EnumTrailingComma: Leave
|
||||
ExperimentalAutoDetectBinPacking: false
|
||||
FixNamespaceComments: true
|
||||
FixNamespaceComments: false
|
||||
ForEachMacros:
|
||||
- foreach
|
||||
- Q_FOREACH
|
||||
@@ -216,13 +216,13 @@ PenaltyBreakTemplateDeclaration: 10
|
||||
PenaltyExcessCharacter: 1000000
|
||||
PenaltyIndentedWhitespace: 0
|
||||
PenaltyReturnTypeOnItsOwnLine: 60
|
||||
PointerAlignment: Left
|
||||
PointerAlignment: Right
|
||||
PPIndentWidth: -1
|
||||
QualifierAlignment: Leave
|
||||
ReferenceAlignment: Pointer
|
||||
ReflowComments: Always
|
||||
RemoveBracesLLVM: false
|
||||
RemoveEmptyLinesInUnwrappedLines: true
|
||||
RemoveEmptyLinesInUnwrappedLines: false
|
||||
RemoveParentheses: Leave
|
||||
RemoveSemicolon: false
|
||||
RequiresClausePosition: OwnLine
|
||||
@@ -293,7 +293,5 @@ WhitespaceSensitiveMacros:
|
||||
- PP_STRINGIZE
|
||||
- STRINGIZE
|
||||
WrapNamespaceBodyWithEmptyLines: Leave
|
||||
---
|
||||
Language: Proto
|
||||
DisableFormat: true
|
||||
...
|
||||
|
||||
@@ -42,17 +42,13 @@ message(STATUS "Found OpenVR library at: ${OPENVR_LIBRARY}")
|
||||
add_executable("${PROJECT_NAME}"
|
||||
"${CMAKE_CURRENT_SOURCE_DIR}/src/paths.cpp"
|
||||
"${CMAKE_CURRENT_SOURCE_DIR}/src/logger.cpp"
|
||||
"${CMAKE_CURRENT_SOURCE_DIR}/src/bridge/BridgeClient.cpp"
|
||||
"${CMAKE_CURRENT_SOURCE_DIR}/src/bridge/BridgeTransport.cpp"
|
||||
"${CMAKE_CURRENT_SOURCE_DIR}/src/solarxr.cpp"
|
||||
"${CMAKE_CURRENT_SOURCE_DIR}/src/vr_utils.cpp"
|
||||
"${CMAKE_CURRENT_SOURCE_DIR}/src/main.cpp"
|
||||
)
|
||||
set_target_properties("${PROJECT_NAME}" PROPERTIES CXX_STANDARD 23)
|
||||
target_include_directories("${PROJECT_NAME}" PRIVATE "${SOLARXR_PROTOCOL_ROOT}/lib/flatbuffers/include" "${SOLARXR_PROTOCOL_ROOT}/lib/flatbuffers/" "${FLATBUFFERS_GENERATED_ROOT}/include" "${CMAKE_CURRENT_SOURCE_DIR}/include" "${OPENVR_ROOT}/headers")
|
||||
target_link_libraries("${PROJECT_NAME}" PRIVATE "${OPENVR_LIBRARY}")
|
||||
if(WIN32)
|
||||
target_link_libraries("${PROJECT_NAME}" PRIVATE ws2_32)
|
||||
endif()
|
||||
|
||||
if(LINUX)
|
||||
set_target_properties("${PROJECT_NAME}" PROPERTIES OUTPUT_NAME slimevr-bindings-provider)
|
||||
|
||||
@@ -1,52 +0,0 @@
|
||||
// SPDX-License-Identifier: MIT OR Apache-2.0
|
||||
// SPDX-FileCopyrightText: (c) 2026 Eiren Rain and SlimeVR Contributors
|
||||
#include "BridgeClient.hpp"
|
||||
#include "BridgeTransport.hpp"
|
||||
|
||||
#include <system_error>
|
||||
|
||||
using namespace std::literals::chrono_literals;
|
||||
namespace fs = std::filesystem;
|
||||
|
||||
void BridgeClient::CreateConnection() {
|
||||
fs::path path = GetSocketPath();
|
||||
|
||||
Socket fd = socket(AF_UNIX, SOCK_STREAM, 0);
|
||||
if (fd == InvalidSocket) {
|
||||
int err = GetLastSocketError();
|
||||
throw std::system_error(err, std::system_category(), "socket() failed");
|
||||
}
|
||||
|
||||
if (last_path_ != path) {
|
||||
Logger::Get().Info("Trying to connect to socket {}", path.string());
|
||||
last_path_ = path;
|
||||
}
|
||||
|
||||
struct sockaddr_un addr{
|
||||
.sun_family = AF_UNIX,
|
||||
};
|
||||
|
||||
const std::u8string path_str = path.u8string();
|
||||
if (path_str.size() > std::size(addr.sun_path) - 1) {
|
||||
CloseSocket(fd);
|
||||
throw std::runtime_error("Socket path too long to fit in sun_path");
|
||||
}
|
||||
memcpy(addr.sun_path, path_str.data(), path_str.size() + 1);
|
||||
|
||||
int ret = connect(fd, reinterpret_cast<const struct sockaddr*>(&addr), sizeof(addr));
|
||||
if (ret == SocketError) {
|
||||
int err = GetLastSocketError();
|
||||
CloseSocket(fd);
|
||||
throw std::system_error(err, std::system_category(), "connect() failed");
|
||||
}
|
||||
|
||||
Logger::Get().Info("Connected to {}", path.string());
|
||||
|
||||
ret = SetNonBlocking(fd);
|
||||
if (ret == SocketError) {
|
||||
int err = GetLastSocketError();
|
||||
Logger::Get().Warning("Failed to set socket into non-blocking mode: {}", std::error_code(err, std::system_category()).message());
|
||||
}
|
||||
|
||||
fd_ = fd;
|
||||
}
|
||||
@@ -1,20 +0,0 @@
|
||||
// SPDX-License-Identifier: MIT OR Apache-2.0
|
||||
// SPDX-FileCopyrightText: (c) 2026 Eiren Rain and SlimeVR Contributors
|
||||
#pragma once
|
||||
|
||||
#include "BridgeTransport.hpp"
|
||||
|
||||
/**
|
||||
* @brief Client implementation of @ref BridgeTransport for communication with SlimeVR Server using unix sockets.
|
||||
*
|
||||
* @copydoc BridgeTransport
|
||||
*/
|
||||
class BridgeClient : public BridgeTransport {
|
||||
public:
|
||||
using BridgeTransport::BridgeTransport;
|
||||
|
||||
private:
|
||||
void CreateConnection() override;
|
||||
|
||||
std::filesystem::path last_path_;
|
||||
};
|
||||
@@ -1,234 +0,0 @@
|
||||
// SPDX-License-Identifier: MIT OR Apache-2.0
|
||||
// SPDX-FileCopyrightText: (c) 2026 Eiren Rain and SlimeVR Contributors
|
||||
#include "BridgeTransport.hpp"
|
||||
#include "Endianness.hpp"
|
||||
|
||||
#include <solarxr_protocol/generated/all_generated.h>
|
||||
#include <system_error>
|
||||
|
||||
#ifdef _WIN32
|
||||
#include <winerror.h>
|
||||
#endif
|
||||
|
||||
using namespace std::chrono_literals;
|
||||
namespace fs = std::filesystem;
|
||||
|
||||
#define UNIX_XDG_DATA_HOME_DEFAULT ".local/share/"
|
||||
#define SLIMEVR_IDENTIFIER "dev.slimevr.SlimeVR"
|
||||
#define UNIX_DEFAULT_TMP_DIR "/tmp"
|
||||
#define SOCKET_NAME "SlimeVRRpc"
|
||||
|
||||
void BridgeTransport::Stop() {
|
||||
if (!thread_.joinable() && !reconnect_thread_.joinable())
|
||||
return;
|
||||
Logger::Get().Info("Bridge stopping");
|
||||
StopAsync();
|
||||
thread_ = std::jthread();
|
||||
reconnect_thread_ = std::jthread();
|
||||
}
|
||||
|
||||
void BridgeTransport::StopAsync() {
|
||||
thread_.request_stop();
|
||||
reconnect_thread_.request_stop();
|
||||
cv_.notify_all();
|
||||
}
|
||||
|
||||
fs::path BridgeTransport::GetSocketPath() {
|
||||
std::vector<fs::path> paths = {};
|
||||
|
||||
if (const char* dir_override = std::getenv("SLIMEVR_SOCKET_DIR")) {
|
||||
paths.push_back(fs::path(dir_override) / SOCKET_NAME);
|
||||
}
|
||||
|
||||
#ifndef _WIN32
|
||||
if (const char* xdg_runtime = std::getenv("XDG_RUNTIME_DIR")) {
|
||||
paths.push_back(fs::path(xdg_runtime) / SOCKET_NAME);
|
||||
}
|
||||
|
||||
if (const char* xdg_data = std::getenv("XDG_DATA_HOME")) {
|
||||
paths.push_back(fs::path(xdg_data) / SLIMEVR_IDENTIFIER / SOCKET_NAME);
|
||||
}
|
||||
|
||||
if (const char* home = std::getenv("HOME")) {
|
||||
paths.push_back(fs::path(home) / UNIX_XDG_DATA_HOME_DEFAULT / SLIMEVR_IDENTIFIER / SOCKET_NAME);
|
||||
}
|
||||
#endif
|
||||
|
||||
std::error_code ec;
|
||||
for (auto path : paths) {
|
||||
if (fs::exists(path, ec)
|
||||
#ifdef _WIN32
|
||||
|| ec.value() == ERROR_CANT_ACCESS_FILE // Windows moment???
|
||||
#endif
|
||||
) {
|
||||
return path;
|
||||
}
|
||||
}
|
||||
|
||||
#ifdef _WIN32
|
||||
// This should work as long as the user's machine does not have
|
||||
// the java.io.tmpdir system property overriden.
|
||||
WCHAR tmp_dir[MAX_PATH + 1];
|
||||
GetTempPathW(std::size(tmp_dir), tmp_dir);
|
||||
return fs::path(tmp_dir) / SOCKET_NAME;
|
||||
#else
|
||||
if (const char* tmp_dir = std::getenv("TMPDIR")) {
|
||||
return fs::path(tmp_dir) / SOCKET_NAME;
|
||||
} else {
|
||||
return fs::path(UNIX_DEFAULT_TMP_DIR) / SOCKET_NAME;
|
||||
}
|
||||
#endif
|
||||
}
|
||||
|
||||
void BridgeTransport::OnRecv(std::span<uint8_t> event) {
|
||||
if (!message_callback_)
|
||||
return;
|
||||
|
||||
auto bundle = flatbuffers::GetRoot<solarxr_protocol::MessageBundle>(event.data());
|
||||
|
||||
if (auto data_feed_msgs = bundle->data_feed_msgs()) {
|
||||
for (auto msg : *data_feed_msgs) {
|
||||
// Logger::Get().Debug("Got message DataFeedMessage::{}", EnumNameDataFeedMessage(msg->message_type()));
|
||||
message_callback_(msg);
|
||||
}
|
||||
}
|
||||
if (auto rpc_msgs = bundle->rpc_msgs()) {
|
||||
for (auto msg : *rpc_msgs) {
|
||||
Logger::Get().Debug("Got message RpcMessage::{}", EnumNameRpcMessage(msg->message_type()));
|
||||
message_callback_(msg);
|
||||
}
|
||||
}
|
||||
if (auto driver_msgs = bundle->driver_msgs()) {
|
||||
for (auto msg : *driver_msgs) {
|
||||
// Logger::Get().Debug("Got message DriverMessage::{}", EnumNameDriverMessage(msg->message_type()));
|
||||
message_callback_(msg);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void BridgeTransport::Start() {
|
||||
thread_ = std::jthread([this](std::stop_token stop) { return RunThread(stop); });
|
||||
}
|
||||
|
||||
void BridgeTransport::RunThread(std::stop_token stop) {
|
||||
std::vector<uint8_t> data;
|
||||
data.reserve(0x10000);
|
||||
|
||||
// Kick off connection.
|
||||
ResetConnection();
|
||||
|
||||
while (!stop.stop_requested()) {
|
||||
std::shared_lock fd_lock(fd_mutex_);
|
||||
|
||||
if (fd_ == InvalidSocket) [[unlikely]] {
|
||||
cv_.wait(fd_lock, stop, [this] { return fd_ != InvalidSocket; });
|
||||
if (stop.stop_requested())
|
||||
break;
|
||||
}
|
||||
|
||||
try {
|
||||
ptrdiff_t ret = Poll(fd_, 1ms);
|
||||
if (ret == 0) [[likely]] {
|
||||
// No data on the socket after timeout
|
||||
continue;
|
||||
}
|
||||
|
||||
uint32_t msg_len;
|
||||
ret = ReadFully(fd_, stop, &msg_len, sizeof(msg_len));
|
||||
if (ret == 0) [[unlikely]] {
|
||||
throw std::runtime_error("EOF");
|
||||
}
|
||||
|
||||
msg_len = ConvertEndianness<std::endian::little>(msg_len);
|
||||
// If we get something bigger than this, something's probably up
|
||||
if (msg_len > 0x40000) [[unlikely]] {
|
||||
throw std::runtime_error(std::format("Got too large message ({} bytes)", msg_len));
|
||||
}
|
||||
|
||||
const uint32_t unwrapped_len = msg_len - 4;
|
||||
data.reserve(unwrapped_len);
|
||||
|
||||
ret = ReadFully(fd_, stop, data.data(), unwrapped_len);
|
||||
if (ret == 0) [[unlikely]] {
|
||||
throw std::runtime_error("EOF");
|
||||
}
|
||||
|
||||
OnRecv({ data.data(), unwrapped_len });
|
||||
} catch (Cancelled&) {
|
||||
continue;
|
||||
} catch (std::exception& e) {
|
||||
Logger::Get().Error("Error on socket: {}", e.what());
|
||||
error_callback_(e);
|
||||
fd_lock.unlock();
|
||||
ResetConnection();
|
||||
}
|
||||
}
|
||||
|
||||
CloseConnectionHandles();
|
||||
}
|
||||
|
||||
void BridgeTransport::ResetConnection() {
|
||||
CloseConnectionHandles();
|
||||
|
||||
reconnect_thread_ = std::jthread([this](std::stop_token stop) {
|
||||
while (!stop.stop_requested()) {
|
||||
try {
|
||||
std::unique_lock fd_lock(fd_mutex_);
|
||||
CreateConnection();
|
||||
assert(fd_ != InvalidSocket);
|
||||
|
||||
cv_.notify_all();
|
||||
|
||||
// connect callback may call a function that needs to block on the fd
|
||||
fd_lock.unlock();
|
||||
OnConnect();
|
||||
|
||||
return;
|
||||
} catch (std::system_error& e) {
|
||||
if (last_error_ != e.code()) {
|
||||
Logger::Get().Error("Error when trying to connect: {}", e.what());
|
||||
last_error_ = e.code();
|
||||
}
|
||||
error_callback_(e);
|
||||
} catch (std::exception& e) {
|
||||
Logger::Get().Error("Error when trying to connect: {}", e.what());
|
||||
error_callback_(e);
|
||||
}
|
||||
|
||||
std::this_thread::sleep_for(100ms);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
void BridgeTransport::CloseConnectionHandles() {
|
||||
std::unique_lock fd_lock(fd_mutex_);
|
||||
if (fd_ == InvalidSocket)
|
||||
return;
|
||||
|
||||
CloseSocket(fd_);
|
||||
OnDisconnect();
|
||||
fd_ = InvalidSocket;
|
||||
}
|
||||
|
||||
void BridgeTransport::SendMessage(const flatbuffers::FlatBufferBuilder& fbb) {
|
||||
std::shared_lock fd_lock(fd_mutex_);
|
||||
if (fd_ == InvalidSocket) [[unlikely]]
|
||||
return;
|
||||
|
||||
std::lock_guard write_lock(write_mutex_);
|
||||
|
||||
if (fbb.GetSize() + 4 > std::numeric_limits<uint32_t>::max()) [[unlikely]] {
|
||||
Logger::Get().Warning("Skipping send of message (wrapped size larger than 32-bit unsigned integer limit)");
|
||||
return;
|
||||
}
|
||||
|
||||
const uint32_t size = static_cast<uint32_t>(fbb.GetSize());
|
||||
const uint32_t le_wrapped_size = ConvertEndianness<std::endian::little>(size + 4);
|
||||
|
||||
try {
|
||||
WriteFully(fd_, &le_wrapped_size, sizeof(le_wrapped_size));
|
||||
WriteFully(fd_, fbb.GetBufferPointer(), size);
|
||||
} catch (std::exception& e) {
|
||||
Logger::Get().Error("Failed to write message: {}", e.what());
|
||||
}
|
||||
}
|
||||
@@ -1,343 +0,0 @@
|
||||
// SPDX-License-Identifier: MIT OR Apache-2.0
|
||||
// SPDX-FileCopyrightText: (c) 2026 Eiren Rain and SlimeVR Contributors
|
||||
#pragma once
|
||||
|
||||
#include <condition_variable>
|
||||
#include <filesystem>
|
||||
#include <shared_mutex>
|
||||
#include <span>
|
||||
#include <system_error>
|
||||
#include <thread>
|
||||
#include <variant>
|
||||
|
||||
// Needs to be before anything that includes Windows.h to avoid macro clashes
|
||||
#include <solarxr_protocol/generated/all_generated.h>
|
||||
|
||||
#ifdef _WIN32
|
||||
#define WIN32_LEAN_AND_MEAN
|
||||
#define NOMINMAX
|
||||
#include <Winsock2.h>
|
||||
#include <afunix.h>
|
||||
// Microsoft why
|
||||
#undef ERROR
|
||||
#undef SendMessage
|
||||
#else
|
||||
#include <fcntl.h>
|
||||
#include <poll.h>
|
||||
#include <sys/socket.h>
|
||||
#include <sys/un.h>
|
||||
#endif
|
||||
|
||||
#include "../logger.hpp"
|
||||
|
||||
/**
|
||||
* @brief Passes messages between SlimeVR Server and SteamVR Driver using Unix sockets.
|
||||
*
|
||||
* Client or Server connection handling is implemented by extending this class.
|
||||
*
|
||||
* This class provides a set of methods to start, stop an IO thread, and send messages over a Unix socket.
|
||||
*
|
||||
* When a message is received and parsed from the pipe, the on_message_received function passed in the constructor is called
|
||||
* from the bridge thread with the message as a parameter.
|
||||
*
|
||||
* @param logger A shared pointer to an Logger object to log messages from the transport.
|
||||
* @param on_message_received A function to be called from event loop thread when a message is received and parsed from the pipe.
|
||||
* @param on_connect A function to be called when the socket is connected to.
|
||||
* @param on_disconnect A function to be called when the connection is ended.
|
||||
*/
|
||||
class BridgeTransport {
|
||||
public:
|
||||
using MessageHeader = std::variant<const solarxr_protocol::data_feed::DataFeedMessageHeader*, const solarxr_protocol::rpc::RpcMessageHeader*, const solarxr_protocol::driver_protocol::DriverMessageHeader*>;
|
||||
|
||||
#ifdef _WIN32
|
||||
using Socket = SOCKET;
|
||||
constexpr static Socket InvalidSocket = INVALID_SOCKET;
|
||||
constexpr static int SocketError = SOCKET_ERROR;
|
||||
#else
|
||||
using Socket = int;
|
||||
constexpr static Socket InvalidSocket = -1;
|
||||
constexpr static int SocketError = -1;
|
||||
#endif
|
||||
|
||||
static inline int GetLastSocketError() {
|
||||
#ifdef _WIN32
|
||||
return WSAGetLastError();
|
||||
#else
|
||||
return errno;
|
||||
#endif
|
||||
}
|
||||
|
||||
static inline int CloseSocket(Socket fd) {
|
||||
#ifdef _WIN32
|
||||
return closesocket(fd);
|
||||
#else
|
||||
return close(fd);
|
||||
#endif
|
||||
}
|
||||
|
||||
static inline bool IsBlockingError(int err) {
|
||||
#ifdef _WIN32
|
||||
return err == WSAEWOULDBLOCK;
|
||||
#else
|
||||
return err == EAGAIN || err == EWOULDBLOCK;
|
||||
#endif
|
||||
}
|
||||
|
||||
static inline int SetNonBlocking(Socket fd) {
|
||||
#ifdef _WIN32
|
||||
u_long mode = 1;
|
||||
return ioctlsocket(fd, FIONBIO, &mode);
|
||||
#else
|
||||
return fcntl(fd, F_SETFL, O_NONBLOCK);
|
||||
#endif
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Exception thrown when IO is cancelled by stop token.
|
||||
*/
|
||||
class Cancelled : public std::exception {
|
||||
public:
|
||||
Cancelled() noexcept { };
|
||||
~Cancelled() { };
|
||||
|
||||
const char* what() const noexcept override {
|
||||
return "IO operation cancelled";
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief Read @a size bytes from @a fd into @a data, retrying until all data is read or an error occurs.
|
||||
*
|
||||
* @throws @ref Cancelled stop was requested on @a stop
|
||||
* @throws std::system_error error returned on socket
|
||||
* @returns @ref SocketError on fail, otherwise number of bytes read
|
||||
*/
|
||||
static ptrdiff_t ReadFully(Socket fd, std::stop_token stop, void* data, size_t size) {
|
||||
ptrdiff_t ret;
|
||||
size_t received = 0;
|
||||
while (!stop.stop_requested() && received < size) {
|
||||
ret = recv(fd, reinterpret_cast<char*>(data) + received, size - received, 0);
|
||||
if (ret == 0) // EOF
|
||||
return ret;
|
||||
|
||||
if (ret == SocketError) [[unlikely]] {
|
||||
int err = GetLastSocketError();
|
||||
if (IsBlockingError(err)) [[likely]] {
|
||||
// we couldn't read because it would block, just try again
|
||||
continue;
|
||||
} else {
|
||||
throw std::system_error(err, std::system_category(), "recv() failed");
|
||||
}
|
||||
}
|
||||
|
||||
received += ret;
|
||||
}
|
||||
|
||||
if (stop.stop_requested())
|
||||
throw Cancelled();
|
||||
return received;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Write @a size bytes from @a data to @a fd, retrying until all data is written or an error occurs.
|
||||
*
|
||||
* @throws std::system_error error returned on socket
|
||||
*
|
||||
* @returns @ref SocketError on fail, otherwise number of bytes written
|
||||
*/
|
||||
static inline ptrdiff_t WriteFully(Socket fd, const void* data, size_t size) {
|
||||
#ifdef __linux__
|
||||
constexpr int flags = MSG_NOSIGNAL;
|
||||
#else
|
||||
constexpr int flags = 0;
|
||||
#endif
|
||||
|
||||
ptrdiff_t ret;
|
||||
size_t sent = 0;
|
||||
while (sent < size) {
|
||||
ret = send(fd, reinterpret_cast<const char*>(data) + sent, size - sent, flags);
|
||||
if (ret == SocketError) [[unlikely]] {
|
||||
int err = GetLastSocketError();
|
||||
if (IsBlockingError(err)) [[likely]] {
|
||||
// we couldn't write because it would block, just try again
|
||||
continue;
|
||||
} else {
|
||||
throw std::system_error(err, std::system_category(), "send() failed");
|
||||
}
|
||||
}
|
||||
|
||||
sent += ret;
|
||||
}
|
||||
|
||||
return sent;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Wait for input to be ready on @a fd, timing out after @a timeout.
|
||||
*
|
||||
* @param fd file descriptor to poll
|
||||
* @param timeout amount of time to wait before giving up
|
||||
*
|
||||
* @throws std::system_error error returned when polling
|
||||
* @throws std::runtime_error error on socket, or hang up was detected
|
||||
*
|
||||
* @returns @ref 0 if there is no data, positive value if there is data
|
||||
*/
|
||||
template <typename Rep, typename Period>
|
||||
static int Poll(Socket fd, std::chrono::duration<Rep, Period> timeout) noexcept(false) {
|
||||
struct pollfd pollfd{
|
||||
.fd = fd,
|
||||
.events = POLLIN,
|
||||
};
|
||||
|
||||
int ret;
|
||||
|
||||
#ifdef _WIN32
|
||||
ret = WSAPoll(&pollfd, 1, std::chrono::duration_cast<std::chrono::milliseconds>(timeout).count());
|
||||
#else
|
||||
{
|
||||
auto s = std::chrono::duration_cast<std::chrono::seconds>(timeout);
|
||||
auto ns = std::chrono::duration_cast<std::chrono::nanoseconds>(timeout - s);
|
||||
struct timespec ts{
|
||||
.tv_sec = s.count(),
|
||||
.tv_nsec = ns.count(),
|
||||
};
|
||||
ret = ppoll(&pollfd, 1, timeout == timeout.zero() ? nullptr : &ts, nullptr);
|
||||
}
|
||||
#endif
|
||||
|
||||
#ifdef _WIN32
|
||||
constexpr int InterruptedErrno = WSAEINTR;
|
||||
#else
|
||||
constexpr int InterruptedErrno = EINTR;
|
||||
#endif
|
||||
|
||||
if (ret == SocketError) {
|
||||
int err = GetLastSocketError();
|
||||
throw std::system_error(err, std::system_category(), "Poll() failed");
|
||||
}
|
||||
|
||||
if ((pollfd.revents & (POLLERR | POLLHUP)) != 0) {
|
||||
throw std::runtime_error("Socket connection lost");
|
||||
}
|
||||
|
||||
return pollfd.revents & POLLIN;
|
||||
}
|
||||
|
||||
BridgeTransport(std::function<void(MessageHeader&&)> on_message_received = {},
|
||||
std::function<void()> on_connect = {},
|
||||
std::function<void()> on_disconnect = {},
|
||||
std::function<void(std::exception&)> on_error = {})
|
||||
: connect_callback_(on_connect)
|
||||
, message_callback_(on_message_received)
|
||||
, disconnect_callback_(on_disconnect)
|
||||
, error_callback_(on_error) {
|
||||
#ifdef _WIN32
|
||||
WSADATA _ws_data;
|
||||
if (int ret = WSAStartup(MAKEWORD(2, 2), &_ws_data); ret != 0) {
|
||||
Logger::Get().Error("WSAStartup failed with code {}", ret);
|
||||
return;
|
||||
}
|
||||
#endif
|
||||
}
|
||||
|
||||
virtual ~BridgeTransport() {
|
||||
Stop();
|
||||
#ifdef _WIN32
|
||||
WSACleanup();
|
||||
#endif
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Starts the channel by creating a thread.
|
||||
*
|
||||
* Connects and automatic reconnects with a timeout are implemented internally.
|
||||
*/
|
||||
void Start();
|
||||
|
||||
/**
|
||||
* @brief Stops the channel by stopping the thread and closing the connection handles.
|
||||
*
|
||||
* Blocks until the thread is stopped and the connection handles are closed.
|
||||
*/
|
||||
void Stop();
|
||||
|
||||
/**
|
||||
* @brief Stops the channel asynchronously and returns immediately.
|
||||
*/
|
||||
void StopAsync();
|
||||
|
||||
/**
|
||||
* @brief Sends a message over the channel, you must Finish() the builder before calling this.
|
||||
*
|
||||
* @param message The message to send.
|
||||
*/
|
||||
void SendMessage(const flatbuffers::FlatBufferBuilder& fbb);
|
||||
|
||||
/**
|
||||
* @brief Checks if the channel is connected.
|
||||
*
|
||||
* @return true if the channel is connected, false otherwise.
|
||||
*/
|
||||
bool IsConnected() const {
|
||||
std::shared_lock fd_lock(fd_mutex_);
|
||||
return fd_ != InvalidSocket;
|
||||
};
|
||||
|
||||
protected:
|
||||
/**
|
||||
* @brief Try to create a connection.
|
||||
*
|
||||
* Called while an exclusive lock is taken on @ref fd_mutex_.
|
||||
* Make sure this doesn't block as it will hold up shutdown.
|
||||
*
|
||||
* @ref fd_ must be initialised if this returns without throwing.
|
||||
*
|
||||
* @throws std::system_error I/O error when creating connection
|
||||
* @throws std::exception failed to create connection
|
||||
*/
|
||||
virtual void CreateConnection() = 0;
|
||||
/**
|
||||
* @brief Close the current socket if it's connected.
|
||||
*
|
||||
* Locks @ref fd_mutex_, do not call this with the mutex locked.
|
||||
*/
|
||||
void ResetConnection();
|
||||
|
||||
/**
|
||||
* @brief Closes the current connection, must be called while an exclusive lock is taken on the mutex.
|
||||
*/
|
||||
void CloseConnectionHandles();
|
||||
|
||||
void OnConnect() {
|
||||
if (connect_callback_)
|
||||
connect_callback_();
|
||||
}
|
||||
void OnRecv(std::span<uint8_t> event);
|
||||
void OnDisconnect() {
|
||||
if (disconnect_callback_)
|
||||
disconnect_callback_();
|
||||
}
|
||||
|
||||
static std::filesystem::path GetSocketPath();
|
||||
|
||||
/// Guards @ref fd_ and the condition variable @ref cv_.
|
||||
mutable std::shared_mutex fd_mutex_;
|
||||
/// Guards write operations.
|
||||
mutable std::mutex write_mutex_;
|
||||
/// Signaled on connection, or when we're exiting.
|
||||
std::condition_variable_any cv_;
|
||||
Socket fd_ = InvalidSocket;
|
||||
|
||||
private:
|
||||
void RunThread(std::stop_token stop);
|
||||
|
||||
std::function<void()> connect_callback_;
|
||||
std::function<void(MessageHeader&&)> message_callback_;
|
||||
std::function<void()> disconnect_callback_;
|
||||
std::function<void(std::exception&)> error_callback_;
|
||||
|
||||
std::jthread thread_;
|
||||
std::jthread reconnect_thread_;
|
||||
std::optional<std::error_code> last_error_;
|
||||
};
|
||||
@@ -1,17 +0,0 @@
|
||||
// SPDX-License-Identifier: MIT OR Apache-2.0
|
||||
// SPDX-FileCopyrightText: (c) 2026 Eiren Rain and SlimeVR Contributors
|
||||
#pragma once
|
||||
|
||||
#include <bit>
|
||||
#include <type_traits>
|
||||
|
||||
template <std::endian Endianness, typename T>
|
||||
requires(std::is_integral_v<T>)
|
||||
inline T ConvertEndianness(T v) {
|
||||
// I don't really care about mixed endianness..
|
||||
if constexpr (std::endian::native == Endianness) {
|
||||
return v;
|
||||
} else {
|
||||
return std::byteswap(v);
|
||||
}
|
||||
}
|
||||
@@ -7,7 +7,7 @@
|
||||
#endif
|
||||
|
||||
Logger::Logger()
|
||||
: log_stream(Paths::GetLogPath() / "slimevr-bindings-provider.log",
|
||||
: log_stream(Paths::getLogPath() / "slimevr-bindings-provider.log",
|
||||
std::ios::out | std::ios::app)
|
||||
#ifdef _WIN32
|
||||
, should_log_to_std_streams(GetConsoleWindow() != nullptr)
|
||||
@@ -15,7 +15,7 @@ Logger::Logger()
|
||||
{
|
||||
}
|
||||
|
||||
Logger& Logger::Get() {
|
||||
Logger &Logger::get() {
|
||||
static Logger logger;
|
||||
return logger;
|
||||
}
|
||||
@@ -15,8 +15,8 @@ private:
|
||||
#endif
|
||||
|
||||
template <bool important, typename... Args>
|
||||
void Log(std::string_view suffix, std::format_string<Args...> fmt,
|
||||
Args&&... args) {
|
||||
void log(std::string_view suffix, std::format_string<Args...> fmt,
|
||||
Args &&...args) {
|
||||
auto now = std::chrono::system_clock::now();
|
||||
auto time_t = std::chrono::system_clock::to_time_t(now);
|
||||
|
||||
@@ -40,28 +40,28 @@ public:
|
||||
Logger();
|
||||
|
||||
template <typename... Args>
|
||||
void Debug(std::format_string<Args...> fmt, Args&&... args) {
|
||||
void debug(std::format_string<Args...> fmt, Args &&...args) {
|
||||
#ifndef NDEBUG
|
||||
Log<false>("[DEBUG]", fmt, std::forward<Args>(args)...);
|
||||
log<false>("[DEBUG]", fmt, std::forward<Args>(args)...);
|
||||
#endif
|
||||
}
|
||||
|
||||
template <typename... Args>
|
||||
void Info(std::format_string<Args...> fmt, Args&&... args) {
|
||||
Log<false>("[INFO]", fmt, std::forward<Args>(args)...);
|
||||
void info(std::format_string<Args...> fmt, Args &&...args) {
|
||||
log<false>("[INFO]", fmt, std::forward<Args>(args)...);
|
||||
}
|
||||
|
||||
template <typename... Args>
|
||||
void Warning(std::format_string<Args...> fmt, Args&&... args) {
|
||||
Log<true>("[WARN]", fmt, std::forward<Args>(args)...);
|
||||
void warning(std::format_string<Args...> fmt, Args &&...args) {
|
||||
log<true>("[WARN]", fmt, std::forward<Args>(args)...);
|
||||
}
|
||||
|
||||
template <typename... Args>
|
||||
void Error(std::format_string<Args...> fmt, Args&&... args) {
|
||||
Log<true>("[ERROR]", fmt, std::forward<Args>(args)...);
|
||||
void error(std::format_string<Args...> fmt, Args &&...args) {
|
||||
log<true>("[ERROR]", fmt, std::forward<Args>(args)...);
|
||||
}
|
||||
|
||||
void Flush() {
|
||||
void flush() {
|
||||
#ifdef _WIN32
|
||||
if (should_log_to_std_streams) {
|
||||
#endif
|
||||
@@ -73,5 +73,5 @@ public:
|
||||
log_stream.flush();
|
||||
}
|
||||
|
||||
static Logger& Get();
|
||||
static Logger &get();
|
||||
};
|
||||
+113
-81
@@ -1,3 +1,4 @@
|
||||
#include <cassert>
|
||||
#include <csignal>
|
||||
#include <map>
|
||||
#include <optional>
|
||||
@@ -8,15 +9,13 @@
|
||||
#include "flatbuffers/flatbuffers.h"
|
||||
#include "solarxr_protocol/generated/all_generated.h"
|
||||
|
||||
#include "bridge/BridgeClient.hpp"
|
||||
#include "logger.hpp"
|
||||
#include "solarxr.hpp"
|
||||
#include "vr_utils.hpp"
|
||||
|
||||
#include "openvr.h"
|
||||
|
||||
#ifdef _WIN32
|
||||
#define WIN32_MEAN_AND_LEAN
|
||||
#define NOMINMAX
|
||||
#include <Windows.h>
|
||||
#else
|
||||
#include <cstdlib>
|
||||
@@ -26,77 +25,83 @@ namespace fs = std::filesystem;
|
||||
using namespace std::chrono_literals;
|
||||
using namespace solarxr_protocol;
|
||||
|
||||
static void ShutdownVR(vr::IVRSystem* _sys) { vr::VR_Shutdown(); }
|
||||
static void shutdown_vr(vr::IVRSystem *_sys) { vr::VR_Shutdown(); }
|
||||
|
||||
static void OnYawReset(BridgeTransport& conn) {
|
||||
static void onYawReset(SolarXRConnection &conn) {
|
||||
flatbuffers::FlatBufferBuilder fbb;
|
||||
|
||||
auto resetReq = rpc::CreateResetRequest(fbb, rpc::ResetType::YAW, 0, 0.f);
|
||||
auto msgHeader = rpc::CreateRpcMessageHeader(fbb, 0, 0, rpc::RpcMessage::ResetRequest, resetReq.Union());
|
||||
auto resetReq = rpc::CreateResetRequest(fbb, rpc::ResetType::Yaw, 0, 0.f);
|
||||
auto msgHeader = rpc::CreateRpcMessageHeader(
|
||||
fbb, nullptr, rpc::RpcMessage::ResetRequest, resetReq.Union());
|
||||
|
||||
auto rpcMsgs = fbb.CreateVector({ msgHeader });
|
||||
auto bundle = CreateMessageBundle(fbb, 0, rpcMsgs);
|
||||
auto bundle = CreateMessageBundle(fbb, 0, rpcMsgs, 0);
|
||||
fbb.Finish(bundle);
|
||||
conn.SendMessage(fbb);
|
||||
conn.sendMsg(fbb);
|
||||
}
|
||||
static void OnFullReset(BridgeTransport& conn) {
|
||||
static void onFullReset(SolarXRConnection &conn) {
|
||||
flatbuffers::FlatBufferBuilder fbb;
|
||||
|
||||
auto resetReq = rpc::CreateResetRequest(fbb, rpc::ResetType::FULL, 0, 0.f);
|
||||
auto msgHeader = rpc::CreateRpcMessageHeader(fbb, 0, 0, rpc::RpcMessage::ResetRequest, resetReq.Union());
|
||||
auto resetReq = rpc::CreateResetRequest(fbb, rpc::ResetType::Full, 0, 0.f);
|
||||
auto msgHeader = rpc::CreateRpcMessageHeader(
|
||||
fbb, nullptr, rpc::RpcMessage::ResetRequest, resetReq.Union());
|
||||
|
||||
auto rpcMsgs = fbb.CreateVector({ msgHeader });
|
||||
auto bundle = CreateMessageBundle(fbb, 0, rpcMsgs);
|
||||
auto bundle = CreateMessageBundle(fbb, 0, rpcMsgs, 0);
|
||||
fbb.Finish(bundle);
|
||||
conn.SendMessage(fbb);
|
||||
conn.sendMsg(fbb);
|
||||
}
|
||||
static void OnMountingCalibration(BridgeTransport& conn) {
|
||||
static void onMountingCalibration(SolarXRConnection &conn) {
|
||||
flatbuffers::FlatBufferBuilder fbb;
|
||||
|
||||
auto resetReq = rpc::CreateResetRequest(fbb, rpc::ResetType::MOUNTING, 0, 0.f);
|
||||
auto msgHeader = rpc::CreateRpcMessageHeader(fbb, 0, 0, rpc::RpcMessage::ResetRequest, resetReq.Union());
|
||||
auto resetReq = rpc::CreateResetRequest(fbb, rpc::ResetType::Mounting, 0, 0.f);
|
||||
auto msgHeader = rpc::CreateRpcMessageHeader(
|
||||
fbb, nullptr, rpc::RpcMessage::ResetRequest, resetReq.Union());
|
||||
|
||||
auto rpcMsgs = fbb.CreateVector({ msgHeader });
|
||||
auto bundle = CreateMessageBundle(fbb, 0, rpcMsgs);
|
||||
auto bundle = CreateMessageBundle(fbb, 0, rpcMsgs, 0);
|
||||
fbb.Finish(bundle);
|
||||
conn.SendMessage(fbb);
|
||||
conn.sendMsg(fbb);
|
||||
}
|
||||
static void OnFeetMountingCalibration(BridgeTransport& conn) {
|
||||
static void onFeetMountingCalibration(SolarXRConnection &conn) {
|
||||
flatbuffers::FlatBufferBuilder fbb;
|
||||
|
||||
auto bodyParts = fbb.CreateVector(
|
||||
{ datatypes::BodyPart::LEFT_FOOT, datatypes::BodyPart::RIGHT_FOOT });
|
||||
auto resetReq = rpc::CreateResetRequest(fbb, rpc::ResetType::MOUNTING, bodyParts, 0.f);
|
||||
auto msgHeader = rpc::CreateRpcMessageHeader(fbb, 0, 0, rpc::RpcMessage::ResetRequest, resetReq.Union());
|
||||
auto resetReq = rpc::CreateResetRequest(fbb, rpc::ResetType::Mounting, bodyParts, 0.f);
|
||||
auto msgHeader = rpc::CreateRpcMessageHeader(
|
||||
fbb, nullptr, rpc::RpcMessage::ResetRequest, resetReq.Union());
|
||||
|
||||
auto rpcMsgs = fbb.CreateVector({ msgHeader });
|
||||
auto bundle = CreateMessageBundle(fbb, 0, rpcMsgs);
|
||||
auto bundle = CreateMessageBundle(fbb, 0, rpcMsgs, 0);
|
||||
fbb.Finish(bundle);
|
||||
conn.SendMessage(fbb);
|
||||
conn.sendMsg(fbb);
|
||||
}
|
||||
static void OnToggleTracking(BridgeTransport& conn) {
|
||||
static void onToggleTracking(SolarXRConnection &conn) {
|
||||
static bool shouldPause = false;
|
||||
flatbuffers::FlatBufferBuilder fbb;
|
||||
|
||||
shouldPause = !shouldPause;
|
||||
auto toggleReq = rpc::CreateSetPauseTrackingRequest(fbb, shouldPause);
|
||||
auto msgHeader = rpc::CreateRpcMessageHeader(fbb, 0, 0, rpc::RpcMessage::SetPauseTrackingRequest, toggleReq.Union());
|
||||
auto msgHeader = rpc::CreateRpcMessageHeader(
|
||||
fbb, nullptr, rpc::RpcMessage::SetPauseTrackingRequest,
|
||||
toggleReq.Union());
|
||||
|
||||
auto rpcMsgs = fbb.CreateVector({ msgHeader });
|
||||
auto bundle = CreateMessageBundle(fbb, 0, rpcMsgs);
|
||||
auto bundle = CreateMessageBundle(fbb, 0, rpcMsgs, 0);
|
||||
fbb.Finish(bundle);
|
||||
conn.SendMessage(fbb);
|
||||
conn.sendMsg(fbb);
|
||||
}
|
||||
|
||||
sig_atomic_t should_exit = 0;
|
||||
|
||||
static void OnSignal(int signal) {
|
||||
Logger::Get().Info("Received signal {}", signal);
|
||||
static void signal_handler(int signal) {
|
||||
Logger::get().info("Received signal {}", signal);
|
||||
should_exit = 1;
|
||||
}
|
||||
|
||||
int main() {
|
||||
auto& logger = Logger::Get();
|
||||
auto &logger = Logger::get();
|
||||
|
||||
// Steam and SteamVR respectively set these environment variables on applications that
|
||||
// they spawn, which the SteamVR client library (vrclient) will then use as the
|
||||
@@ -116,8 +121,8 @@ int main() {
|
||||
//
|
||||
// This is not documented anywhere publicly, see CVRClient::SendConnectMessage in vrclient instead.
|
||||
|
||||
constexpr const char* STEAM_APPID = "3245490";
|
||||
constexpr const char* STEAMVR_APPKEY = "steam.overlay.3245490";
|
||||
constexpr const char *STEAM_APPID = "3245490";
|
||||
constexpr const char *STEAMVR_APPKEY = "steam.overlay.3245490";
|
||||
|
||||
#ifdef _WIN32
|
||||
SetEnvironmentVariableA("SteamAppId", STEAM_APPID);
|
||||
@@ -128,10 +133,9 @@ int main() {
|
||||
#endif
|
||||
|
||||
try {
|
||||
BridgeClient conn(nullptr, nullptr, [] { should_exit = 1; }, [](std::exception&) { should_exit = 1; });
|
||||
conn.Start();
|
||||
|
||||
std::unique_ptr<vr::IVRSystem, decltype(&ShutdownVR)> sys{ nullptr, ShutdownVR };
|
||||
SolarXRConnection conn;
|
||||
std::unique_ptr<vr::IVRSystem, decltype(&shutdown_vr)> sys{ nullptr,
|
||||
shutdown_vr };
|
||||
|
||||
// On vrlink, VR_Init returns
|
||||
// VRInitError_Driver_WirelessHmdNotConnected while the connection
|
||||
@@ -146,19 +150,22 @@ int main() {
|
||||
}
|
||||
|
||||
if (sys == nullptr or err != vr::VRInitError_None) {
|
||||
logger.Error("Failed to init OpenVR: {} ({})",
|
||||
logger.error("Failed to init OpenVR: {} ({})",
|
||||
vr::VR_GetVRInitErrorAsSymbol(err),
|
||||
vr::VR_GetVRInitErrorAsEnglishDescription(err));
|
||||
return 1;
|
||||
}
|
||||
|
||||
logger.Info("Initialised OpenVR, HMD model '{}'", VRUtils::GetStringProp(vr::k_unTrackedDeviceIndex_Hmd, vr::Prop_ModelNumber_String).value_or("<unknown>"));
|
||||
logger.info("Initialised OpenVR, HMD model '{}'",
|
||||
VRUtils::getStringProp(vr::k_unTrackedDeviceIndex_Hmd,
|
||||
vr::Prop_ModelNumber_String)
|
||||
.value_or("<unknown>"));
|
||||
|
||||
vr::IVRApplications* app = vr::VRApplications();
|
||||
vr::IVRInput* input = vr::VRInput();
|
||||
vr::IVRApplications *app = vr::VRApplications();
|
||||
vr::IVRInput *input = vr::VRInput();
|
||||
|
||||
fs::path actionManifestPath;
|
||||
std::tie(std::ignore, actionManifestPath) = VRUtils::InitialiseManifests();
|
||||
std::tie(std::ignore, actionManifestPath) = VRUtils::initialiseManifest();
|
||||
|
||||
// We don't want our app key to randomly change if SteamVR decides to honour
|
||||
// application manifests with no binary path. Instead let it generate an
|
||||
@@ -175,16 +182,21 @@ int main() {
|
||||
// SetActionManifestPath may return IPCError if vrserver is busy and takes
|
||||
// too long to reply, so keep invoking until it succeeds
|
||||
{
|
||||
vr::EVRInputError err;
|
||||
vr::EVRInputError err{};
|
||||
constexpr int max_tries = 5;
|
||||
int tries = 0;
|
||||
while ((err = input->SetActionManifestPath(actionManifestPath.string().data())) == vr::VRInputError_IPCError && tries++ < max_tries) {
|
||||
logger.Debug("IPC error loading action manifest, retrying ({}/{})", tries, max_tries);
|
||||
while ((err = input->SetActionManifestPath(
|
||||
actionManifestPath.string().data()))
|
||||
== vr::VRInputError_IPCError
|
||||
&& tries++ < max_tries) {
|
||||
logger.debug("IPC error loading action manifest, retrying ({}/{})",
|
||||
tries, max_tries);
|
||||
std::this_thread::sleep_for(20ms);
|
||||
}
|
||||
|
||||
if (err != vr::VRInputError_None) {
|
||||
logger.Error("Failed to set action manifest path: {}", std::to_underlying(err));
|
||||
logger.error("Failed to set action manifest path: {}",
|
||||
std::to_underlying(err));
|
||||
return 1;
|
||||
}
|
||||
}
|
||||
@@ -192,60 +204,74 @@ int main() {
|
||||
vr::VRActionSetHandle_t action_set;
|
||||
if (auto err = input->GetActionSetHandle("/actions/main", &action_set);
|
||||
err != vr::VRInputError_None) {
|
||||
logger.Error("Failed to get main action set handle: {}", std::to_underlying(err));
|
||||
logger.error("Failed to get main action set handle: {}",
|
||||
std::to_underlying(err));
|
||||
return 1;
|
||||
}
|
||||
|
||||
std::map<std::string, std::tuple<vr::VRActionHandle_t, std::function<void(BridgeTransport&)>>>
|
||||
std::map<std::string, std::tuple<vr::VRActionHandle_t, std::function<void(SolarXRConnection &)>>>
|
||||
actions{
|
||||
{ "/actions/main/in/YawReset", std::make_tuple(vr::k_ulInvalidActionHandle, OnYawReset) },
|
||||
{ "/actions/main/in/FullReset", std::make_tuple(vr::k_ulInvalidActionHandle, OnFullReset) },
|
||||
{ "/actions/main/in/MountingCalibration", std::make_tuple(vr::k_ulInvalidActionHandle, OnMountingCalibration) },
|
||||
{ "/actions/main/in/FeetMountingCalibration", std::make_tuple(vr::k_ulInvalidActionHandle, OnFeetMountingCalibration) },
|
||||
{ "/actions/main/in/ToggleTracking", std::make_tuple(vr::k_ulInvalidActionHandle, OnToggleTracking) },
|
||||
{ "/actions/main/in/YawReset",
|
||||
std::make_tuple(vr::k_ulInvalidActionHandle, onYawReset) },
|
||||
{ "/actions/main/in/FullReset",
|
||||
std::make_tuple(vr::k_ulInvalidActionHandle, onFullReset) },
|
||||
{ "/actions/main/in/MountingCalibration",
|
||||
std::make_tuple(vr::k_ulInvalidActionHandle,
|
||||
onMountingCalibration) },
|
||||
{ "/actions/main/in/FeetMountingCalibration",
|
||||
std::make_tuple(vr::k_ulInvalidActionHandle,
|
||||
onFeetMountingCalibration) },
|
||||
{ "/actions/main/in/ToggleTracking",
|
||||
std::make_tuple(vr::k_ulInvalidActionHandle, onToggleTracking) },
|
||||
};
|
||||
|
||||
for (auto& [name, tuple] : actions) {
|
||||
auto& [handle, _] = tuple;
|
||||
for (auto &[name, tuple] : actions) {
|
||||
auto &[handle, _] = tuple;
|
||||
if (auto err = input->GetActionHandle(name.c_str(), &handle);
|
||||
err != vr::VRInputError_None || handle == vr::k_ulInvalidActionHandle) {
|
||||
logger.Warning("Failed to get action handle for action {}: {}", name,
|
||||
logger.warning("Failed to get action handle for action {}: {}", name,
|
||||
std::to_underlying(err));
|
||||
}
|
||||
}
|
||||
|
||||
constexpr auto interval = 1000ms / 30;
|
||||
|
||||
signal(SIGINT, OnSignal);
|
||||
signal(SIGTERM, OnSignal);
|
||||
signal(SIGINT, signal_handler);
|
||||
signal(SIGTERM, signal_handler);
|
||||
while (!should_exit) {
|
||||
vr::VREvent_t event{};
|
||||
while (sys->PollNextEvent(&event, sizeof(event))) {
|
||||
switch (event.eventType) {
|
||||
case vr::VREvent_Quit:
|
||||
logger.Info("OpenVR runtime requested quit");
|
||||
logger.info("OpenVR runtime requested quit");
|
||||
should_exit = 1;
|
||||
break;
|
||||
case vr::VREvent_Input_BindingLoadFailed: {
|
||||
auto& loadData = event.data.inputBinding;
|
||||
logger.Debug("Binding load failed (ulAppContainer={} pathMessage={} pathUrl={} pathControllerType={})",
|
||||
loadData.ulAppContainer, loadData.pathMessage, loadData.pathUrl, loadData.pathControllerType);
|
||||
auto &loadData = event.data.inputBinding;
|
||||
logger.debug("Binding load failed (ulAppContainer={} "
|
||||
"pathMessage={} pathUrl={} pathControllerType={})",
|
||||
loadData.ulAppContainer, loadData.pathMessage,
|
||||
loadData.pathUrl, loadData.pathControllerType);
|
||||
break;
|
||||
}
|
||||
case vr::VREvent_Input_BindingLoadSuccessful: {
|
||||
auto& loadData = event.data.inputBinding;
|
||||
logger.Debug("Binding load successful (ulAppContainer={} pathMessage={} pathUrl={} pathControllerType={})",
|
||||
loadData.ulAppContainer, loadData.pathMessage, loadData.pathUrl, loadData.pathControllerType);
|
||||
auto &loadData = event.data.inputBinding;
|
||||
logger.debug("Binding load successful (ulAppContainer={} "
|
||||
"pathMessage={} pathUrl={} pathControllerType={})",
|
||||
loadData.ulAppContainer, loadData.pathMessage,
|
||||
loadData.pathUrl, loadData.pathControllerType);
|
||||
break;
|
||||
}
|
||||
case vr::VREvent_Input_ActionManifestReloaded:
|
||||
logger.Debug("Action manifest reloaded");
|
||||
logger.debug("Action manifest reloaded");
|
||||
break;
|
||||
case vr::VREvent_Input_ActionManifestLoadFailed: {
|
||||
auto& manifestData = event.data.actionManifest;
|
||||
logger.Debug(
|
||||
"Action manifest load failed (pathAppKey={} pathMessage={} pathMessageParam={} pathManifestPath={})",
|
||||
manifestData.pathAppKey, manifestData.pathMessage, manifestData.pathMessageParam, manifestData.pathManifestPath);
|
||||
auto &manifestData = event.data.actionManifest;
|
||||
logger.debug(
|
||||
"Action manifest load failed (pathAppKey={} pathMessage={} "
|
||||
"pathMessageParam={} pathManifestPath={})",
|
||||
manifestData.pathAppKey, manifestData.pathMessage,
|
||||
manifestData.pathMessageParam, manifestData.pathManifestPath);
|
||||
break;
|
||||
}
|
||||
default:
|
||||
@@ -253,6 +279,11 @@ int main() {
|
||||
}
|
||||
}
|
||||
|
||||
if (!conn.connected()) {
|
||||
logger.warning("Connection to SlimeVR lost, exiting");
|
||||
break;
|
||||
}
|
||||
|
||||
vr::VRActiveActionSet_t set{
|
||||
.ulActionSet = action_set,
|
||||
.ulRestrictedToDevice = vr::k_ulInvalidInputValueHandle,
|
||||
@@ -261,38 +292,39 @@ int main() {
|
||||
};
|
||||
if (auto err = input->UpdateActionState(&set, sizeof(set), 1);
|
||||
err != vr::VRInputError_None) {
|
||||
logger.Warning("Error when updating action states: {}",
|
||||
logger.warning("Error when updating action states: {}",
|
||||
std::to_underlying(err));
|
||||
}
|
||||
|
||||
for (auto& [name, tuple] : actions) {
|
||||
auto& [handle, callback] = tuple;
|
||||
for (auto &[name, tuple] : actions) {
|
||||
auto &[handle, callback] = tuple;
|
||||
vr::InputDigitalActionData_t action_data{};
|
||||
if (auto err = input->GetDigitalActionData(
|
||||
handle, &action_data, sizeof(action_data),
|
||||
vr::k_ulInvalidInputValueHandle);
|
||||
err != vr::VRInputError_None) {
|
||||
logger.Warning("Failed to get action state for {} ({}): {}", name, handle, std::to_underlying(err));
|
||||
logger.warning("Failed to get action state for {} ({}): {}", name,
|
||||
handle, std::to_underlying(err));
|
||||
continue;
|
||||
}
|
||||
|
||||
if (action_data.bActive && action_data.bChanged && action_data.bState) {
|
||||
logger.Debug("Action {} triggered", name);
|
||||
logger.debug("Action {} triggered", name);
|
||||
callback(conn);
|
||||
}
|
||||
}
|
||||
|
||||
logger.Flush();
|
||||
logger.flush();
|
||||
std::this_thread::sleep_for(interval);
|
||||
}
|
||||
|
||||
logger.Info("Main loop done");
|
||||
} catch (std::exception& ex) {
|
||||
logger.Error("Exception in main: {}", ex.what());
|
||||
logger.Flush();
|
||||
logger.info("Main loop done");
|
||||
} catch (std::exception &ex) {
|
||||
logger.error("Exception in main: {}", ex.what());
|
||||
logger.flush();
|
||||
return 1;
|
||||
}
|
||||
|
||||
logger.Flush();
|
||||
logger.flush();
|
||||
return 0;
|
||||
}
|
||||
@@ -1,22 +1,15 @@
|
||||
#include "paths.hpp"
|
||||
|
||||
#ifdef _WIN32
|
||||
#define WIN32_LEAN_AND_MEAN
|
||||
#define NOMINMAX
|
||||
#include <Windows.h>
|
||||
#undef GetTempPath
|
||||
#endif
|
||||
|
||||
namespace fs = std::filesystem;
|
||||
|
||||
fs::path Paths::GetDataPath() {
|
||||
fs::path Paths::getDataPath() {
|
||||
fs::path basePath{};
|
||||
|
||||
#if defined(__linux__)
|
||||
if (const char* dataHomeOverride = getenv("XDG_DATA_HOME")) {
|
||||
if (const char *dataHomeOverride = getenv("XDG_DATA_HOME")) {
|
||||
basePath = dataHomeOverride;
|
||||
} else {
|
||||
const char* homeDir = getenv("HOME");
|
||||
const char *homeDir = getenv("HOME");
|
||||
if (homeDir == nullptr)
|
||||
throw std::runtime_error("HOME is unset");
|
||||
|
||||
@@ -24,7 +17,7 @@ fs::path Paths::GetDataPath() {
|
||||
}
|
||||
#elif defined(_WIN32)
|
||||
{
|
||||
const char* appData = getenv("APPDATA");
|
||||
const char *appData = getenv("APPDATA");
|
||||
if (appData == nullptr)
|
||||
throw std::runtime_error("APPDATA is unset");
|
||||
|
||||
@@ -37,18 +30,4 @@ fs::path Paths::GetDataPath() {
|
||||
return basePath / "dev.slimevr.SlimeVR";
|
||||
}
|
||||
|
||||
fs::path Paths::GetLogPath() { return Paths::GetDataPath() / "logs"; }
|
||||
|
||||
fs::path Paths::GetTempPath() noexcept {
|
||||
#ifdef _WIN32
|
||||
WCHAR tmp_dir[MAX_PATH + 1];
|
||||
GetTempPathW(std::size(tmp_dir), tmp_dir);
|
||||
return tmp_dir;
|
||||
#else
|
||||
if (const char* tmp_dir = getenv("TMPDIR")) {
|
||||
return tmp_dir;
|
||||
}
|
||||
|
||||
return "/tmp";
|
||||
#endif
|
||||
}
|
||||
fs::path Paths::getLogPath() { return Paths::getDataPath() / "logs"; }
|
||||
@@ -4,10 +4,8 @@
|
||||
|
||||
namespace Paths {
|
||||
// Throws when path cannot be found
|
||||
std::filesystem::path GetDataPath() noexcept(false);
|
||||
std::filesystem::path getDataPath() noexcept(false);
|
||||
|
||||
// Throws when path cannot be found
|
||||
std::filesystem::path GetLogPath() noexcept(false);
|
||||
|
||||
std::filesystem::path GetTempPath() noexcept;
|
||||
std::filesystem::path getLogPath() noexcept(false);
|
||||
} // namespace Paths
|
||||
@@ -0,0 +1,174 @@
|
||||
#include "solarxr.hpp"
|
||||
#include "logger.hpp"
|
||||
#include "paths.hpp"
|
||||
|
||||
#include <stdexcept>
|
||||
#include <string>
|
||||
|
||||
#if defined(__linux__)
|
||||
#include <sys/socket.h>
|
||||
#include <sys/un.h>
|
||||
#elif defined(_WIN32)
|
||||
#include <Windows.h>
|
||||
#else
|
||||
#error "Unsupported platform"
|
||||
#endif
|
||||
|
||||
namespace fs = std::filesystem;
|
||||
|
||||
static std::string getenvSafe(const char *env) {
|
||||
char *v = getenv(env);
|
||||
if (v == nullptr)
|
||||
return {};
|
||||
|
||||
return v;
|
||||
}
|
||||
|
||||
fs::path SolarXRConnection::getSocketPath() {
|
||||
using namespace std::string_view_literals;
|
||||
#if defined(__linux__)
|
||||
#define MAKE_SOCKET_PATH(PATH) \
|
||||
std::make_pair(PATH##sv, getenvSafe(PATH))
|
||||
|
||||
constexpr std::string_view socketName = "SlimeVRRpc";
|
||||
std::array<std::pair<std::string_view, fs::path>, 5> socketPaths{
|
||||
MAKE_SOCKET_PATH("SLIMEVR_SOCKET_DIR"),
|
||||
{ "Steam socket path", Paths::getDataPath() },
|
||||
MAKE_SOCKET_PATH("XDG_RUNTIME_DIR"),
|
||||
MAKE_SOCKET_PATH("TMPDIR"),
|
||||
{ "/tmp", "/tmp" }
|
||||
};
|
||||
|
||||
#undef MAKE_SOCKET_PATH
|
||||
|
||||
for (auto [name, path] : socketPaths) {
|
||||
if (path.empty()) {
|
||||
Logger::get().info(
|
||||
"Skipping socket directory '{}' because it doesn't exist", name);
|
||||
continue;
|
||||
}
|
||||
fs::path socketPath = path / socketName;
|
||||
if (fs::exists(socketPath))
|
||||
return socketPath;
|
||||
|
||||
Logger::get().info(
|
||||
"Skipping socket directory '{}' because socket does not exist", name);
|
||||
}
|
||||
#elif defined(_WIN32)
|
||||
throw std::logic_error(
|
||||
"SolarXRConnection::getSocketPath should not be called on Windows");
|
||||
#else
|
||||
#error "Unsupported platform"
|
||||
#endif
|
||||
|
||||
throw std::runtime_error("Failed to find socket directory");
|
||||
}
|
||||
|
||||
SolarXRConnection::SolarXRConnection() {
|
||||
#if defined(__linux__)
|
||||
sockaddr_un addr{};
|
||||
addr.sun_family = AF_UNIX;
|
||||
strcpy(addr.sun_path, getSocketPath().string().data());
|
||||
|
||||
fd = socket(AF_UNIX, SOCK_STREAM, 0);
|
||||
if (fd == -1) {
|
||||
throw std::runtime_error(
|
||||
std::format("Failed to create listen socket: {}", strerror(errno)));
|
||||
}
|
||||
|
||||
if (connect(fd, reinterpret_cast<sockaddr *>(&addr), sizeof(addr)) == -1) {
|
||||
int e = errno;
|
||||
close(fd);
|
||||
throw std::runtime_error(std::format("Failed to connect to socket {}: {}",
|
||||
addr.sun_path, strerror(e)));
|
||||
}
|
||||
|
||||
#elif defined(_WIN32)
|
||||
const char *pipeName = R"(\\.\pipe\SlimeVRRpc)";
|
||||
if (!WaitNamedPipe(pipeName, 5000)) {
|
||||
throw std::runtime_error("Timed out waiting for pipe");
|
||||
}
|
||||
|
||||
pipe = CreateFile(pipeName, GENERIC_READ | GENERIC_WRITE, 0, nullptr,
|
||||
OPEN_EXISTING, 0, nullptr);
|
||||
if (pipe == INVALID_HANDLE_VALUE) {
|
||||
throw std::runtime_error(
|
||||
std::format("Unable to open pipe (error={})", GetLastError()));
|
||||
}
|
||||
#else
|
||||
#error "Unsupported platform"
|
||||
#endif
|
||||
}
|
||||
|
||||
SolarXRConnection::~SolarXRConnection() {
|
||||
#if defined(__linux__)
|
||||
if (fd != -1)
|
||||
close(fd);
|
||||
#elif defined(_WIN32)
|
||||
if (pipe != INVALID_HANDLE_VALUE)
|
||||
CloseHandle(pipe);
|
||||
#else
|
||||
#error "Unsupported platform"
|
||||
#endif
|
||||
}
|
||||
|
||||
bool SolarXRConnection::connected() {
|
||||
#if defined(__linux__)
|
||||
if (read(fd, nullptr, 0) == -1) {
|
||||
return !(errno == EBADF || errno == EINVAL);
|
||||
}
|
||||
|
||||
return true;
|
||||
#elif defined(_WIN32)
|
||||
if (!WriteFile(pipe, nullptr, 0, nullptr, nullptr)) {
|
||||
int err = GetLastError();
|
||||
// The documentation says it should return ERROR_BROKEN_PIPE
|
||||
// when the write-end has been closed, but it seems to actually
|
||||
// return ERROR_NO_DATA...
|
||||
return !(err == ERROR_NO_DATA || err == ERROR_BROKEN_PIPE);
|
||||
}
|
||||
|
||||
return true;
|
||||
#else
|
||||
#error "Unsupported platform"
|
||||
#endif
|
||||
}
|
||||
|
||||
void SolarXRConnection::sendMsg(flatbuffers::FlatBufferBuilder &fbb) {
|
||||
// The server expects the total size of the buffer to be written at the
|
||||
// start of the packet, including the first 4 bytes for the size
|
||||
int size = fbb.GetSize() + 4;
|
||||
// This may be wrong on mixed-endianness, but oh well...
|
||||
if constexpr (std::endian::native != std::endian::little)
|
||||
size = std::byteswap(size);
|
||||
|
||||
#if defined(__linux__)
|
||||
if (write(fd, &size, sizeof(size)) == -1) {
|
||||
Logger::get().warning("Failed to write message size to socket: {}",
|
||||
strerror(errno));
|
||||
return;
|
||||
}
|
||||
|
||||
if (write(fd, fbb.GetBufferPointer(), fbb.GetSize()) == -1) {
|
||||
Logger::get().warning("Failed to write message to socket: {}",
|
||||
strerror(errno));
|
||||
return;
|
||||
}
|
||||
#elif defined(_WIN32)
|
||||
uint8_t tempBuf[2048];
|
||||
if (fbb.GetSize() > 2048 - 4) {
|
||||
Logger::get().warning("Message is too big for temporary buffer");
|
||||
return;
|
||||
}
|
||||
|
||||
*reinterpret_cast<int *>(&tempBuf[0]) = size;
|
||||
memcpy(&tempBuf[4], fbb.GetBufferPointer(), fbb.GetSize());
|
||||
if (!WriteFile(pipe, tempBuf, fbb.GetSize() + 4, nullptr, nullptr)) {
|
||||
Logger::get().warning("Failed to write message to pipe (error={})",
|
||||
GetLastError());
|
||||
return;
|
||||
}
|
||||
#else
|
||||
#error "Unsupported platform"
|
||||
#endif
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
#pragma once
|
||||
|
||||
#include <filesystem>
|
||||
|
||||
#if defined(_WIN32)
|
||||
#define WIN32_MEAN_AND_LEAN
|
||||
#include <Windows.h>
|
||||
#endif
|
||||
|
||||
#include "flatbuffers/flatbuffer_builder.h"
|
||||
|
||||
class SolarXRConnection {
|
||||
private:
|
||||
#if defined(__linux__)
|
||||
int fd{ -1 };
|
||||
#elif defined(_WIN32)
|
||||
HANDLE pipe{ INVALID_HANDLE_VALUE };
|
||||
#else
|
||||
#error "Unsupported platform"
|
||||
#endif
|
||||
|
||||
static std::filesystem::path getSocketPath();
|
||||
|
||||
public:
|
||||
SolarXRConnection() noexcept(false);
|
||||
|
||||
~SolarXRConnection();
|
||||
|
||||
bool connected();
|
||||
void sendMsg(flatbuffers::FlatBufferBuilder &fbb);
|
||||
};
|
||||
@@ -11,14 +11,14 @@
|
||||
namespace fs = std::filesystem;
|
||||
|
||||
std::optional<std::string>
|
||||
VRUtils::GetStringProp(vr::TrackedDeviceIndex_t deviceIndex,
|
||||
VRUtils::getStringProp(vr::TrackedDeviceIndex_t deviceIndex,
|
||||
vr::ETrackedDeviceProperty prop) {
|
||||
vr::IVRSystem* sys = vr::VRSystem();
|
||||
vr::IVRSystem *sys = vr::VRSystem();
|
||||
vr::ETrackedPropertyError err{ vr::TrackedProp_Success };
|
||||
|
||||
uint32_t required_len = sys->GetStringTrackedDeviceProperty(deviceIndex, prop, nullptr, 0, &err);
|
||||
if (err != vr::TrackedProp_BufferTooSmall) {
|
||||
Logger::Get().Info(
|
||||
Logger::get().info(
|
||||
"Failed to get size of string property {} for device {}: {}",
|
||||
std::to_underlying(prop), deviceIndex,
|
||||
sys->GetPropErrorNameFromEnum(err));
|
||||
@@ -29,7 +29,7 @@ VRUtils::GetStringProp(vr::TrackedDeviceIndex_t deviceIndex,
|
||||
sys->GetStringTrackedDeviceProperty(deviceIndex, prop, s.data(), required_len,
|
||||
&err);
|
||||
if (err != vr::TrackedProp_Success) {
|
||||
Logger::Get().Info("Failed to get string property {} for device {}: {}",
|
||||
Logger::get().info("Failed to get string property {} for device {}: {}",
|
||||
std::to_underlying(prop), deviceIndex,
|
||||
sys->GetPropErrorNameFromEnum(err));
|
||||
return std::nullopt;
|
||||
@@ -38,8 +38,8 @@ VRUtils::GetStringProp(vr::TrackedDeviceIndex_t deviceIndex,
|
||||
return s;
|
||||
}
|
||||
|
||||
std::tuple<fs::path, fs::path> VRUtils::InitialiseManifests() {
|
||||
fs::path manifestDir = Paths::GetDataPath() / "bindings-provider";
|
||||
std::tuple<fs::path, fs::path> VRUtils::initialiseManifest() {
|
||||
fs::path manifestDir = Paths::getDataPath() / "bindings-provider";
|
||||
std::error_code ec;
|
||||
fs::create_directories(manifestDir, ec);
|
||||
if (ec) {
|
||||
@@ -59,7 +59,7 @@ std::tuple<fs::path, fs::path> VRUtils::InitialiseManifests() {
|
||||
std::make_pair("vive_controller.json"sv, SVR_VRAPP_VIVE_BINDS),
|
||||
};
|
||||
|
||||
for (auto& [name, contents] : requiredFiles) {
|
||||
for (auto &[name, contents] : requiredFiles) {
|
||||
fs::path path = manifestDir / name;
|
||||
if (!fs::exists(path)) {
|
||||
std::ofstream stream(path);
|
||||
|
||||
@@ -8,9 +8,9 @@
|
||||
#include "openvr.h"
|
||||
|
||||
namespace VRUtils {
|
||||
std::optional<std::string> GetStringProp(vr::TrackedDeviceIndex_t deviceIndex,
|
||||
std::optional<std::string> getStringProp(vr::TrackedDeviceIndex_t deviceIndex,
|
||||
vr::ETrackedDeviceProperty prop);
|
||||
|
||||
// Returns <app vrmanifest path, action manifest json path>
|
||||
std::tuple<std::filesystem::path, std::filesystem::path> InitialiseManifests();
|
||||
std::tuple<std::filesystem::path, std::filesystem::path> initialiseManifest();
|
||||
} // namespace VRUtils
|
||||
+7
-24
@@ -1,36 +1,19 @@
|
||||
# Crowdin Configuration File
|
||||
# https://developer.crowdin.com/configuration-file/
|
||||
|
||||
project_id_env: CROWDIN_PROJECT_ID
|
||||
api_token_env: CROWDIN_PERSONAL_TOKEN
|
||||
|
||||
files:
|
||||
- source: /gui/app/public/i18n/en/translation.ftl
|
||||
translation: /gui/app/public/i18n/%locale%/%original_file_name%
|
||||
update_option: update_as_unapproved
|
||||
languages_mapping:
|
||||
locale:
|
||||
zh-CN: zh-Hans
|
||||
zh-TW: zh-Hant
|
||||
nb: nb-NO
|
||||
nb-NO: nb-NO
|
||||
sv: sv-SE
|
||||
fr: fr
|
||||
de: de
|
||||
it: it
|
||||
ja: ja
|
||||
ko: ko
|
||||
ar: ar
|
||||
cs: cs
|
||||
da: da
|
||||
el: el
|
||||
es-419: es-419
|
||||
et: et
|
||||
fi: fi
|
||||
he: he
|
||||
lt: lt
|
||||
nl: nl
|
||||
pl: pl
|
||||
ru: ru
|
||||
th: th
|
||||
tr: tr
|
||||
uk: uk
|
||||
vi: vi
|
||||
# In-context editor pseudo-language
|
||||
ach-UG: ach-UG
|
||||
sv-SE: sv-SE
|
||||
en-OWO: en-x-owo
|
||||
owo: en-x-owo
|
||||
Generated
+9
-9
@@ -5,11 +5,11 @@
|
||||
"nixpkgs-lib": "nixpkgs-lib"
|
||||
},
|
||||
"locked": {
|
||||
"lastModified": 1790898470,
|
||||
"narHash": "sha256-zTwuwezD0w3hpga6a6P8emidzAZFyWqlNeRBlpWOOl8=",
|
||||
"lastModified": 1778716662,
|
||||
"narHash": "sha256-m1Yf0wZ8j1OHjTc2UwHwyQRSnNeSgLJOd7q5Y45hzi4=",
|
||||
"owner": "hercules-ci",
|
||||
"repo": "flake-parts",
|
||||
"rev": "024633cd702b10285db5cb19b40ad48d2399ba60",
|
||||
"rev": "f7c1a2d347e4c52d5fb8d10cb4d94b5884e546fb",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
@@ -20,11 +20,11 @@
|
||||
},
|
||||
"nixpkgs": {
|
||||
"locked": {
|
||||
"lastModified": 1790822859,
|
||||
"narHash": "sha256-69xHQhAeMAD2wDXO7T2pcOZIF9Sga2W+JkmY2a11Ops=",
|
||||
"lastModified": 1781577229,
|
||||
"narHash": "sha256-lrp67w8AulE9Ks53n27I45ADSzbOCn4H+CNW1Ck8B+8=",
|
||||
"owner": "NixOS",
|
||||
"repo": "nixpkgs",
|
||||
"rev": "c59305bab2065cfecc4944690d9eedbb56f3a9fa",
|
||||
"rev": "567a49d1913ce81ac6e9582e3553dd90a955875f",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
@@ -36,11 +36,11 @@
|
||||
},
|
||||
"nixpkgs-lib": {
|
||||
"locked": {
|
||||
"lastModified": 1790477367,
|
||||
"narHash": "sha256-oujbxmVKDhci2E4EM3KyAbRUgp5/IsCoiA/LfEF7OOk=",
|
||||
"lastModified": 1777168982,
|
||||
"narHash": "sha256-GOkGPcboWE9BmGCRMLX3worL4EMnsnG8MyKmXNeYuhQ=",
|
||||
"owner": "nix-community",
|
||||
"repo": "nixpkgs.lib",
|
||||
"rev": "f7cd230690d9fc982d06129f9189b101fddcfa3b",
|
||||
"rev": "f5901329dade4a6ea039af1433fb087bd9c1fe14",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
|
||||
@@ -20,12 +20,7 @@
|
||||
];
|
||||
|
||||
perSystem =
|
||||
{
|
||||
system,
|
||||
lib,
|
||||
pkgs,
|
||||
...
|
||||
}:
|
||||
{ lib, pkgs, ... }:
|
||||
let
|
||||
runtimeLibs = [
|
||||
pkgs.alsa-lib
|
||||
@@ -64,59 +59,67 @@
|
||||
pkgs.libxcrypt-legacy
|
||||
];
|
||||
|
||||
# we use static runtime
|
||||
# https://github.com/electron-userland/electron-builder/blob/a6117b3011a105204af8cc2eca02a56976d1ef29/packages/app-builder-lib/src/toolsets/linux.ts#L122
|
||||
appImageTools = pkgs.stdenvNoCC.mkDerivation {
|
||||
name = "electron-builder-appimage-runtime";
|
||||
src =
|
||||
let
|
||||
# Keep in sync with "appimage" toolset version in gui/electron/electron-builder.yml
|
||||
appimageToolsVersion = "1.0.3";
|
||||
in
|
||||
pkgs.fetchzip {
|
||||
url = "https://github.com/electron-userland/electron-builder-binaries/releases/download/appimage@${appimageToolsVersion}/appimage-tools-runtime-20251108.tar.gz";
|
||||
hash = "sha256-Iqhvyp6BNpH+tXvVO7MLgYbsJ6va4lXO7El3wtyWBII=";
|
||||
stripRoot = false;
|
||||
};
|
||||
toolDirectoryName =
|
||||
if pkgs.stdenv.hostPlatform.isDarwin then
|
||||
"darwin"
|
||||
else if pkgs.stdenv.hostPlatform.isLinux then
|
||||
{
|
||||
"armv7l-linux" = "linux-arm32";
|
||||
"aarch64-linux" = "linux-arm64";
|
||||
"i686-linux" = "linux-ia32";
|
||||
"x86_64-linux" = "linux-x64";
|
||||
}
|
||||
."${pkgs.stdenv.hostPlatform.system}"
|
||||
else
|
||||
throw "Unsupported platform";
|
||||
|
||||
# we use fuse2
|
||||
# https://github.com/electron-userland/electron-builder/blob/a6117b3011a105204af8cc2eca02a56976d1ef29/packages/app-builder-lib/src/toolsets/linux.ts#L122
|
||||
runtime = pkgs.stdenvNoCC.mkDerivation {
|
||||
name = "electron-builder-appimage-runtime";
|
||||
src = pkgs.fetchurl {
|
||||
url = "https://github.com/electron-userland/electron-builder-binaries/releases/download/appimage-12.0.1/appimage-12.0.1.7z";
|
||||
hash = "sha256-0S/3648dHsRlLKUjen+9yjOswMdYBFY2/spi3G7LjsQ=";
|
||||
};
|
||||
# https://github.com/NixOS/nixpkgs/blob/7890ba0a99c064446fe2178ef2f8e3abdf6ec42a/pkgs/by-name/lo/losslesscut-bin/build-from-windows.nix#L20
|
||||
nativeBuildInputs = [ pkgs.p7zip ];
|
||||
unpackPhase = ''
|
||||
runHook preUnpack
|
||||
7z x "$src"
|
||||
runHook postUnpack
|
||||
'';
|
||||
installPhase = ''
|
||||
mkdir $out
|
||||
cp -r -t $out/ lib/ runtimes/
|
||||
ln -s -t $out \
|
||||
"${pkgs.desktop-file-utils}/bin/desktop-file-validate" \
|
||||
"${pkgs.squashfsTools}/bin/mksquashfs"
|
||||
cp -r -t $out/ \
|
||||
lib/ \
|
||||
runtime-*
|
||||
'';
|
||||
};
|
||||
|
||||
buildToolsVersion = "36.0.0";
|
||||
androidComposition = pkgs.androidenv.composeAndroidPackages {
|
||||
buildToolsVersions = [
|
||||
buildToolsVersion
|
||||
];
|
||||
platformVersions = [
|
||||
"36"
|
||||
];
|
||||
appImageTools = pkgs.stdenvNoCC.mkDerivation {
|
||||
name = "electron-builder-appimage-tools";
|
||||
dontUnpack = true;
|
||||
|
||||
installPhase = ''
|
||||
mkdir -p "$out/${toolDirectoryName}"
|
||||
ln -s -t $out/${toolDirectoryName} \
|
||||
"${pkgs.desktop-file-utils}/bin/desktop-file-validate" \
|
||||
"${pkgs.squashfsTools}/bin/mksquashfs"
|
||||
ln -s ${runtime}/runtime-* $out/
|
||||
ln -s ${runtime}/lib $out/lib
|
||||
'';
|
||||
};
|
||||
in
|
||||
{
|
||||
# For Android SDK
|
||||
_module.args.pkgs = import nixpkgs {
|
||||
inherit system;
|
||||
config.allowUnfree = true;
|
||||
config.android_sdk.accept_license = true;
|
||||
};
|
||||
|
||||
devShells.default = pkgs.mkShell rec {
|
||||
devShells.default = pkgs.mkShell {
|
||||
packages = [
|
||||
# for running the jar
|
||||
pkgs.jdk25
|
||||
|
||||
pkgs.jdk17
|
||||
# for build
|
||||
pkgs.electron
|
||||
pkgs.rpm
|
||||
pkgs.fpm
|
||||
pkgs.p7zip
|
||||
# For Windows GUI cross-build
|
||||
pkgs.wineWow64Packages.stable
|
||||
pkgs.zlib
|
||||
pkgs.squashfsTools
|
||||
@@ -133,10 +136,20 @@
|
||||
pkgs.binutils
|
||||
pkgs.git
|
||||
pkgs.node-gyp-build
|
||||
androidComposition.androidsdk
|
||||
];
|
||||
buildInputs = runtimeLibs;
|
||||
|
||||
JAVA_HOME = "${pkgs.jdk17}/lib/openjdk";
|
||||
USE_SYSTEM_FPM = "true";
|
||||
ELECTRON_BUILDER_7ZIP_PATH = "${pkgs.p7zip}/bin/7za";
|
||||
APPIMAGE_TOOLS_PATH = "${appImageTools}";
|
||||
#ELECTRON_SKIP_BINARY_DOWNLOAD = true;
|
||||
#ELECTRON_DIST = "${pkgs.electron.dist}";
|
||||
#ELECTRON_VERSION = "${pkgs.electron.version}";
|
||||
|
||||
# for electron-vite, so `pnpm gui` works
|
||||
ELECTRON_EXEC_PATH = "${pkgs.electron}/bin/electron";
|
||||
|
||||
shellHook = ''
|
||||
export LD_LIBRARY_PATH="${
|
||||
lib.makeLibraryPath [
|
||||
@@ -144,21 +157,7 @@
|
||||
pkgs.hidapi
|
||||
]
|
||||
}:$LD_LIBRARY_PATH"
|
||||
|
||||
# VSCode's extension host sets ELECTRON_RUN_AS_NODE=1 on itself, and
|
||||
# shells it forks inherit it. It makes electron run as plain node, so
|
||||
# the main process crashes on `import { app } from 'electron'`.
|
||||
unset ELECTRON_RUN_AS_NODE
|
||||
'';
|
||||
|
||||
JAVA_HOME = "${pkgs.jdk25}/lib/openjdk";
|
||||
USE_SYSTEM_FPM = "true";
|
||||
ELECTRON_BUILDER_7ZIP_PATH = "${pkgs.p7zip}/bin/7za";
|
||||
APPIMAGE_TOOLS_PATH = "${appImageTools}";
|
||||
# for electron-vite, so `pnpm gui` works
|
||||
ELECTRON_EXEC_PATH = "${pkgs.electron}/bin/electron";
|
||||
ANDROID_HOME = "${androidComposition.androidsdk}/libexec/android-sdk";
|
||||
GRADLE_OPTS = "-Dorg.gradle.project.android.aapt2FromMavenOverride=${ANDROID_HOME}/build-tools/${buildToolsVersion}/aapt2";
|
||||
};
|
||||
};
|
||||
};
|
||||
|
||||
+6
-13
@@ -1,30 +1,23 @@
|
||||
# Fixes bug with spotless. See https://github.com/diffplug/spotless/issues/834#issuecomment-819118761
|
||||
org.gradle.jvmargs=-Xmx4g -Xms1g \
|
||||
--add-exports jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED \
|
||||
org.gradle.jvmargs=--add-exports jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED \
|
||||
--add-exports jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED \
|
||||
--add-exports jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED \
|
||||
--add-exports jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED \
|
||||
--add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED
|
||||
|
||||
org.gradle.parallel=true
|
||||
#org.gradle.caching=true
|
||||
org.gradle.configureondemand=true
|
||||
|
||||
kotlin.code.style=official
|
||||
# https://github.com/Kotlin/kotlinx-atomicfu#atomicfu-compiler-plugin
|
||||
kotlinx.atomicfu.enableJvmIrTransformation=true
|
||||
|
||||
android.useAndroidX=true
|
||||
android.nonTransitiveRClass=true
|
||||
#org.gradle.configuration-cache=true
|
||||
# solarxr-protocol:kotlin-codegen's generateTestSchemas isn't cache-compatible yet (submodule); degrade to a warning there instead of failing the whole build
|
||||
#org.gradle.configuration-cache.problems=warn
|
||||
org.gradle.unsafe.configuration-cache=false
|
||||
|
||||
kotlinVersion=2.3.10
|
||||
spotlessVersion=8.2.1
|
||||
shadowJarVersion=9.3.1
|
||||
buildconfigVersion=6.0.7
|
||||
wireVersion=5.3.1
|
||||
# sentry and sentry-android-core must stay on the same version
|
||||
sentryVersion=8.+
|
||||
sentryAndroidGradleVersion=6.23.0
|
||||
|
||||
# Fix gradle leaving multiple java processes running that accumulate and use multiple GBs of RAM
|
||||
# This mostly seems to affect it when running from console, and then sending a SIGINT (Ctrl + C)
|
||||
org.gradle.daemon.idletimeout=10000
|
||||
Vendored
BIN
Binary file not shown.
+2
-2
@@ -1,7 +1,7 @@
|
||||
distributionBase=GRADLE_USER_HOME
|
||||
distributionPath=wrapper/dists
|
||||
distributionSha256Sum=bbaeb2fef8710818cf0e261201dab964c572f92b942812df0c3620d62a529a01
|
||||
distributionUrl=https\://services.gradle.org/distributions/gradle-9.6.0-bin.zip
|
||||
distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.4-bin.zip
|
||||
distributionSha256Sum=f1771298a70f6db5a29daf62378c4e18a17fc33c9ba6b14362e0cdf40610380d
|
||||
networkTimeout=10000
|
||||
validateDistributionUrl=true
|
||||
zipStoreBase=GRADLE_USER_HOME
|
||||
|
||||
@@ -86,7 +86,8 @@ done
|
||||
# shellcheck disable=SC2034
|
||||
APP_BASE_NAME=${0##*/}
|
||||
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
|
||||
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
|
||||
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s
|
||||
' "$PWD" ) || exit
|
||||
|
||||
# Use the maximum available, or set MAX_FD != -1 to use that value.
|
||||
MAX_FD=maximum
|
||||
@@ -114,7 +115,7 @@ case "$( uname )" in #(
|
||||
NONSTOP* ) nonstop=true ;;
|
||||
esac
|
||||
|
||||
CLASSPATH="\\\"\\\""
|
||||
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
|
||||
|
||||
|
||||
# Determine the Java command to use to start the JVM.
|
||||
@@ -205,7 +206,7 @@ fi
|
||||
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
|
||||
|
||||
# Collect all arguments for the java command:
|
||||
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
|
||||
# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
|
||||
# and any embedded shellness will be escaped.
|
||||
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
|
||||
# treated as '${Hostname}' itself on the command line.
|
||||
@@ -213,7 +214,7 @@ DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
|
||||
set -- \
|
||||
"-Dorg.gradle.appname=$APP_BASE_NAME" \
|
||||
-classpath "$CLASSPATH" \
|
||||
-jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
|
||||
org.gradle.wrapper.GradleWrapperMain \
|
||||
"$@"
|
||||
|
||||
# Stop when "xargs" is not available.
|
||||
|
||||
Vendored
+2
-2
@@ -70,11 +70,11 @@ goto fail
|
||||
:execute
|
||||
@rem Setup the command line
|
||||
|
||||
set CLASSPATH=
|
||||
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
|
||||
|
||||
|
||||
@rem Execute Gradle
|
||||
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %*
|
||||
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
|
||||
|
||||
:end
|
||||
@rem End local scope for the variables with windows NT shell
|
||||
|
||||
File renamed without changes.
+7
-7
@@ -1,16 +1,16 @@
|
||||
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
|
||||
|
||||
# JS/TS dependencies
|
||||
node_modules/
|
||||
.pnp
|
||||
/node_modules
|
||||
/.pnp
|
||||
.pnp.js
|
||||
|
||||
# testing
|
||||
coverage/
|
||||
/coverage
|
||||
|
||||
# Build artifacts
|
||||
build/
|
||||
target/
|
||||
/build
|
||||
/target
|
||||
|
||||
# misc
|
||||
.DS_Store
|
||||
@@ -26,8 +26,8 @@ yarn-error.log*
|
||||
*.log
|
||||
|
||||
# vite
|
||||
dist/
|
||||
stats.html
|
||||
/dist
|
||||
/stats.html
|
||||
vite.config.ts.timestamp*
|
||||
electron.vite.config.*.mjs
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
export default {
|
||||
'app/**/*.{js,jsx,ts,tsx}':
|
||||
'pnpm --filter @slimevr/gui-app exec eslint --no-warn-ignored --cache --fix',
|
||||
'**/*.{ts,tsx}': () => 'tsc -p tsconfig.json --noEmit',
|
||||
'{electron,src}/**/*.{js,jsx,ts,tsx}': 'eslint --max-warnings=0 --no-warn-ignored --cache --fix',
|
||||
'**/*.{js,jsx,ts,tsx,css,scss,md,json}': 'prettier --write',
|
||||
};
|
||||
@@ -1,213 +0,0 @@
|
||||
import eslint from '@eslint/js';
|
||||
import betterTailwind from 'eslint-plugin-better-tailwindcss';
|
||||
import boundaries from 'eslint-plugin-boundaries';
|
||||
import jsxA11y from 'eslint-plugin-jsx-a11y';
|
||||
import solid from 'eslint-plugin-solid/configs/typescript';
|
||||
import globals from 'globals';
|
||||
import tseslint from 'typescript-eslint';
|
||||
import l10n from './eslint/l10n.js';
|
||||
import layers from './eslint/layers.js';
|
||||
|
||||
const UI_DEEP_IMPORT = {
|
||||
group: ['@/ui/*/*'],
|
||||
message: 'Import a ui folder through its index, e.g. @/ui/select.',
|
||||
};
|
||||
|
||||
// Each entry is allowed only in the files listed in `allowedIn`
|
||||
const restricted = {
|
||||
toFixed: {
|
||||
allowedIn: ['src/lib/format.ts'],
|
||||
selector: "CallExpression[callee.property.name='toFixed']",
|
||||
message: 'Use fmt() from @/lib/format, it is locale aware.',
|
||||
},
|
||||
intl: {
|
||||
allowedIn: ['src/lib/format.ts'],
|
||||
selector: "NewExpression[callee.object.name='Intl']",
|
||||
message: 'Use fmt/fmtList/fmtRelative from @/lib/format, they cache per locale.',
|
||||
},
|
||||
storage: {
|
||||
allowedIn: ['src/lib/storage.ts', 'src/lib/storage.test.ts'],
|
||||
selector: 'Identifier[name=/^(localStorage|sessionStorage)$/]',
|
||||
message: 'Use definePref/defineCache/defineSession from @/lib/storage.',
|
||||
},
|
||||
electronApi: {
|
||||
allowedIn: ['src/app/platform/**'],
|
||||
selector: "MemberExpression[property.name='electronAPI']",
|
||||
message: 'Use platform from @/lib/platform.',
|
||||
},
|
||||
keydown: {
|
||||
allowedIn: ['src/lib/keyboard.ts', 'src/ui/motion/**'],
|
||||
selector:
|
||||
"CallExpression[callee.property.name='addEventListener'][arguments.0.value=/^key(down|up)$/]",
|
||||
message:
|
||||
'Use useShortcut from @/lib/keyboard, Escape goes to the back stack (useBack).',
|
||||
},
|
||||
android: {
|
||||
allowedIn: ['src/app/platform/**', 'src/env.d.ts'],
|
||||
selector: "Identifier[name='__ANDROID__']",
|
||||
message: 'Use platform from @/lib/platform.',
|
||||
},
|
||||
};
|
||||
|
||||
function allow(from, to) {
|
||||
return {
|
||||
from: { element: { type: from } },
|
||||
allow: { to: { element: { type: to } } },
|
||||
};
|
||||
}
|
||||
|
||||
function restrictedSyntax(except = []) {
|
||||
return [
|
||||
'error',
|
||||
...Object.entries(restricted)
|
||||
.filter(([name]) => !except.includes(name))
|
||||
.map(([, { selector, message }]) => ({ selector, message })),
|
||||
];
|
||||
}
|
||||
|
||||
function restrictedOverrides() {
|
||||
const byPattern = new Map();
|
||||
for (const [name, { allowedIn }] of Object.entries(restricted)) {
|
||||
for (const pattern of allowedIn) {
|
||||
byPattern.set(pattern, [...(byPattern.get(pattern) ?? []), name]);
|
||||
}
|
||||
}
|
||||
return [...byPattern].map(([pattern, names]) => ({
|
||||
files: [pattern],
|
||||
rules: { 'no-restricted-syntax': restrictedSyntax(names) },
|
||||
}));
|
||||
}
|
||||
|
||||
export default tseslint.config(
|
||||
eslint.configs.recommended,
|
||||
...tseslint.configs.recommended,
|
||||
{
|
||||
files: ['src/**/*.{ts,tsx}'],
|
||||
...solid,
|
||||
languageOptions: {
|
||||
parser: tseslint.parser,
|
||||
parserOptions: { projectService: true, tsconfigRootDir: import.meta.dirname },
|
||||
globals: globals.browser,
|
||||
},
|
||||
plugins: {
|
||||
...solid.plugins,
|
||||
boundaries,
|
||||
l10n,
|
||||
},
|
||||
settings: {
|
||||
'import/resolver': {
|
||||
typescript: { alwaysTryTypes: true, project: './tsconfig.json' },
|
||||
},
|
||||
'boundaries/include': ['src/**/*'],
|
||||
'boundaries/elements': [
|
||||
{ type: 'app', pattern: 'src/app' },
|
||||
{ type: 'ui', pattern: 'src/ui' },
|
||||
{ type: 'lib', pattern: 'src/lib' },
|
||||
{ type: 'solarxr', pattern: 'src/solarxr' },
|
||||
{ type: 'domain', pattern: 'src/domain/*', capture: ['concept'] },
|
||||
{ type: 'pages', pattern: 'src/pages/*', capture: ['page'] },
|
||||
{ type: 'assets', pattern: 'src/assets' },
|
||||
],
|
||||
},
|
||||
rules: {
|
||||
...solid.rules,
|
||||
// External packages and imports inside one element (same page, same concept) are not checked
|
||||
'boundaries/dependencies': [
|
||||
'error',
|
||||
{
|
||||
default: 'disallow',
|
||||
policies: [
|
||||
allow('app', ['app', 'ui', 'lib', 'solarxr', 'domain', 'pages', 'assets']),
|
||||
allow('pages', ['ui', 'lib', 'solarxr', 'domain', 'assets']),
|
||||
allow('domain', ['ui', 'lib', 'solarxr', 'domain', 'assets']),
|
||||
allow('solarxr', ['lib', 'solarxr']),
|
||||
allow('ui', ['ui', 'lib', 'assets']),
|
||||
allow('assets', ['lib']),
|
||||
],
|
||||
},
|
||||
],
|
||||
'l10n/message-id': 'error',
|
||||
'no-throw-literal': 'error',
|
||||
'no-duplicate-imports': 'error',
|
||||
'no-restricted-syntax': restrictedSyntax(),
|
||||
'@typescript-eslint/no-unused-vars': [
|
||||
'warn',
|
||||
{ argsIgnorePattern: '^_', varsIgnorePattern: '^_', ignoreRestSiblings: true },
|
||||
],
|
||||
},
|
||||
},
|
||||
...restrictedOverrides(),
|
||||
{
|
||||
files: ['src/lib/**/*.{ts,tsx}'],
|
||||
plugins: { layers },
|
||||
rules: { 'layers/no-jsx': 'error' },
|
||||
},
|
||||
// Peer range stops at ESLint 9 but the rules only read JSX attributes
|
||||
{ files: ['src/**/*.tsx'], ...jsxA11y.flatConfigs.recommended },
|
||||
// Long class strings wrap into a multiline template literal, fixed by lint:fix
|
||||
{
|
||||
files: ['src/**/*.tsx'],
|
||||
plugins: { 'better-tailwindcss': betterTailwind },
|
||||
settings: { 'better-tailwindcss': { entryPoint: 'src/styles.css' } },
|
||||
rules: {
|
||||
'better-tailwindcss/enforce-consistent-line-wrapping': [
|
||||
'error',
|
||||
// Packed lines, no line per variant group. Wider than prettier so
|
||||
// only really long strings wrap at JSX indentation depth.
|
||||
{
|
||||
printWidth: 100,
|
||||
group: 'never',
|
||||
preferSingleLine: true,
|
||||
strictness: 'loose',
|
||||
},
|
||||
],
|
||||
// The type scale is the text tokens in styles.css, nothing else
|
||||
'better-tailwindcss/no-restricted-classes': [
|
||||
'error',
|
||||
{
|
||||
restrict: [
|
||||
{
|
||||
pattern: '^(?:.*:)?!?text-[\\[(].*$',
|
||||
message: 'No arbitrary text values, use text-standard, text-section or text-title.',
|
||||
},
|
||||
{
|
||||
pattern: '^(?:.*:)?!?text-(?:xs|sm|base|lg|xl|\\dxl)$',
|
||||
message: 'Tailwind sizes are removed, use text-standard, text-section or text-title.',
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
// Solid compiles `ref={x}` into an assignment the rule cannot see
|
||||
{ files: ['src/**/*.tsx'], rules: { 'no-unassigned-vars': 'off' } },
|
||||
// Motion hooks belong to ui primitives, pages only use the containers
|
||||
{
|
||||
files: ['src/**/*.{ts,tsx}'],
|
||||
ignores: ['src/ui/**'],
|
||||
rules: {
|
||||
'no-restricted-imports': [
|
||||
'error',
|
||||
{
|
||||
paths: [
|
||||
{
|
||||
name: '@/ui/motion',
|
||||
importNames: ['useMotionItem'],
|
||||
message: 'Only ui primitives register motion items.',
|
||||
},
|
||||
],
|
||||
patterns: [UI_DEEP_IMPORT],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
// Each ui folder is entered through its index; files inside it import each other relatively
|
||||
{
|
||||
files: ['src/ui/**/*.{ts,tsx}'],
|
||||
rules: { 'no-restricted-imports': ['error', { patterns: [UI_DEEP_IMPORT] }] },
|
||||
},
|
||||
// Local rules run in node
|
||||
{ files: ['eslint/**/*.js'], languageOptions: { globals: globals.node } },
|
||||
// Tests build their own bundles with made-up ids
|
||||
{ files: ['src/**/*.test.{ts,tsx}'], rules: { 'l10n/message-id': 'off' } }
|
||||
);
|
||||
@@ -1,202 +0,0 @@
|
||||
// Checks Fluent ids against the en-US translation.ftl: literal ids passed to `t`, `t.attr`,
|
||||
// the `id` prop of l10n components (with args), and any other string literal typed as MessageId
|
||||
// (props, options, `satisfies Record<..., MessageId>`). Ids must be full literals, args must match.
|
||||
import { parse } from '@fluent/syntax';
|
||||
import { readFileSync, statSync } from 'node:fs';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
|
||||
const FTL_FILE = fileURLToPath(new URL('../../app/public/i18n/en/translation.ftl', import.meta.url));
|
||||
const COMPONENTS = new Set(['Localized']);
|
||||
|
||||
let cache = { mtime: -1, messages: new Map() };
|
||||
|
||||
function collect(node, out) {
|
||||
if (!node || typeof node !== 'object') return;
|
||||
if (Array.isArray(node)) {
|
||||
for (const child of node) collect(child, out);
|
||||
return;
|
||||
}
|
||||
if (node.type === 'VariableReference') out.vars.add(node.id.name);
|
||||
else if (node.type === 'MessageReference') {
|
||||
out.refs.push({ id: node.id.name, attr: node.attribute?.name ?? null });
|
||||
}
|
||||
for (const [key, value] of Object.entries(node)) {
|
||||
if (key !== 'span' && typeof value === 'object') collect(value, out);
|
||||
}
|
||||
}
|
||||
|
||||
function patternInfo(pattern) {
|
||||
const out = { vars: new Set(), refs: [] };
|
||||
collect(pattern, out);
|
||||
return out;
|
||||
}
|
||||
|
||||
function loadMessages() {
|
||||
const mtime = statSync(FTL_FILE).mtimeMs;
|
||||
if (mtime === cache.mtime) return cache.messages;
|
||||
const messages = new Map();
|
||||
for (const entry of parse(readFileSync(FTL_FILE, 'utf8'), { withSpans: false }).body) {
|
||||
if (entry.type !== 'Message') continue;
|
||||
messages.set(entry.id.name, {
|
||||
value: entry.value ? patternInfo(entry.value) : null,
|
||||
attrs: new Map(entry.attributes.map((a) => [a.id.name, patternInfo(a.value)])),
|
||||
});
|
||||
}
|
||||
cache = { mtime, messages };
|
||||
return messages;
|
||||
}
|
||||
|
||||
function requiredVars(messages, id, attr, seen = new Set()) {
|
||||
const key = `${id}.${attr ?? ''}`;
|
||||
const message = messages.get(id);
|
||||
const info = attr === null ? message?.value : message?.attrs.get(attr);
|
||||
if (!info || seen.has(key)) return new Set();
|
||||
seen.add(key);
|
||||
const vars = new Set(info.vars);
|
||||
for (const ref of info.refs) {
|
||||
for (const v of requiredVars(messages, ref.id, ref.attr, seen)) vars.add(v);
|
||||
}
|
||||
return vars;
|
||||
}
|
||||
|
||||
// `handled` collects literals already checked through t()/Localized, so the type-based pass skips them
|
||||
function literalIds(node, context, handled) {
|
||||
if (node.type === 'Literal' || node.type === 'TemplateLiteral') handled.add(node);
|
||||
if (node.type === 'Literal' && typeof node.value === 'string') return [node.value];
|
||||
if (node.type === 'TemplateLiteral') {
|
||||
if (node.expressions.length === 0) return [node.quasis[0].value.cooked];
|
||||
context.report({ node, messageId: 'dynamic' });
|
||||
return null;
|
||||
}
|
||||
if (node.type === 'ConditionalExpression') {
|
||||
const a = literalIds(node.consequent, context, handled);
|
||||
const b = literalIds(node.alternate, context, handled);
|
||||
return a && b ? [...a, ...b] : null;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
function isMessageIdType(type) {
|
||||
if (!type) return false;
|
||||
if (type.aliasSymbol?.escapedName === 'MessageId') return true;
|
||||
return type.isUnion() && type.types.some(isMessageIdType);
|
||||
}
|
||||
|
||||
function propName(prop) {
|
||||
if (prop.computed) return null;
|
||||
if (prop.key.type === 'Identifier') return prop.key.name;
|
||||
if (prop.key.type === 'Literal') return String(prop.key.value);
|
||||
return null;
|
||||
}
|
||||
|
||||
const messageId = {
|
||||
meta: {
|
||||
type: 'problem',
|
||||
docs: { description: 'Fluent ids exist in en-US and get the args they need' },
|
||||
schema: [],
|
||||
messages: {
|
||||
dynamic: 'Fluent ids must be full literals so they stay greppable.',
|
||||
unknown: 'Unknown Fluent id "{{id}}" (not in en-US translation.ftl).',
|
||||
noValue: 'Fluent message "{{id}}" has no value, only attributes.',
|
||||
unknownAttr: 'Fluent message "{{id}}" has no attribute "{{attr}}".',
|
||||
missingArgs: 'Fluent message "{{id}}" needs args: {{vars}}.',
|
||||
unknownArg: 'Fluent message "{{id}}" does not use arg "{{arg}}".',
|
||||
},
|
||||
},
|
||||
create(context) {
|
||||
const messages = loadMessages();
|
||||
const handled = new WeakSet();
|
||||
const services = context.sourceCode.parserServices;
|
||||
const checker = services?.program?.getTypeChecker();
|
||||
|
||||
function typedAsMessageId(node) {
|
||||
const tsNode = services.esTreeNodeToTSNodeMap.get(node);
|
||||
return isMessageIdType(checker.getContextualType(tsNode));
|
||||
}
|
||||
|
||||
function checkTyped(node) {
|
||||
if (!checker || handled.has(node) || !typedAsMessageId(node)) return;
|
||||
check(node, { attr: undefined, withArgs: false });
|
||||
}
|
||||
|
||||
function checkArgs(node, id, attr, argsNode) {
|
||||
const vars = requiredVars(messages, id, attr);
|
||||
if (!argsNode) {
|
||||
if (vars.size) context.report({ node, messageId: 'missingArgs', data: { id, vars: [...vars].join(', ') } });
|
||||
return;
|
||||
}
|
||||
if (argsNode.type !== 'ObjectExpression') return;
|
||||
if (argsNode.properties.some((p) => p.type !== 'Property' || propName(p) === null)) return;
|
||||
const given = new Set(argsNode.properties.map(propName));
|
||||
const missing = [...vars].filter((v) => !given.has(v));
|
||||
if (missing.length) {
|
||||
context.report({ node: argsNode, messageId: 'missingArgs', data: { id, vars: missing.join(', ') } });
|
||||
}
|
||||
for (const prop of argsNode.properties) {
|
||||
const arg = propName(prop);
|
||||
if (!vars.has(arg)) context.report({ node: prop, messageId: 'unknownArg', data: { id, arg } });
|
||||
}
|
||||
}
|
||||
|
||||
function check(idNode, { attr, argsNode, withArgs }) {
|
||||
const ids = literalIds(idNode, context, handled);
|
||||
if (!ids) return;
|
||||
for (const id of ids) {
|
||||
const message = messages.get(id);
|
||||
if (!message) {
|
||||
context.report({ node: idNode, messageId: 'unknown', data: { id } });
|
||||
continue;
|
||||
}
|
||||
if (attr === undefined && !message.value) {
|
||||
context.report({ node: idNode, messageId: 'noValue', data: { id } });
|
||||
continue;
|
||||
}
|
||||
if (typeof attr === 'string' && !message.attrs.has(attr)) {
|
||||
context.report({ node: idNode, messageId: 'unknownAttr', data: { id, attr } });
|
||||
continue;
|
||||
}
|
||||
if (withArgs && attr !== null) checkArgs(idNode, id, attr ?? null, argsNode);
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
CallExpression(node) {
|
||||
const { callee } = node;
|
||||
const [first, second, third] = node.arguments;
|
||||
if (!first) return;
|
||||
if (callee.type === 'Identifier' && callee.name === 't') {
|
||||
check(first, { attr: undefined, argsNode: second, withArgs: true });
|
||||
} else if (
|
||||
callee.type === 'MemberExpression' &&
|
||||
callee.object.type === 'Identifier' &&
|
||||
callee.object.name === 't' &&
|
||||
callee.property.type === 'Identifier' &&
|
||||
callee.property.name === 'attr' &&
|
||||
second
|
||||
) {
|
||||
const attr = second.type === 'Literal' && typeof second.value === 'string' ? second.value : null;
|
||||
check(first, { attr, argsNode: third, withArgs: true });
|
||||
}
|
||||
},
|
||||
JSXOpeningElement(node) {
|
||||
if (node.name.type !== 'JSXIdentifier' || !COMPONENTS.has(node.name.name)) return;
|
||||
const attrs = node.attributes.filter((a) => a.type === 'JSXAttribute');
|
||||
const idAttr = attrs.find((a) => a.name.name === 'id');
|
||||
if (!idAttr?.value) return;
|
||||
const idNode = idAttr.value.type === 'JSXExpressionContainer' ? idAttr.value.expression : idAttr.value;
|
||||
const argsAttr = attrs.find((a) => a.name.name === 'args');
|
||||
// Spread props may carry args, skip the args check then
|
||||
const withArgs = !node.attributes.some((a) => a.type === 'JSXSpreadAttribute');
|
||||
const argsNode = argsAttr?.value?.type === 'JSXExpressionContainer' ? argsAttr.value.expression : undefined;
|
||||
check(idNode, { attr: undefined, argsNode, withArgs });
|
||||
},
|
||||
// Props, options and `satisfies Record<..., MessageId>` values: anything typed MessageId
|
||||
Literal(node) {
|
||||
if (typeof node.value === 'string') checkTyped(node);
|
||||
},
|
||||
TemplateLiteral: checkTyped,
|
||||
};
|
||||
},
|
||||
};
|
||||
|
||||
export default { rules: { 'message-id': messageId } };
|
||||
@@ -1,14 +0,0 @@
|
||||
// lib holds services and reactive state, anything that renders lives in ui
|
||||
const noJsx = {
|
||||
meta: {
|
||||
type: 'problem',
|
||||
messages: { jsx: 'No JSX in lib, components belong in ui.' },
|
||||
schema: [],
|
||||
},
|
||||
create(context) {
|
||||
const report = (node) => context.report({ node, messageId: 'jsx' });
|
||||
return { JSXElement: report, JSXFragment: report };
|
||||
},
|
||||
};
|
||||
|
||||
export default { rules: { 'no-jsx': noJsx } };
|
||||
@@ -1,17 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<link rel="icon" href="/favicon.ico" />
|
||||
<meta name="viewport" content="width=device-width, minimum-scale=1.0" />
|
||||
<meta name="theme-color" content="#000000" />
|
||||
<link rel="apple-touch-icon" href="/logo192.png" />
|
||||
<link rel="manifest" href="/manifest.json" />
|
||||
<title>SlimeVR GUI</title>
|
||||
</head>
|
||||
<body>
|
||||
<noscript>You need to enable JavaScript to run this app.</noscript>
|
||||
<div id="root"></div>
|
||||
<script type="module" src="/src/index.tsx"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,69 +0,0 @@
|
||||
{
|
||||
"name": "@slimevr/gui-app-next",
|
||||
"version": "0.0.0",
|
||||
"author": "SlimeVR Team <[email protected]>",
|
||||
"homepage": "https://slimevr.dev",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
"build": "vite build",
|
||||
"preview": "vite preview",
|
||||
"typecheck": "tsc --noEmit -p tsconfig.json && tsc --noEmit -p tsconfig.node.json",
|
||||
"test": "vitest run",
|
||||
"lint": "pnpm typecheck && eslint src && prettier --check \"src/**/*.{ts,tsx,css,json}\"",
|
||||
"lint:fix": "eslint --fix src && prettier --write \"src/**/*.{ts,tsx,css,json}\""
|
||||
},
|
||||
"dependencies": {
|
||||
"@fluent/bundle": "0.19.1",
|
||||
"@fluent/langneg": "0.7.0",
|
||||
"@fontsource-variable/lexend": "5.3.0",
|
||||
"@fontsource/jetbrains-mono": "5.3.0",
|
||||
"@fontsource/noto-sans": "5.3.0",
|
||||
"@fontsource/opendyslexic": "5.3.0",
|
||||
"@fontsource/poppins": "5.2.7",
|
||||
"@fontsource/ubuntu": "5.3.0",
|
||||
"@sentry/solid": "11.9.0",
|
||||
"@slimevr/gui-shared": "workspace:*",
|
||||
"@solidjs/router": "1.0.0",
|
||||
"browser-fs-access": "0.38.0",
|
||||
"flatbuffers": "22.10.26",
|
||||
"semver": "7.7.4",
|
||||
"solarxr-protocol": "workspace:*",
|
||||
"solid-js": "1.9.17",
|
||||
"valibot": "1.5.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@eslint/js": "10.0.1",
|
||||
"@sentry/vite-plugin": "11.9.0",
|
||||
"@fluent/syntax": "0.19.0",
|
||||
"@iconify-json/heroicons": "1.2.3",
|
||||
"@iconify-json/ic": "1.2.4",
|
||||
"@iconify-json/lucide": "1.2.147",
|
||||
"@iconify-json/material-symbols": "1.2.96",
|
||||
"@solidjs/testing-library": "0.8.10",
|
||||
"@tailwindcss/vite": "4.3.3",
|
||||
"@testing-library/jest-dom": "7.0.1",
|
||||
"@testing-library/user-event": "14.6.8",
|
||||
"@types/node": "26.6.5",
|
||||
"@types/semver": "7.7.1",
|
||||
"axe-core": "4.14.0",
|
||||
"eslint": "10.13.0",
|
||||
"eslint-import-resolver-typescript": "^4.4.4",
|
||||
"eslint-plugin-better-tailwindcss": "4.10.0",
|
||||
"eslint-plugin-boundaries": "7.3.0",
|
||||
"eslint-plugin-jsx-a11y": "6.10.2",
|
||||
"eslint-plugin-solid": "0.18.1",
|
||||
"globals": "17.13.0",
|
||||
"jsdom": "30.1.3",
|
||||
"prettier": "3.9.10",
|
||||
"tailwindcss": "4.3.3",
|
||||
"typescript": "~6.0.3",
|
||||
"typescript-eslint": "8.72.0",
|
||||
"unplugin-icons": "24.0.0",
|
||||
"vite": "8.3.5",
|
||||
"vite-imagetools": "12.0.1",
|
||||
"vite-plugin-solid": "2.11.14",
|
||||
"vitest": "5.0.5"
|
||||
}
|
||||
}
|
||||
@@ -1,86 +0,0 @@
|
||||
import { useMatch } from '@solidjs/router';
|
||||
import { type JSX, Show } from 'solid-js';
|
||||
import HomeIcon from '~icons/material-symbols/home';
|
||||
import DesignIcon from '~icons/material-symbols/palette-outline-rounded';
|
||||
import GearIcon from '~icons/material-symbols/settings-rounded';
|
||||
import RulerIcon from '~icons/material-symbols/straighten-rounded';
|
||||
import { ConnectionGate } from '@/app/connection-gate';
|
||||
import { paths } from '@/app/routes';
|
||||
import { TitleBar } from '@/app/title-bar';
|
||||
import { handleBack } from '@/lib/back-stack';
|
||||
import { createMediaQuery, SHELL_QUERY } from '@/lib/media';
|
||||
import { MotionRegion } from '@/ui/motion';
|
||||
import { NavLink } from '@/ui/nav-link';
|
||||
|
||||
const MOUSE_BACK = 3;
|
||||
|
||||
// Same destinations at every width: bottom bar on phones, rail from `shell` up
|
||||
function Destinations() {
|
||||
const rail = createMediaQuery(SHELL_QUERY);
|
||||
|
||||
return (
|
||||
<MotionRegion
|
||||
orientation={rail() ? 'vertical' : 'horizontal'}
|
||||
class="
|
||||
order-last flex justify-around gap-sm px-sm pt-sm shell:order-first shell:flex-col
|
||||
shell:w-27.5 shell:shrink-0 shell:justify-start shell:pt-0 shell:pb-sm
|
||||
"
|
||||
>
|
||||
<NavLink to={paths.home} end label="navbar-home" icon={<HomeIcon />} />
|
||||
<NavLink
|
||||
to={paths.body}
|
||||
label="navbar-body_proportions"
|
||||
icon={<RulerIcon class="icon -rotate-45" />}
|
||||
/>
|
||||
<Show when={import.meta.env.DEV}>
|
||||
<NavLink
|
||||
to={paths.design}
|
||||
label="navbar-design"
|
||||
icon={<DesignIcon />}
|
||||
/>
|
||||
</Show>
|
||||
<div class="contents shell:mt-auto shell:flex shell:flex-col">
|
||||
<NavLink
|
||||
to={paths.settings}
|
||||
label="navbar-settings"
|
||||
icon={<GearIcon />}
|
||||
/>
|
||||
</div>
|
||||
</MotionRegion>
|
||||
);
|
||||
}
|
||||
|
||||
export function AppShell(props: { children: JSX.Element }) {
|
||||
// Setup runs without destinations, the flow footer owns the bottom
|
||||
const onboarding = useMatch(() => `${paths.onboarding}/*`);
|
||||
|
||||
function onPointerUp(e: PointerEvent) {
|
||||
if (e.button !== MOUSE_BACK) return;
|
||||
if (handleBack()) e.preventDefault();
|
||||
}
|
||||
|
||||
return (
|
||||
<div
|
||||
class="flex h-dvh flex-col bg-surface text-fg surface-sidebar"
|
||||
onPointerUp={onPointerUp}
|
||||
>
|
||||
<TitleBar />
|
||||
<ConnectionGate>
|
||||
<div class="flex min-h-0 flex-1 flex-col shell:flex-row">
|
||||
<Show when={!onboarding()}>
|
||||
<Destinations />
|
||||
</Show>
|
||||
<main
|
||||
classList={{ 'shell:ml-sm': !!onboarding() }}
|
||||
class="
|
||||
relative min-h-0 flex-1 overflow-y-auto overscroll-contain @container shell:mb-sm
|
||||
shell:scrollbar-gutter-stable
|
||||
"
|
||||
>
|
||||
{props.children}
|
||||
</main>
|
||||
</div>
|
||||
</ConnectionGate>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -1,41 +0,0 @@
|
||||
import { HashRouter, type RouteSectionProps } from '@solidjs/router';
|
||||
import { withSentryRouterRouting } from '@sentry/solid/solidrouter';
|
||||
import { AppShell } from '@/app/app-shell';
|
||||
import { CrashBoundary } from '@/app/crash-screen';
|
||||
import { useHistoryBack } from '@/app/history-back';
|
||||
import { paths, routes } from '@/app/routes';
|
||||
import { searchDestinations } from '@/app/search-destinations';
|
||||
import { useShortcut } from '@/lib/keyboard';
|
||||
import { DOCS_SITE } from '@/lib/links';
|
||||
import { platform } from '@/lib/platform';
|
||||
import { QuickSearch } from '@/pages/settings/quick-search/quick-search';
|
||||
import { DialogHost } from '@/ui/dialog';
|
||||
import { MotionRoot } from '@/ui/motion';
|
||||
import { ToastHost } from '@/ui/toast';
|
||||
|
||||
const Router = withSentryRouterRouting(HashRouter);
|
||||
|
||||
function AppRoot(props: RouteSectionProps) {
|
||||
useHistoryBack();
|
||||
useShortcut('F1', () => platform.openUrl(DOCS_SITE), {
|
||||
scope: 'global',
|
||||
label: 'titlebar-docs',
|
||||
});
|
||||
|
||||
return (
|
||||
<MotionRoot>
|
||||
<AppShell>{props.children}</AppShell>
|
||||
<QuickSearch base={paths.settings} destinations={searchDestinations} />
|
||||
<DialogHost />
|
||||
<ToastHost />
|
||||
</MotionRoot>
|
||||
);
|
||||
}
|
||||
|
||||
export function App() {
|
||||
return (
|
||||
<CrashBoundary>
|
||||
<Router root={AppRoot}>{routes}</Router>
|
||||
</CrashBoundary>
|
||||
);
|
||||
}
|
||||
@@ -1,30 +0,0 @@
|
||||
import { createPlatform } from '@/app/platform/detect';
|
||||
import { startReleaseCheck } from '@/domain/app-update/release-check';
|
||||
import { startDatafeed } from '@/domain/datafeed';
|
||||
import { initErrorReporting } from '@/domain/error-reporting';
|
||||
import { initSaveToasts } from '@/domain/settings/save-toasts';
|
||||
import { initKeyboard } from '@/lib/keyboard';
|
||||
import { initL10n } from '@/lib/l10n';
|
||||
import { setPlatform } from '@/lib/platform';
|
||||
import { loadPrefs } from '@/lib/storage';
|
||||
import { createSocketClient, serverUrl, setClient } from '@/solarxr/client';
|
||||
|
||||
// Everything that runs before render, in order. Returns the stop for the
|
||||
// background services.
|
||||
export async function boot(): Promise<() => void> {
|
||||
setPlatform(await createPlatform());
|
||||
setClient(createSocketClient({ url: serverUrl() }));
|
||||
await initErrorReporting();
|
||||
await loadPrefs();
|
||||
await initL10n();
|
||||
|
||||
const services = [
|
||||
initKeyboard(),
|
||||
initSaveToasts(),
|
||||
startReleaseCheck(),
|
||||
startDatafeed(),
|
||||
];
|
||||
return () => {
|
||||
for (const stop of services) stop();
|
||||
};
|
||||
}
|
||||
@@ -1,72 +0,0 @@
|
||||
import { cleanup, render, screen } from '@solidjs/testing-library';
|
||||
import {
|
||||
ErrorReportingConsent,
|
||||
ErrorReportingSettingsResponseT,
|
||||
} from 'solarxr-protocol';
|
||||
import { afterEach, beforeAll, describe, expect, it } from 'vitest';
|
||||
import { ConnectionGate } from '@/app/connection-gate';
|
||||
import { setPlatform } from '@/lib/platform';
|
||||
import { fakePlatform } from '@/lib/platform-fake';
|
||||
import { setClient } from '@/solarxr/client';
|
||||
import { createFakeClient, type FakeClient } from '@/solarxr/testing';
|
||||
|
||||
let fake: FakeClient;
|
||||
|
||||
beforeAll(() => {
|
||||
setPlatform(fakePlatform());
|
||||
fake = createFakeClient({ connected: false });
|
||||
setClient(fake);
|
||||
});
|
||||
|
||||
function consent(value: ErrorReportingConsent) {
|
||||
fake.push(new ErrorReportingSettingsResponseT(value, 'user-1', 'session-1'));
|
||||
}
|
||||
|
||||
function renderGate() {
|
||||
render(() => (
|
||||
<ConnectionGate>
|
||||
<p>app</p>
|
||||
</ConnectionGate>
|
||||
));
|
||||
}
|
||||
|
||||
// Resources are module state, so the cases run as one story in order
|
||||
describe('ConnectionGate', () => {
|
||||
afterEach(cleanup);
|
||||
|
||||
it('shows the timeout error when the first connect takes too long', () => {
|
||||
renderGate();
|
||||
expect(screen.getByText('websocket-connecting')).toBeInTheDocument();
|
||||
fake.setTimedOut(true);
|
||||
expect(screen.getByText('websocket-timedout')).toBeInTheDocument();
|
||||
expect(screen.queryByText('app')).toBeNull();
|
||||
fake.setTimedOut(false);
|
||||
});
|
||||
|
||||
it('waits for consent, asks it, then shows the app and covers it on loss', () => {
|
||||
renderGate();
|
||||
fake.connect();
|
||||
expect(screen.getByText('websocket-connecting')).toBeInTheDocument();
|
||||
expect(screen.queryByText('app')).toBeNull();
|
||||
|
||||
consent(ErrorReportingConsent.UNDECIDED);
|
||||
expect(
|
||||
screen.getByText('error_collection_modal-title')
|
||||
).toBeInTheDocument();
|
||||
expect(screen.queryByText('app')).toBeNull();
|
||||
|
||||
consent(ErrorReportingConsent.ALLOWED);
|
||||
expect(screen.queryByText('error_collection_modal-title')).toBeNull();
|
||||
expect(screen.getByText('app').parentElement).not.toHaveClass('hidden');
|
||||
|
||||
fake.disconnect();
|
||||
expect(screen.getByText('websocket-connection_lost')).toBeInTheDocument();
|
||||
// Kept mounted under the screen
|
||||
expect(screen.getByText('app').parentElement).toHaveClass('hidden');
|
||||
|
||||
fake.connect();
|
||||
consent(ErrorReportingConsent.ALLOWED);
|
||||
expect(screen.queryByText('websocket-connection_lost')).toBeNull();
|
||||
expect(screen.getByText('app').parentElement).not.toHaveClass('hidden');
|
||||
});
|
||||
});
|
||||
@@ -1,188 +0,0 @@
|
||||
import {
|
||||
createEffect,
|
||||
createSignal,
|
||||
type JSX,
|
||||
Match,
|
||||
onMount,
|
||||
Show,
|
||||
Switch,
|
||||
} from 'solid-js';
|
||||
import { ErrorReportingConsent } from 'solarxr-protocol';
|
||||
import {
|
||||
answerConsent,
|
||||
crashReportAvailable,
|
||||
errorReportingSettings,
|
||||
needsConsentAnswer,
|
||||
sendCrashReport,
|
||||
} from '@/domain/error-reporting';
|
||||
import { ErrorReportingDetails } from '@/domain/error-reporting/error-reporting-details';
|
||||
import { cx } from '@/lib/cx';
|
||||
import { t } from '@/lib/l10n';
|
||||
import { platform, type CrashKind } from '@/lib/platform';
|
||||
import { flushPrefs } from '@/lib/storage';
|
||||
import { client } from '@/solarxr/client';
|
||||
import { TextButton } from '@/ui/button';
|
||||
import { focusEntry, MotionRegion } from '@/ui/motion';
|
||||
import { StatusState } from '@/ui/status-state';
|
||||
|
||||
type GateScreen = 'connection' | 'consent';
|
||||
|
||||
function CrashReportBanner(props: { kind: CrashKind }) {
|
||||
const [sent, setSent] = createSignal(false);
|
||||
const [sending, setSending] = createSignal(false);
|
||||
|
||||
async function send() {
|
||||
setSending(true);
|
||||
try {
|
||||
if (await sendCrashReport(props.kind)) setSent(true);
|
||||
} finally {
|
||||
setSending(false);
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<Show when={crashReportAvailable()}>
|
||||
<div
|
||||
class="
|
||||
flex w-full max-w-2xl flex-wrap items-center justify-between gap-md rounded-lg bg-surface
|
||||
px-lg py-md surface-section
|
||||
"
|
||||
>
|
||||
<p>
|
||||
{t(sent() ? 'websocket-report-sent' : 'websocket-report-question')}
|
||||
</p>
|
||||
<Show when={!sent()}>
|
||||
<TextButton
|
||||
label="websocket-report-send"
|
||||
loading={sending()}
|
||||
onClick={send}
|
||||
/>
|
||||
</Show>
|
||||
</div>
|
||||
</Show>
|
||||
);
|
||||
}
|
||||
|
||||
function ConnectionScreen() {
|
||||
const timedOut = () => client.status() === 'connecting' && client.timedOut();
|
||||
const lost = () => client.status() === 'disconnected';
|
||||
|
||||
async function close() {
|
||||
await flushPrefs();
|
||||
platform.window?.close();
|
||||
}
|
||||
|
||||
return (
|
||||
<Show
|
||||
when={timedOut() || lost()}
|
||||
fallback={
|
||||
<StatusState kind="loading" size="page" title="websocket-connecting" />
|
||||
}
|
||||
>
|
||||
<div class="flex flex-1 flex-col items-center gap-lg p-lg">
|
||||
<StatusState
|
||||
kind="error"
|
||||
size="page"
|
||||
title={
|
||||
timedOut() ? 'websocket-timedout' : 'websocket-connection_lost'
|
||||
}
|
||||
description={
|
||||
timedOut()
|
||||
? 'websocket-timedout-desc'
|
||||
: 'websocket-connection_lost-desc'
|
||||
}
|
||||
action={
|
||||
<Show when={platform.window}>
|
||||
<div class="flex flex-wrap justify-center gap-sm">
|
||||
<TextButton
|
||||
variant="primary"
|
||||
label="websocket-error-close"
|
||||
onClick={close}
|
||||
/>
|
||||
<Show when={platform.folders}>
|
||||
{(folders) => (
|
||||
<TextButton
|
||||
label="websocket-error-logs"
|
||||
onClick={() => void folders().openLogs()}
|
||||
/>
|
||||
)}
|
||||
</Show>
|
||||
</div>
|
||||
</Show>
|
||||
}
|
||||
/>
|
||||
<CrashReportBanner kind={timedOut() ? 'timeout' : 'connection_lost'} />
|
||||
</div>
|
||||
</Show>
|
||||
);
|
||||
}
|
||||
|
||||
function ConsentScreen() {
|
||||
let el!: HTMLDivElement;
|
||||
onMount(() => focusEntry(el));
|
||||
|
||||
return (
|
||||
<div
|
||||
ref={el}
|
||||
class="flex min-h-0 flex-1 justify-center overflow-y-auto p-lg"
|
||||
>
|
||||
<MotionRegion class="flex w-full max-w-2xl flex-col items-center gap-lg">
|
||||
<StatusState
|
||||
kind="empty"
|
||||
title="error_collection_modal-title"
|
||||
description="error_collection_modal-subtitle"
|
||||
/>
|
||||
<ErrorReportingDetails />
|
||||
<p class="text-center">{t('error_collection_modal-change_later')}</p>
|
||||
<div class="flex w-full flex-wrap-reverse justify-between gap-md">
|
||||
<TextButton
|
||||
variant="ghost"
|
||||
label="error_collection_modal-cancel"
|
||||
onClick={() => answerConsent(ErrorReportingConsent.DENIED)}
|
||||
/>
|
||||
<TextButton
|
||||
variant="primary"
|
||||
label="error_collection_modal-confirm"
|
||||
onClick={() => answerConsent(ErrorReportingConsent.ALLOWED)}
|
||||
/>
|
||||
</div>
|
||||
</MotionRegion>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
export function ConnectionGate(props: { children: JSX.Element }) {
|
||||
const [shown, setShown] = createSignal(false);
|
||||
|
||||
function screen(): GateScreen | null {
|
||||
if (client.status() !== 'connected') return 'connection';
|
||||
if (!shown() && errorReportingSettings.state() !== 'fresh')
|
||||
return 'connection';
|
||||
if (needsConsentAnswer()) return 'consent';
|
||||
return null;
|
||||
}
|
||||
|
||||
createEffect(() => {
|
||||
if (!screen()) setShown(true);
|
||||
});
|
||||
|
||||
return (
|
||||
<>
|
||||
<Switch>
|
||||
<Match when={screen() === 'connection'}>
|
||||
<ConnectionScreen />
|
||||
</Match>
|
||||
<Match when={screen() === 'consent'}>
|
||||
<ConsentScreen />
|
||||
</Match>
|
||||
</Switch>
|
||||
<Show when={shown()}>
|
||||
<div
|
||||
class={cx('min-h-0 flex-1 flex-col', screen() ? 'hidden' : 'flex')}
|
||||
>
|
||||
{props.children}
|
||||
</div>
|
||||
</Show>
|
||||
</>
|
||||
);
|
||||
}
|
||||
@@ -1,57 +0,0 @@
|
||||
import { ErrorBoundary, type JSX, Show } from 'solid-js';
|
||||
import { MinimalTitleBar } from '@/app/title-bar';
|
||||
import { lastReportId, reportError } from '@/domain/error-reporting';
|
||||
import { t } from '@/lib/l10n';
|
||||
import { TextButton } from '@/ui/button';
|
||||
import { CopyButton } from '@/ui/copy-button';
|
||||
import { StatusState } from '@/ui/status-state';
|
||||
|
||||
function CrashScreen(props: { eventId: string | undefined }) {
|
||||
return (
|
||||
<div class="flex h-screen flex-col bg-surface text-fg surface-sidebar">
|
||||
<MinimalTitleBar />
|
||||
<div class="flex min-h-0 flex-1 flex-col overflow-y-auto">
|
||||
<StatusState
|
||||
kind="error"
|
||||
size="page"
|
||||
title="crash_screen-title"
|
||||
description="crash_screen-description"
|
||||
action={
|
||||
<div class="flex flex-col items-center gap-md">
|
||||
<Show when={props.eventId}>
|
||||
{(id) => (
|
||||
<p class="font-mono select-text">
|
||||
{t('crash_screen-event_id', { id: id() })}
|
||||
</p>
|
||||
)}
|
||||
</Show>
|
||||
<div class="flex flex-wrap justify-center gap-sm">
|
||||
<Show when={props.eventId}>
|
||||
{(id) => <CopyButton text={id()} label="crash_screen-copy" />}
|
||||
</Show>
|
||||
<TextButton
|
||||
variant="primary"
|
||||
label="crash_screen-reload"
|
||||
onClick={() => window.location.reload()}
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
}
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
export function CrashBoundary(props: { children: JSX.Element }) {
|
||||
return (
|
||||
<ErrorBoundary
|
||||
fallback={(error) => {
|
||||
reportError(error, { tags: { boundary: 'app' } });
|
||||
return <CrashScreen eventId={lastReportId()} />;
|
||||
}}
|
||||
>
|
||||
{props.children}
|
||||
</ErrorBoundary>
|
||||
);
|
||||
}
|
||||
@@ -1,27 +0,0 @@
|
||||
import { useLocation, useNavigate } from '@solidjs/router';
|
||||
import { onCleanup } from 'solid-js';
|
||||
import { setBackFallback } from '@/lib/back-stack';
|
||||
|
||||
function depth(): number {
|
||||
const state: unknown = window.history.state;
|
||||
if (typeof state !== 'object' || state === null || !('_depth' in state)) return 0;
|
||||
return typeof state._depth === 'number' ? state._depth : 0;
|
||||
}
|
||||
|
||||
// Router history under the overlays. Stops at the entry the app started on,
|
||||
// so back never leaves the app.
|
||||
export function useHistoryBack() {
|
||||
const navigate = useNavigate();
|
||||
const location = useLocation();
|
||||
const start = depth();
|
||||
|
||||
onCleanup(
|
||||
setBackFallback({
|
||||
can: () => {
|
||||
void location.key;
|
||||
return depth() > start;
|
||||
},
|
||||
back: () => navigate(-1),
|
||||
})
|
||||
);
|
||||
}
|
||||
@@ -1,40 +0,0 @@
|
||||
import type { Platform } from '@/lib/platform';
|
||||
import { localCrossStorage } from '@/lib/storage';
|
||||
import { saveWithBrowser } from './browser-save';
|
||||
|
||||
type AndroidBridge = NonNullable<Window['__ANDROID__']>;
|
||||
|
||||
function toBase64(blob: Blob) {
|
||||
return new Promise<string>((resolve, reject) => {
|
||||
const reader = new FileReader();
|
||||
reader.onload = () => {
|
||||
const url = reader.result as string;
|
||||
resolve(url.slice(url.indexOf(',') + 1));
|
||||
};
|
||||
reader.onerror = () => reject(reader.error);
|
||||
reader.readAsDataURL(blob);
|
||||
});
|
||||
}
|
||||
|
||||
export function createAndroidPlatform(android: AndroidBridge): Platform {
|
||||
const settings = localCrossStorage('');
|
||||
const cache = localCrossStorage('slimevr-cache/');
|
||||
|
||||
return {
|
||||
kind: 'android',
|
||||
os: 'android',
|
||||
storage: (name) => (name === 'settings' ? settings : cache),
|
||||
openUrl: (url) => void window.open(url, '_blank'),
|
||||
saveFile: async (opts) => {
|
||||
if (typeof android.saveFile !== 'function') return saveWithBrowser(opts);
|
||||
const { blob, fileName } = opts;
|
||||
android.saveFile(
|
||||
fileName,
|
||||
blob.type || 'application/octet-stream',
|
||||
await toBase64(blob)
|
||||
);
|
||||
return 'saved';
|
||||
},
|
||||
systemInsets: { setBackground: (color) => android.updateInsetBackground(color) },
|
||||
};
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
import { fileSave } from 'browser-fs-access';
|
||||
import type { SaveOptions, SaveResult } from '@/lib/platform';
|
||||
|
||||
export async function saveWithBrowser({
|
||||
blob,
|
||||
fileName,
|
||||
extensions,
|
||||
}: SaveOptions): Promise<SaveResult> {
|
||||
try {
|
||||
await fileSave(blob, { fileName, extensions });
|
||||
return 'saved';
|
||||
} catch (e) {
|
||||
if (e instanceof DOMException && e.name === 'AbortError') return 'canceled';
|
||||
throw e;
|
||||
}
|
||||
}
|
||||
@@ -1,39 +0,0 @@
|
||||
import type { IElectronAPI } from '@slimevr/gui-shared';
|
||||
import { describe, expect, it, vi } from 'vitest';
|
||||
import { memoryCrossStorage } from '@/lib/platform-fake';
|
||||
import { createPlatform } from './detect';
|
||||
|
||||
describe('createPlatform', () => {
|
||||
it('resolves the OS before returning on electron', async () => {
|
||||
const storage = memoryCrossStorage();
|
||||
vi.stubGlobal('electronAPI', {
|
||||
osStats: async () => ({ type: 'linux' }),
|
||||
getStorage: async () => storage,
|
||||
} as Partial<IElectronAPI>);
|
||||
|
||||
const platform = await createPlatform();
|
||||
expect(platform.kind).toBe('desktop');
|
||||
expect(platform.os).toBe('linux');
|
||||
expect(platform.storage('settings')).toBe(storage);
|
||||
expect(platform.window).toBeDefined();
|
||||
});
|
||||
|
||||
it('picks android when the bridge is there', async () => {
|
||||
vi.stubGlobal('__ANDROID__', {
|
||||
isThere: () => true,
|
||||
updateInsetBackground: () => {},
|
||||
saveFile: () => {},
|
||||
});
|
||||
|
||||
const platform = await createPlatform();
|
||||
expect(platform.kind).toBe('android');
|
||||
expect(platform.systemInsets).toBeDefined();
|
||||
expect(platform.window).toBeUndefined();
|
||||
});
|
||||
|
||||
it('falls back to web', async () => {
|
||||
const platform = await createPlatform();
|
||||
expect(platform.kind).toBe('web');
|
||||
expect(platform.pickFile).toBeUndefined();
|
||||
});
|
||||
});
|
||||
@@ -1,11 +0,0 @@
|
||||
import type { Platform } from '@/lib/platform';
|
||||
import { createAndroidPlatform } from './android';
|
||||
import { createElectronPlatform } from './electron';
|
||||
import { createWebPlatform } from './web';
|
||||
|
||||
export async function createPlatform(): Promise<Platform> {
|
||||
if (window.electronAPI) return createElectronPlatform(window.electronAPI);
|
||||
const android = window.__ANDROID__;
|
||||
if (android?.isThere()) return createAndroidPlatform(android);
|
||||
return createWebPlatform();
|
||||
}
|
||||
@@ -1,63 +0,0 @@
|
||||
import type { IElectronAPI } from '@slimevr/gui-shared';
|
||||
import type { Platform } from '@/lib/platform';
|
||||
import { saveWithBrowser } from './browser-save';
|
||||
|
||||
export async function createElectronPlatform(api: IElectronAPI): Promise<Platform> {
|
||||
const [os, settings, cache] = await Promise.all([
|
||||
api.osStats(),
|
||||
api.getStorage('settings'),
|
||||
api.getStorage('cache'),
|
||||
]);
|
||||
|
||||
return {
|
||||
kind: 'desktop',
|
||||
os: os.type,
|
||||
storage: (name) => (name === 'settings' ? settings : cache),
|
||||
openUrl: (url) => void api.openUrl(url),
|
||||
saveFile: saveWithBrowser,
|
||||
pickFile: async ({ mode, title, filters, defaultPath }) => {
|
||||
if (mode === 'save') {
|
||||
const res = await api.saveDialog({ title, filters, defaultPath });
|
||||
return res.canceled || !res.filePath ? null : res.filePath;
|
||||
}
|
||||
const res = await api.openDialog({
|
||||
title,
|
||||
filters,
|
||||
defaultPath,
|
||||
properties: [mode === 'directory' ? 'openDirectory' : 'openFile'],
|
||||
});
|
||||
return res.canceled ? null : (res.filePaths[0] ?? null);
|
||||
},
|
||||
window: {
|
||||
minimize: () => api.minimize(),
|
||||
toggleMaximize: () => api.toggleMaximize(),
|
||||
hide: () => api.hide(),
|
||||
close: () => api.close(),
|
||||
showDecorations: (on) => api.showDecorations(on),
|
||||
},
|
||||
folders: {
|
||||
openLogs: () => api.openLogsFolder(),
|
||||
openConfig: () => api.openConfigFolder(),
|
||||
installDir: () => api.getInstallDir(),
|
||||
},
|
||||
guiLogs: {
|
||||
onEvents: (cb) => api.onGuiLogEvents(cb),
|
||||
files: () => api.guiLogFiles(),
|
||||
read: (name) => api.readGuiLogFile(name),
|
||||
},
|
||||
log: (level, ...args) => api.log(level, ...args),
|
||||
errorReporting: {
|
||||
setState: (state) => api.setErrorReporting(state),
|
||||
sendCrash: (kind) => api.sendCrashReport(kind),
|
||||
},
|
||||
discordPresence: { set: (presence) => api.setPresence(presence) },
|
||||
translations: {
|
||||
set: (translations) => api.setTranslations(translations),
|
||||
override: () => api.i18nOverride(),
|
||||
onCrowdinPopupClosed: (cb) => api.onCrowdinPopupClosed(cb),
|
||||
},
|
||||
github: { get: (request) => api.ghGet(request) },
|
||||
steam: { isSteam: () => api.isSteam() },
|
||||
keybindRecording: (on) => api.setKeybindRecording(on),
|
||||
};
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
import type { Platform } from '@/lib/platform';
|
||||
import { localCrossStorage } from '@/lib/storage';
|
||||
import { saveWithBrowser } from './browser-save';
|
||||
|
||||
export function createWebPlatform(): Platform {
|
||||
const settings = localCrossStorage('');
|
||||
const cache = localCrossStorage('slimevr-cache/');
|
||||
|
||||
return {
|
||||
kind: 'web',
|
||||
os: 'unknown',
|
||||
storage: (name) => (name === 'settings' ? settings : cache),
|
||||
openUrl: (url) => void window.open(url, '_blank'),
|
||||
saveFile: saveWithBrowser,
|
||||
};
|
||||
}
|
||||
@@ -1,25 +0,0 @@
|
||||
import type { RouteDefinition } from '@solidjs/router';
|
||||
import { BodyPage } from '@/pages/body/body-page';
|
||||
import { DesignPage } from '@/pages/design/design-page';
|
||||
import { HomePage } from '@/pages/home/home-page';
|
||||
import { onboardingRoute } from '@/pages/onboarding/onboarding-route';
|
||||
import { settingsRoute } from '@/pages/settings/settings-route';
|
||||
import { SetupPage } from '@/pages/setup/setup-page';
|
||||
|
||||
export const paths = {
|
||||
home: '/',
|
||||
body: '/body',
|
||||
setup: '/setup',
|
||||
onboarding: '/onboarding',
|
||||
settings: '/settings',
|
||||
design: '/design',
|
||||
} as const;
|
||||
|
||||
export const routes: RouteDefinition[] = [
|
||||
{ path: paths.home, component: HomePage },
|
||||
{ path: paths.body, component: BodyPage },
|
||||
{ path: paths.setup, component: SetupPage },
|
||||
onboardingRoute(paths.onboarding),
|
||||
settingsRoute({ base: paths.settings, wizard: paths.onboarding }),
|
||||
...(import.meta.env.DEV ? [{ path: paths.design, component: DesignPage }] : []),
|
||||
];
|
||||
@@ -1,8 +0,0 @@
|
||||
import { paths } from '@/app/routes';
|
||||
import type { SearchDestination } from '@/pages/settings/quick-search/search-entries';
|
||||
|
||||
// Pages outside the settings that quick search lists. Add a row when a page's route lands.
|
||||
export const searchDestinations: SearchDestination[] = [
|
||||
{ path: paths.home, title: 'navbar-home' },
|
||||
{ path: paths.onboarding, title: 'navbar-onboarding' },
|
||||
];
|
||||
@@ -1,198 +0,0 @@
|
||||
import { useMatch } from '@solidjs/router';
|
||||
import { createSignal, createUniqueId, Show } from 'solid-js';
|
||||
import { ServerInfosRequestT, ServerInfosResponseT } from 'solarxr-protocol';
|
||||
import DownloadIcon from '~icons/heroicons/arrow-down-tray-solid';
|
||||
import SearchIcon from '~icons/heroicons/magnifying-glass-20-solid';
|
||||
import QuestionIcon from '~icons/heroicons/question-mark-circle';
|
||||
import CloseIcon from '~icons/material-symbols/close-rounded';
|
||||
import MaximiseIcon from '~icons/material-symbols/crop-square-outline-rounded';
|
||||
import MinimiseIcon from '~icons/material-symbols/minimize-rounded';
|
||||
import GearIcon from '~icons/material-symbols/settings-rounded';
|
||||
import SlimevrLogoIcon from '~icons/slime/slimevr-logo';
|
||||
import { paths } from '@/app/routes';
|
||||
import { serverUpdate } from '@/domain/app-update/release-check';
|
||||
import {
|
||||
DOCS_SITE,
|
||||
LATEST_RELEASE_URL,
|
||||
RELEASES_URL,
|
||||
WINDOWS_DOWNLOAD_URL,
|
||||
} from '@/lib/links';
|
||||
import { platform, type WindowApi } from '@/lib/platform';
|
||||
import { flushPrefs } from '@/lib/storage';
|
||||
import { openQuickSearch } from '@/pages/settings/quick-search/quick-search';
|
||||
import { defineResource } from '@/solarxr/resource';
|
||||
import { TextButton } from '@/ui/button';
|
||||
import { MotionRegion } from '@/ui/motion';
|
||||
import { PlainLink } from '@/ui/plain-link';
|
||||
import { Tooltip } from '@/ui/tooltip';
|
||||
|
||||
const serverInfos = defineResource({
|
||||
request: () => new ServerInfosRequestT(),
|
||||
response: ServerInfosResponseT,
|
||||
});
|
||||
|
||||
const VERSION =
|
||||
(__VERSION_TAG__ || __COMMIT_HASH__) + (__GIT_CLEAN__ ? '' : '-dirty');
|
||||
|
||||
function localIp() {
|
||||
const ip = serverInfos.value()?.localIp;
|
||||
return ip ? String(ip) : null;
|
||||
}
|
||||
|
||||
function openUpdate() {
|
||||
platform.openUrl(
|
||||
platform.os === 'windows' ? WINDOWS_DOWNLOAD_URL : LATEST_RELEASE_URL
|
||||
);
|
||||
}
|
||||
|
||||
function WindowControls(props: { api: WindowApi }) {
|
||||
async function close() {
|
||||
await flushPrefs();
|
||||
props.api.close();
|
||||
}
|
||||
|
||||
return (
|
||||
<>
|
||||
<TextButton
|
||||
variant="ghost"
|
||||
size="small"
|
||||
iconOnly
|
||||
label="titlebar-minimize"
|
||||
icon={<MinimiseIcon class="icon icon-sm" />}
|
||||
onClick={() => props.api.minimize()}
|
||||
/>
|
||||
<TextButton
|
||||
variant="ghost"
|
||||
size="small"
|
||||
iconOnly
|
||||
label="titlebar-maximize"
|
||||
icon={<MaximiseIcon class="icon icon-sm" />}
|
||||
onClick={() => props.api.toggleMaximize()}
|
||||
/>
|
||||
<TextButton
|
||||
variant="ghost"
|
||||
size="small"
|
||||
iconOnly
|
||||
label="titlebar-close"
|
||||
icon={<CloseIcon class="icon icon-sm" />}
|
||||
onClick={close}
|
||||
/>
|
||||
</>
|
||||
);
|
||||
}
|
||||
|
||||
// Window controls and logo only, for screens outside the router (crash screen): no links,
|
||||
// no server data, so it keeps working whatever broke
|
||||
export function MinimalTitleBar() {
|
||||
return (
|
||||
<div class="flex h-titlebar shrink-0 items-center gap-sm px-sm">
|
||||
<span class="flex h-5.5 w-12.25 translate-x-[2.17px] items-center justify-center text-special">
|
||||
<SlimevrLogoIcon
|
||||
aria-hidden="true"
|
||||
style={{ '--icon-size': '49.66px' }}
|
||||
/>
|
||||
</span>
|
||||
<span class="flex h-full items-center" data-electron-drag-region="true">
|
||||
SlimeVR
|
||||
</span>
|
||||
<div class="h-full flex-1" data-electron-drag-region="true" />
|
||||
<Show when={platform.window}>
|
||||
{(api) => <WindowControls api={api()} />}
|
||||
</Show>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
export function TitleBar() {
|
||||
const onSettings = useMatch(() => `${paths.settings}/*`);
|
||||
const [versionEl, setVersionEl] = createSignal<HTMLAnchorElement>();
|
||||
const commitTipId = createUniqueId();
|
||||
|
||||
return (
|
||||
<MotionRegion
|
||||
orientation="horizontal"
|
||||
class="flex h-titlebar shrink-0 items-center gap-sm px-sm"
|
||||
>
|
||||
<div class="hidden shell:contents">
|
||||
<PlainLink
|
||||
to={paths.home}
|
||||
label="navbar-home"
|
||||
class="h-5.5 w-12.25 justify-center text-special"
|
||||
>
|
||||
<span class="flex translate-x-[2.17px]">
|
||||
<SlimevrLogoIcon
|
||||
aria-hidden="true"
|
||||
style={{ '--icon-size': '49.66px' }}
|
||||
/>
|
||||
</span>
|
||||
</PlainLink>
|
||||
<span class="flex h-full items-center" data-electron-drag-region="true">
|
||||
SlimeVR
|
||||
</span>
|
||||
</div>
|
||||
<div class={onSettings() ? 'hidden shell:contents' : 'contents'}>
|
||||
<PlainLink
|
||||
ref={setVersionEl}
|
||||
href={RELEASES_URL}
|
||||
describedBy={commitTipId}
|
||||
class="
|
||||
h-5.5 shrink-0 rounded-lg bg-success/20 px-3 font-bold whitespace-nowrap text-success
|
||||
select-text
|
||||
"
|
||||
>
|
||||
{VERSION}
|
||||
</PlainLink>
|
||||
<Tooltip id={commitTipId} anchor={versionEl}>
|
||||
{__COMMIT_HASH__}
|
||||
</Tooltip>
|
||||
</div>
|
||||
<Show when={onSettings() && localIp()}>
|
||||
{(ip) => (
|
||||
<span class="rounded-md bg-special/20 px-sm font-bold text-special select-text">
|
||||
{ip()}
|
||||
</span>
|
||||
)}
|
||||
</Show>
|
||||
<Show when={platform.window && serverUpdate()}>
|
||||
<TextButton
|
||||
variant="ghost"
|
||||
size="small"
|
||||
iconOnly
|
||||
label="titlebar-update"
|
||||
icon={<DownloadIcon />}
|
||||
onClick={openUpdate}
|
||||
/>
|
||||
</Show>
|
||||
<div class="h-full flex-1" data-electron-drag-region="true" />
|
||||
<TextButton
|
||||
variant="ghost"
|
||||
size="small"
|
||||
iconOnly
|
||||
label="titlebar-search"
|
||||
icon={<SearchIcon />}
|
||||
onClick={openQuickSearch}
|
||||
/>
|
||||
<TextButton
|
||||
to={paths.settings}
|
||||
variant="ghost"
|
||||
size="small"
|
||||
iconOnly
|
||||
label="titlebar-settings"
|
||||
icon={<GearIcon />}
|
||||
/>
|
||||
<div class="hidden shell:contents">
|
||||
<TextButton
|
||||
variant="ghost"
|
||||
size="small"
|
||||
iconOnly
|
||||
label="titlebar-docs"
|
||||
icon={<QuestionIcon />}
|
||||
onClick={() => platform.openUrl(DOCS_SITE)}
|
||||
/>
|
||||
</div>
|
||||
<Show when={platform.window}>
|
||||
{(api) => <WindowControls api={api()} />}
|
||||
</Show>
|
||||
</MotionRegion>
|
||||
);
|
||||
}
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:9d02c57155f8011a4363e242f3c195633450477b19ca5784ecf9b28df5401143
|
||||
size 460668
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:78bcd8987b35612739dfc8f556f6da497f689b26e96f5267b9a008ea9f46bd14
|
||||
size 592038
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:d54e1a99c1c228d004d2c94d3e1ed49f0cc14d7a471b71130fe89aa1518acc73
|
||||
size 438548
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:76d5b68294770112ee3d97cddcf5751008df2cb3a372655e7611d4db231243fc
|
||||
size 139344
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:71fa8383b0fde387e91e88c0f95eb057ad62905df8ac78c89ade1627ad17b0b3
|
||||
size 21360
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:76c1f559ecc11239e2f126eb76ae4c2e097a26f227a915de7127db4f61eafc40
|
||||
size 27230
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:13b7a9177af9378284c4eca264590deae6654b8b92c00d9ca948628c16dd118f
|
||||
size 22590
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:fd98226b28ed3f68b5a6fa03dada951fc4326c56119d59fcad09fef261053446
|
||||
size 155016
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:fe7893c1645174eee669dfa9e7222c55638c8d498eb126a397a6df759c028919
|
||||
size 28604
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:c71f29809334563348f8f29cf41afeb8bedbbd5ba2875bf40621b011ac52d2d3
|
||||
size 30678
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:8b00c02450258536066870137876f4fe1882d4e4b6fc4ab9f32ad46220ed5efa
|
||||
size 52158
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:faabda8027d550b10723457a8274962b3b8d9eb906cbac0c73d20916e6633e95
|
||||
size 13558
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:8bd89b59087cc0f019ca2179fcc57d99811c327cdd6b1fd6e57705f7299aa2ae
|
||||
size 14402
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:38aebca5266f47270dc60c4682022809e43676ac9b3dd4b5a586ce3157f8a8a0
|
||||
size 99786
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:b40baa0413d30f5df34eb7bd7e8867cb73905a098fd7398de67a2d60b3882070
|
||||
size 152284
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:31e6929b6176244f53e85088812f5cc4e7b94679039688f929b21b8e1bb985e7
|
||||
size 94060
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:6e95853b79d711826f454fcc48e5d4ffd608a74e13aff2c7aa8628730362dd0f
|
||||
size 154508
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:f6dc4d54b43844a85099941b64a9b92cba0f58ebe33dc61a48e12536f20174b3
|
||||
size 130492
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:9cfe4aa1ed1422df92dd34952331cdf4dddcac4f6135b96bc1f5e112276deef5
|
||||
size 46890
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:1a9f7a0b082efc151cf0147a6e2194ce686a86751a7d168f5052fef5ef2e9890
|
||||
size 20458
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:f7b2bf36937133e653a83f2523e51cb40f372622a347c19fef94a2e45ee2f913
|
||||
size 67850
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:fce09373239c8f1781b9f8deba8b9fe7b70b0b7acdd1ae7de82841c44507bf83
|
||||
size 70686
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:18789a9b9bdadb09a6e016ca998cceace5d2ac371ce9f21b094d4e26f741b20d
|
||||
size 58344
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:305526056be521e08af825f81c14461008137656c8d5ae2cde278958071c5d19
|
||||
size 27460
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:6c40f36772015ce29eb6916e08b2fb3735b837dba4a6d0de253fc879ffb5119a
|
||||
size 92960
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:78530533994a3515947123a5fb9d495c5c18698fc0a7894e3d6f5ae68bf8683c
|
||||
size 241652
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:37a2e21db039c707632467bea72ceada8fbbe89f6dcf71efa90761f6efd7df4c
|
||||
size 243576
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:63c95f09e4ad1b2ad33c008c18344cdbbacfbc923f0817ce999aed27e2e621f3
|
||||
size 226052
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:fb48ab063b7628e0236ec90982301a0f1b34a8f04e74e6e01944834f857ed5e1
|
||||
size 308426
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:cd154cda0e1dd0258e6ac7f945b9e965b586ce110c1476e7765d4f486e9c129d
|
||||
size 224468
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:448bda8904bb72de261f035ef23ad90bad33f3ced17180dc1c8a50391c6c587c
|
||||
size 229804
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:963bc302f6a88d613c4907d2ece6802198b5e2d7147360ce9f5d9024e014c02d
|
||||
size 219678
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:771d3c1222073db09ea45a4afe4fd79e18a16592733eb73e8614865d4f442114
|
||||
size 371974
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:57ca3e79eb5dadc9861462f54e0bdf74e96885b8dcc961bb134de2f8c383a21c
|
||||
size 174124
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:c369d04af7f341fe50811b74532962f02048b46a69690d0ebbbc59123e674c99
|
||||
size 302760
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:90abbb29202768f5e12d2bdeaa020b8bd831faf39decf309ae714d6ea0196fa5
|
||||
size 268014
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:4ec384b4afdf344eefe66674e675a3e7dbc34f1e9212c2a7d21ec1426bec7238
|
||||
size 35321
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:4691ba3c289538e2578f7e366421031963fae6d593418fb8fb94b8ed0bd53453
|
||||
size 27421
|
||||
@@ -1,3 +0,0 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:8180983bcdd98afc329b23b8fbe549d448b861e625926f19cfef1f1d17e96713
|
||||
size 183196
|
||||
Loaded 100 of 1685 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user