From 81071d920e196cb43359477205adf1fb71c9f839 Mon Sep 17 00:00:00 2001 From: Kevin Wijnen <58944808+kevin-wijnen@users.noreply.github.com> Date: Sun, 22 Sep 2024 14:05:03 +0200 Subject: [PATCH 1/9] [feature] GitHub Actions wiki automation Initial concept for automating the BSManager Wiki via PR's to the docs/wiki folder. Requires locking the Wiki's writing to none of the public, to prevent vandalism, desyncs and losing wiki-only information, with what is on the repository. --- .github/workflows/docs.yaml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .github/workflows/docs.yaml diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml new file mode 100644 index 00000000..c70a2083 --- /dev/null +++ b/.github/workflows/docs.yaml @@ -0,0 +1,18 @@ +name: Publish wiki +on: + push: + branches: [main] + paths: + - docs/wiki/** + - .github/workflows/publish-wiki.yml +concurrency: + group: publish-wiki + cancel-in-progress: true +permissions: + contents: write +jobs: + publish-wiki: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: Andrew-Chen-Wang/github-wiki-action@v4 From f0e32bdae15b88bac00f57bc10072385ee424001 Mon Sep 17 00:00:00 2001 From: Kevin Wijnen <58944808+kevin-wijnen@users.noreply.github.com> Date: Sun, 22 Sep 2024 14:06:00 +0200 Subject: [PATCH 2/9] [chore] Fix spelling --- .github/workflows/release-linux.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/release-linux.yaml b/.github/workflows/release-linux.yaml index 542495ad..25a280e0 100644 --- a/.github/workflows/release-linux.yaml +++ b/.github/workflows/release-linux.yaml @@ -1,6 +1,6 @@ # This workflow will... -name: Realease Linux +name: Release Linux env: GH_TOKEN: ${{ secrets.GH_TOKEN }} From 6d6da765a659d8c808864360e6516a7954ffc9c2 Mon Sep 17 00:00:00 2001 From: Kevin Wijnen <58944808+kevin-wijnen@users.noreply.github.com> Date: Sun, 22 Sep 2024 14:14:44 +0200 Subject: [PATCH 3/9] [chore] wiki article migration --- ...ing-opens-when-I-press-`Ctrl`‐`Shift`‐`I`.md | 21 +++++++++++++ docs/wiki/Home.md | 3 ++ docs/wiki/How-to-obtain-your-Oculus-Token.md | 30 +++++++++++++++++++ ...-opens-when-I-press-`Ctrl`‐`Shift`‐`i`..md | 4 +++ 4 files changed, 58 insertions(+) create mode 100644 docs/wiki/AMD-Sofware-‐-Nothing-opens-when-I-press-`Ctrl`‐`Shift`‐`I`.md create mode 100644 docs/wiki/Home.md create mode 100644 docs/wiki/How-to-obtain-your-Oculus-Token.md create mode 100644 docs/wiki/Nothing-opens-when-I-press-`Ctrl`‐`Shift`‐`i`..md diff --git a/docs/wiki/AMD-Sofware-‐-Nothing-opens-when-I-press-`Ctrl`‐`Shift`‐`I`.md b/docs/wiki/AMD-Sofware-‐-Nothing-opens-when-I-press-`Ctrl`‐`Shift`‐`I`.md new file mode 100644 index 00000000..f4ca6978 --- /dev/null +++ b/docs/wiki/AMD-Sofware-‐-Nothing-opens-when-I-press-`Ctrl`‐`Shift`‐`I`.md @@ -0,0 +1,21 @@ +If you encounter a keyboard shortcut conflict between AMD Software and Oculus Rift, you can either disable or modify the conflicting shortcut. + +_Special thanks to_ `𝔽𝕪𝕟𝕟 (fynn07)` _for its contribution with information and screenshots_ +### __Follow these steps to disable the shortcut in AMD Software:__ +# Step 1 - Access Settings: +- Open AMD Software and click on the gear icon in the top right corner to go to settings. + +![image](https://github.com/Zagrios/bs-manager/assets/40648115/2762f59c-f12a-46ba-80fa-9bf79beb64a9) +# Step 2 - Modify Keyboard Shortcuts: +- In the settings menu, select the "Hotkey" tab. + +![image](https://github.com/Zagrios/bs-manager/assets/40648115/262d4fcc-529f-4c4c-9b87-e2da21df1b95) +# Step 3 -Disabling Shortcuts: +- Turn off the "Use Hotkeys" option to prevent any conflicts with Oculus Rift. + +![image](https://github.com/Zagrios/bs-manager/assets/40648115/756018ad-7de3-469c-9f40-0082be007805) +# Step 3 alt - Modify the Shortcut: +- If you prefer to keep using keyboard shortcuts, consider changing the specific conflicting shortcut (e.g., "Ctrl + Shift + I") to another combination that is less likely to interfere. + +ℹ️ _**Keep in mind you can't change the full keybind!**_ +_**You can only Change the "i" to an different Button!**_ ℹ️ \ No newline at end of file diff --git a/docs/wiki/Home.md b/docs/wiki/Home.md new file mode 100644 index 00000000..95c154c4 --- /dev/null +++ b/docs/wiki/Home.md @@ -0,0 +1,3 @@ +Welcome to the bs-manager wiki! (wip c:) + +to get you oculus token check here : https://github.com/Zagrios/bs-manager/wiki/How-to-obtain-your-Oculus-Token \ No newline at end of file diff --git a/docs/wiki/How-to-obtain-your-Oculus-Token.md b/docs/wiki/How-to-obtain-your-Oculus-Token.md new file mode 100644 index 00000000..93214d6e --- /dev/null +++ b/docs/wiki/How-to-obtain-your-Oculus-Token.md @@ -0,0 +1,30 @@ +### Important + +Your token is a confidential piece of information. Possession of this token allows individuals to download applications, send messages, among other actions, under your identity. + +However, you might wonder why it is necessary to provide this token to BSManager. The reason is that BSManager requires the token to continue the download with Oculus. Once you've input the token, it is used exclusively to communicate with Oculus servers to verify that you are the rightful owner of the game. + +## Step 1 - Install and log into the Oculus Rift app +- Get the Oculus Rift app setup from the [Meta website](https://www.oculus.com/rift/setup/) +- Install the Oculus Rift app + +ℹ️ **If you bought Beat Saber from the Quest store, it won't appear in your Rift library by default. To download it with BSManager, first claim it from its store page** ℹ️ + +## Step 2 - Open developer tools + +- Open Oculus app +- Open the developer tools by pressing Ctrl + Shift + i. + +## Step 3 - Copy your Token +In the developer tools : +- Open the `Network` tab ***(1)*** +- Filter for `graph` ***(2)*** +- Click on the first request ***(3)*** +- Open the `Headers` tab ***(4)*** +- Scroll to the bottom to locate your token, it should start with `FRL` ***(5)*** +- Select the token using your mouse and press Ctrl + c to copy it + +![image](https://github.com/Zagrios/bs-manager/assets/40181755/b46be623-cefe-4349-bace-70a4109685a3) + +# Known bugs +- ⁠[Nothing opens when I press `Ctrl`+`Shift`+`i`.](https://github.com/Zagrios/bs-manager/wiki/Nothing-opens-when-I-press-%60Ctrl%60%E2%80%90%60Shift%60%E2%80%90%60i%60.) \ No newline at end of file diff --git a/docs/wiki/Nothing-opens-when-I-press-`Ctrl`‐`Shift`‐`i`..md b/docs/wiki/Nothing-opens-when-I-press-`Ctrl`‐`Shift`‐`i`..md new file mode 100644 index 00000000..e2e7762b --- /dev/null +++ b/docs/wiki/Nothing-opens-when-I-press-`Ctrl`‐`Shift`‐`i`..md @@ -0,0 +1,4 @@ +If nothing opens when you press `Ctrl` + `Shift` + `I`, it's possible that the keyboard shortcut to open the development tools is being used by another application. + +Here's a non-exhaustive list of applications that have caused a problem and their suggested solutions: +- ⁠[AMD software](https://github.com/Zagrios/bs-manager/wiki/AMD-Sofware-%E2%80%90-Nothing-opens-when-I-press-%60Ctrl%60%E2%80%90%60Shift%60%E2%80%90%60I%60) \ No newline at end of file From 3ff3c5af67be33034011dbca87acca5c67fd8d07 Mon Sep 17 00:00:00 2001 From: Kevin Wijnen <58944808+kevin-wijnen@users.noreply.github.com> Date: Sun, 22 Sep 2024 14:19:23 +0200 Subject: [PATCH 4/9] [docs] Add explainer for wiki automation --- docs/wiki/Home.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/wiki/Home.md b/docs/wiki/Home.md index 95c154c4..e86e76cb 100644 --- a/docs/wiki/Home.md +++ b/docs/wiki/Home.md @@ -1,3 +1,12 @@ Welcome to the bs-manager wiki! (wip c:) -to get you oculus token check here : https://github.com/Zagrios/bs-manager/wiki/How-to-obtain-your-Oculus-Token \ No newline at end of file +to get you oculus token check here : https://github.com/Zagrios/bs-manager/wiki/How-to-obtain-your-Oculus-Token + +--- + +To add to the wiki: + +- Fork the project +- Add/Edit `.md` files in the `docs/wiki/` folder +- Create a Pull Request +- Once the PR is merged, it will be present in the repository's wiki From 63ef3acc729a24c4ec1302105c6a25dfe45ccf37 Mon Sep 17 00:00:00 2001 From: Kevin Wijnen <58944808+kevin-wijnen@users.noreply.github.com> Date: Sun, 22 Sep 2024 14:21:28 +0200 Subject: [PATCH 5/9] [bugfix] Fix target branch wiki automation --- .github/workflows/docs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index c70a2083..13df6389 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -1,7 +1,7 @@ name: Publish wiki on: push: - branches: [main] + branches: [master] paths: - docs/wiki/** - .github/workflows/publish-wiki.yml From 5f35a43098045b3ef4abc7f7fe287fcc380bb63f Mon Sep 17 00:00:00 2001 From: Kevin Wijnen <58944808+kevin-wijnen@users.noreply.github.com> Date: Sun, 22 Sep 2024 14:22:48 +0200 Subject: [PATCH 6/9] [chore] Trigger wiki automation --- docs/wiki/Home.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/wiki/Home.md b/docs/wiki/Home.md index e86e76cb..0417f48d 100644 --- a/docs/wiki/Home.md +++ b/docs/wiki/Home.md @@ -9,4 +9,4 @@ To add to the wiki: - Fork the project - Add/Edit `.md` files in the `docs/wiki/` folder - Create a Pull Request -- Once the PR is merged, it will be present in the repository's wiki +- Once the PR is merged (after review), it will be present in the repository's wiki From 7161f0861eea9992a74bd8711b1a4e6e601ff85e Mon Sep 17 00:00:00 2001 From: Kevin Wijnen <58944808+kevin-wijnen@users.noreply.github.com> Date: Sun, 22 Sep 2024 14:30:28 +0200 Subject: [PATCH 7/9] [bugfix] Target path for wiki automation --- .github/workflows/docs.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 13df6389..ab9d9b7d 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -16,3 +16,5 @@ jobs: steps: - uses: actions/checkout@v3 - uses: Andrew-Chen-Wang/github-wiki-action@v4 + with: + path: docs/wiki/ From 883f7594b0670931f03f39152fc71fb7d817683b Mon Sep 17 00:00:00 2001 From: Kevin Wijnen <58944808+kevin-wijnen@users.noreply.github.com> Date: Sun, 22 Sep 2024 14:32:23 +0200 Subject: [PATCH 8/9] [bugfix] Trigger path for wiki automation --- .github/workflows/docs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index ab9d9b7d..78436770 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -4,7 +4,7 @@ on: branches: [master] paths: - docs/wiki/** - - .github/workflows/publish-wiki.yml + - .github/workflows/docs.yml concurrency: group: publish-wiki cancel-in-progress: true From 793af822ce61b7bcc3d178e02eb4318202e2d56e Mon Sep 17 00:00:00 2001 From: Kevin Wijnen <58944808+kevin-wijnen@users.noreply.github.com> Date: Sun, 22 Sep 2024 14:33:42 +0200 Subject: [PATCH 9/9] [docs] Specify how to contribute to the wiki --- docs/wiki/Home.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/wiki/Home.md b/docs/wiki/Home.md index 0417f48d..5f2fb65c 100644 --- a/docs/wiki/Home.md +++ b/docs/wiki/Home.md @@ -4,7 +4,9 @@ to get you oculus token check here : https://github.com/Zagrios/bs-manager/wiki/ --- -To add to the wiki: +This Wiki accepts contributions! + +To contribute to the wiki: - Fork the project - Add/Edit `.md` files in the `docs/wiki/` folder