Bump version to 1.17.1

* Trying to fix the audio problem with volume booster

* Add an option to disable volume control feature

* Update translations

.github/FUNDING.yml

@@ -0,0 +1 @@
+ko_fi: redphx

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,34 +1,21 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: "[Bug]"
+title: "[Bug] ..."
 labels: bug
 assignees: ''
 
 ---
 
+**Platform**
+ - Device: Phone, Laptop, Desktop, TV...
+ - OS: Windows, Android, iOS...
+ - Browser: Chrome, Safari, Kiwi...
+ - Browser Version:
+ - Better xCloud Version:
+
 **Describe the bug**
-A clear and concise description of what the bug is.
+...
 
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Platform (please complete the following information):**
- - Device: [e.g. Phone/Laptop/Desktop/TV]  
- - OS: [e.g. Android]  
- - Browser: [e.g. Chrome, Kiwi]  
- - Browser Version: [e.g. 100]  
-- Better xCloud Version: [e.g. 1.4]  
-
-**Additional context**
-Add any other context about the problem here.
+**Screenshots/Videos**
+If applicable, add screenshots/videos to help explain your problem.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +1,16 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: "[Feature]"
+title: "[Feature] ..."
 labels: enhancement
 assignees: ''
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.
+**I'm using:**  
+- Device:
+- OS:
+- Browser:
+  
+**I want to suggest this feature:**  
+...

README.md

@@ -1,29 +1,79 @@
 # Better xCloud
 Improve [Xbox Cloud Gaming (xCloud)](https://www.xbox.com/play/) experience on web browser.  
-The main target of this script is mobile users, but it should work great on desktop too.
+The main target of this script is mobile users, but it should work great on desktop too.  
 
 This script makes me spend more time with xCloud, and I hope the same thing happens to you.  
-Give this project a 🌟 if you like it. Thank you 🙏.
+If you like this project please give it a 🌟. Thank you 🙏.
 
 [![Latest version](https://img.shields.io/github/v/release/redphx/better-xcloud?label=latest)](https://github.com/redphx/better-xcloud/releases) 
-[![Total stars](https://img.shields.io/github/stars/redphx/better-xcloud?color=%23cca400)](https://github.com/redphx/better-xcloud/stargazers)  
-<!--
 [![Total downloads](https://img.shields.io/github/downloads/redphx/better-xcloud/total?color=%23e15f2c)](https://github.com/redphx/better-xcloud/releases) 
--->
+[![Total stars](https://img.shields.io/github/stars/redphx/better-xcloud?color=%23cca400)](https://github.com/redphx/better-xcloud/stargazers)  
 
 
+## Table of Contents
+- [**How to install**](#how-to-install)
+- [**Compatibility**](#compatibility)
+- [**Features**](#features)
+- [**Stream stats**](#stream-stats)
+- [**Capture screenshot**](#capture-screenshot)
+- [**FAQ**](#faq)
+- [**Translators**](#translators)
+- [**Donation**](#donation)
+- [**Acknowledgements**](#acknowledgements)
+- [**Disclaimers**](#disclaimers)
+
+## How to install
+1. Install an userscript extension:
+   - **Safari**: Install [Userscripts extension](https://apps.apple.com/us/app/userscripts/id1463298887). Check [this page](https://github.com/redphx/better-xcloud/wiki/Using-with-Safari) before using.
+   - **All other browsers**: Install [Tampermonkey extension](https://www.tampermonkey.net/).  
+3. Install **Better xCloud**:
+    - [Stable version](https://github.com/redphx/better-xcloud/releases/latest/download/better-xcloud.user.js)
+    <!-- - [Dev version](https://github.com/redphx/better-xcloud/raw/main/better-xcloud.user.js)-->  
+    I only distribute **Better xCloud** on GitHub, *DO NOT* download it on other websites or from unknown sources.
+4. Refresh [xCloud web page](https://www.xbox.com/play/).
+5. Click on the new "SERVER NAME" button next to your profile picture to adjust settings.
+
+To update manually, just install the script again (you won't lose your settings).
+
+⚠️⚠️⚠️ If you're using Kiwi Browser on Android, make sure to follow the steps correctly and install the script with Tampermonkey (not installing it as an extension), or else it won't work.
+
+## Compatibility
+- 👍 = best choice, all features work as intended
+- ✅ = confirmed to be working, might miss some features
+- ❌ = not supported (mostly because of lacking Userscript/extension support)
+- ➖ = unavailable
+- 🗒️ = see custom notes
+
+|                                         | Windows/Linux    | macOS            | Android/Android TV | iOS              |
+|-----------------------------------------|:-----------------|:-----------------|:-------------------|:-----------------|
+| Chrome/Edge/Chromium variants           | 👍               | 👍               | ❌                  | ❌               |
+| Firefox                                 | ✅               | ✅               | 🗒️<sup>(1)</sup>    | ❌               |
+| Safari                                  | ➖               | ✅<sup>(2)</sup> | ➖                  | ✅<sup>(3)</sup> |
+| [Kiwi Browser](https://kiwibrowser.com) | ➖               | ➖               | 👍                  | ➖               |
+
+Don't see your browser in the table? If it supports Tampermonkey/Userscript then the answer is likely **"YES"**.
+
+<sup>1</sup> Follow [this guide](https://support.mozilla.org/en-US/kb/find-and-install-add-ons-firefox-android) to install Tampermonkey on Firefox Android. Its Gamepad API doesn't work properly so it might not recognize your controller.  
+<sup>2, 3</sup> Requires [Userscripts app](https://apps.apple.com/us/app/userscripts/id1463298887) (free & open-source). Check [this page](https://github.com/redphx/better-xcloud/wiki/Using-with-Safari) before using.  
+
+---
+- **Kiwi Browser** is the best choice on Android. All features work, it means you can get 1080p stream + high-quality codec profile (the best possible quality).  
+- **Better xCloud** also works on Android TV, but you'll have to sideload the browser APK and need a Bluetooth mouse if you want to interact with the Settings.  
+
 ## Features
 
-<img width="400" alt="Settings UI" src="https://github.com/redphx/better-xcloud/assets/96280/6e74fdaf-dc84-416a-a2bc-5e117a3717e3">
+<img width="400" alt="Settings UI" src="https://github.com/redphx/better-xcloud/assets/96280/8baddcfa-b528-4ba7-9392-7b5fe60cea11">
 <br>
-<img width="600" alt="Stream HUD" src="https://github.com/redphx/better-xcloud/assets/96280/e30f6514-13ca-41c6-bff2-979573cff956">
+<img width="600" alt="Stream HUD" src="https://github.com/redphx/better-xcloud/assets/96280/51bdb96c-79ab-402f-902a-a9e6229973b2">
 <br>
-<img width="600" alt="Video settings" src="https://github.com/redphx/better-xcloud/assets/96280/c45877f9-379c-4ba4-977c-021d3d8835e4">
+<img width="600" alt="Stream settings" src="https://github.com/redphx/better-xcloud/assets/96280/18ed4598-4eca-4626-9434-5f74266b00e7">
 
 &nbsp;  
   
 **Demo video:** [https://youtu.be/oDr5Eddp55E  ](https://youtu.be/AYb-EUcz72U)  
 
+- **🔥 Improve visual quality of the stream**
+  > Similar to (but not as good as) the "Clarity Boost" of xCloud on Edge browser. [Demo video](https://youtu.be/ZhW2choAHUs). 
 - **🔥 Show stream stats**  
   > Check [Stream stats section](#stream-stats) for more info.  
 - **🔥 Capture screenshot**
@@ -36,36 +86,61 @@ Give this project a 🌟 if you like it. Thank you 🙏.
 
 ### Server
 - **Set the region of streaming server**  
-  > Connect to another server instead of the default one. Check the [**FAQ** section](#faq) for some notes.
+  > Connect to another server instead of the default one.  
+  > It's not using VPN.  
+  > ["Can I get banned for using this?"](#faq)  
 - **Preferred game's language**
   > If the game doesn't support this language, it will use the same language as xCloud's website.  
 - **Prefer IPv6 server**
   > Might reduce latency.
 
-### Stream quality
+### Stream
 - **Set target resolution**
   > By default you only get 1080p stream when playing on desktop.  
   > This feature can give you 1080p stream even on mobile, without having to change User-Agent.  
-- **Force high-quality codec (if supported)<sup>(\*)</sup>**
-  > Force xCloud to use the best streaming codec profile (same as desktop & TV) if possible. You don't have to change User-Agent anymore.  
-  > You should enable this feature even if you're on desktop.  
-  > Not available for some browsers (Firefox, Safari...).  
-  > Use more bandwidth & battery.  
+- **Change visual quality**
+  > Increase/decrease the quality of the stream to your liking. Only works in Chrome/Edge/Kiwi...  
   > Comparison video with the setting ON & OFF: https://youtu.be/-9PuBJJSgR4  
 - **Disable bandwidth checking**  
-  > xCloud won't warn about slow connection speed.  
+  > xCloud won't warn about slow connection speed.
+- **Enable volume control feature**
+  > Allow increasing stream's volume up to 600%  
+  > ⚠️ Disable this setting if you experience slowdown, choppy/muted stream  
+- **Enable microphone on game launch**  
+  > Automatically enable the mic when starting to play a game.  
+- **Hide mouse cursor on idle**  
+  > Hide the mouse cursor after 3 seconds of not moving.  
 
-### Controller
-- **🔥 Touch controller**
-  > Only for mobile (Android/iOS/iPadOS).  
+
+### 🔥 Touch controller
+- **Availability**
+  > Only for devices with touch support (Android/iOS/iPadOS/...). Using "Desktop mode" in mobile browsers also disables this feature.  
   > - **Default**: nothing change.  
   > - **Off**: stop the touch controller from showing when touching the screen. Useful when you play on a device with a built-in controller like Logitech G Cloud, Steam Deck, etc.  
   > - **All games**: enable touch controller support for all games. Games with custom layout won't be affected.  
-  > Double-tap anywhere at the bottom of the screen to show/hide the controller. Useful when you're viewing cutscenes.
-  > ![touch-controller](https://github.com/redphx/better-xcloud/assets/96280/6ad6fc76-74aa-46f8-8fb0-806474f494ad)
+  > Double-tap anywhere at the bottom of the screen to show/hide the controller. Useful when you're viewing cutscenes.  
+  > &nbsp;  
+  > ![toggle-touch-controller](https://github.com/redphx/better-xcloud/assets/96280/8b9c7091-529a-45ae-8b45-73e61531ecc8)
+- **Button styles**
+  > - Default  
+  > - Muted  
+  > - All white (only for standard/default controller)  
+  > &nbsp;  
+  > <img width="400" alt="Button styles" src="https://github.com/redphx/better-xcloud/assets/96280/2bfef2b3-6712-4924-b067-c2312f8c8062">
+
+### Loading screen
+- **Show game art**
+  > Replace the black background with game art if it's available.  
+- **Show the estimated wait time**
+  > The time is estimated by the server.  
+  > It's not 100% correct: you might get in the game sooner or later.  
+  > Check [#51](https://github.com/redphx/better-xcloud/issues/51) for more info.  
+- **Show/hide the rocket animation**
+  > Always show/Hide when queuing/Always hide.  
+  > Hide this animation might save some battery life while queuing.  
+  
+<img height="300" alt="Loading screen" src="https://github.com/redphx/better-xcloud/assets/96280/46074b14-1abb-466d-a859-d46ad4dac2fd">
 
-- **Hide mouse cursor on idle**  
-  > Hide the mouse cursor after 3 seconds of not moving.  
 
 ### UI
 - **Simplify Stream's menu**
@@ -83,17 +158,29 @@ Give this project a 🌟 if you like it. Thank you 🙏.
 - **Disable xCloud analytics**
   > The analytics contains statistics of your streaming session, so I'd recommend allowing analytics to help Xbox improve xCloud's experience in the future.
 
-### Stream's video features
-⚠️ These features don't work when xCloud's "Clarity Boost" feature is ON ([#64](https://github.com/redphx/better-xcloud/issues/64)).  
+### In-game settings
+- **Volume control**
+  > Increase stream's volume up to 600%  
+  > Can be disabled in the Main Settings  
+- **🔥 Improve stream's clarity**
+  > Similar to (but not as good as) the "Clarity Boost" of xCloud on Edge browser. [Demo video](https://youtu.be/ZhW2choAHUs).  
+  > Also known as poor man's "Clarity Boost".  
+  > Affects the stream's performance, uses more battery, and may causes frames to drop (especially on lower-end devices).  
+  > Works with Chrome/Chromium browsers.  
+  > Doesn't work with Safari.  
+  > &nbsp;  
+  > ![clarity](https://github.com/redphx/better-xcloud/assets/96280/ed63bbb0-fcbf-43e2-8e51-ac2733e697b8)
+  > *(click to enlarge)*
 
-- **Stretch video to full sctreen**
+- **Change video's ratio**
   > Useful when you don't have a 16:9 screen
 - **Adjust video filters**
-  > Brightness/Contrast/Saturation.
+  > Brightness/Contrast/Saturation.  
+  > ⚠️ These features don't work when xCloud's "Clarity Boost" feature is ON ([#64](https://github.com/redphx/better-xcloud/issues/64)).  
 - **Display stream's statuses**
   > Region/Server/Codecs/Resolution...  
   > Current playtime of the session.  
-  > Current battery level.  
+  > Current battery level. Not working on [some browsers](https://caniuse.com/battery-status).  
   > Estimated total data sent/received.  
 
 ### Advanced features  
@@ -105,50 +192,11 @@ Give this project a 🌟 if you like it. Thank you 🙏.
 
 <sup>(\*)</sup> By default (for compatibility reasons) xCloud only uses high quality codec profile when you use Tizen TV or Chrome/Edge/Chromium browser on Chrome/MacOS. Enable this setting will give you the best experience no matter what platform & browser you're on.
 
-## How to use
-1. Install [Tampermonkey extension](https://www.tampermonkey.net/) on suppported browsers. For Safari, use [Userscripts app](https://apps.apple.com/us/app/userscripts/id1463298887).  
-2. Install **Better xCloud**:
-    - [Stable version](https://github.com/redphx/better-xcloud/releases/latest/download/better-xcloud.user.js)
-    - [Dev version](https://github.com/redphx/better-xcloud/raw/main/better-xcloud.user.js)  
-    I only distribute **Better xCloud** on GitHub, *DO NOT* download it on other websites or from unknown sources.  
-3. Refresh [xCloud web page](https://www.xbox.com/play/).
-4. Click on the new "SERVER NAME" button next to your profile picture to adjust settings.  
-5. Don't forget to enable auto updating for the script in Tampermonkey.
-
-To update manually, just install the script again (you won't lose your settings).
-
-## Tutorial videos  
-If you still have trouble installing **Better xCloud**, you can follow one of these tutorial videos:  
-- 🇧🇷 [Tudo isso agora tem no xCloud!! (ChipTec)](https://youtu.be/zS8Zy0mYIbU?t=40)
-- 🇫🇷 [#Tuto Xbox Cloud Gaming : Ecran ultra large et adieu les bandes noires sur smartphone (Cloud Gaming France)](https://www.youtube.com/watch?v=5U05KoTdDHs)
-
-
-## Compatibility
-✅ = confirmed to be working  
-❓ = not yet tested  
-❌ = not supported (mostly because of lacking Userscript/extension support)  
-➖ = unavailable  
-⚠️ = see custom notes  
-|                                         | Desktop          | Android/Android TV | iOS             |
-|-----------------------------------------|:-----------------|:-------------------|:----------------|
-| Chrome/Edge/Chromium variants           | ✅               | ❌                 | ❌               |
-| Firefox                                 | ✅               | ⚠️<sup>(1)</sup>   | ❌               |
-| Safari                                  | ✅<sup>(2)</sup> | ➖                 | ✅<sup>(3)</sup> |
-| [Hermit](https://hermit.chimbori.com)   | ➖               | ⚠️<sup>(4)</sup>   | ➖               |
-| [Kiwi Browser](https://kiwibrowser.com) | ➖               | ✅                 | ➖               |
-
-Don't see your browser in the table? If it supports Tampermonkey/Userscript then the answer is likely **"YES"**.
-
-<sup>1</sup> Follow [this guide](https://support.mozilla.org/en-US/kb/find-and-install-add-ons-firefox-android) to install Tampermonkey on Firefox Android. Its Gamepad API doesn't work properly so it might not recognize your controller.  
-<sup>2, 3</sup> Requires [Userscripts app](https://apps.apple.com/us/app/userscripts/id1463298887) (free & open source).  
-<sup>4</sup> NOT RECOMMENDED at the moment since its Userscript implementation is not working properly (see https://github.com/redphx/better-xcloud/issues/5 for full details).    
-
----
-- **Kiwi Browser** is the best choice on Android. All features work, it means you can get 1080p stream + high quality codec profile (the best possible quality).  
-- **Better xCloud** also works on Android TV, but you'll have to sideload the browser APK and need a Bluetooth mouse if you want to interact with the Settings.  
-
 ## Stream stats  
-<img width="500" alt="Stream stats" src="https://github.com/redphx/better-xcloud/assets/96280/0d4abb6b-49ab-4c9a-a52d-df7e396d2145">
+
+![stats](https://github.com/redphx/better-xcloud/assets/96280/736548db-316d-4bb3-a0f8-467766ae810b)
+
+<img width="500" alt="Stream stats" src="https://github.com/redphx/better-xcloud/assets/96280/142625ea-20ab-4392-a111-0c5bc08bae09">
 
 - While playing > `...` > `Stream Stats`.
 - Double-click on the stats bar to show the Settings dialog.
@@ -156,14 +204,14 @@ Don't see your browser in the table? If it supports Tampermonkey/Userscript then
 - **Quick glance** feature: only show the stats bar when the System menu is expanded. The 👀 emoji at the beginning indicates that the stats bar is in the quick glance mode.  
 - ⚠️ Using **Better xCloud** or showing the stats bar also affects the performance of the stream.  
 
-| Abbr. | Full name          | Explain                                                                                                                                    |
-|------:|:-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------|
-| FPS   | Frames per Seconds | The number of decoded frames in the last second of the stream (may not be the same as the FPS of the game)                                 |
-| DT    | Decode Time        | The average time it took to decode one frame in the last second (bugged in Kiwi Browser [#26](https://github.com/redphx/better-xcloud/issues/26)) |
-| RTT   | Round Trip Time    | The number of seconds it takes for data to be sent from your device to the server and back over (similar to ping, lower is better)         |
-| BR    | Bitrate            | The amount of data the server sent to your device in the last second                                                                       |
-| PL    | Packets Lost       | The total number of packets lost                                                                                                           |
-| FL    | Frames Lost        | The total number of frames dropped prior to decode or dropped because the frame missed its display deadline                                |
+| Abbr. | Full name          | Explain                                                                                                                                           |
+|------:|:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------|
+| PING  | Ping               | The number of seconds it takes for data to be sent from your device to the server and back over (the correct term is "Round Trip Time")           |
+| FPS   | Frames per Seconds | The number of decoded frames in the last second of the stream (may not be the same as the FPS of the game)                                        |
+| DT    | Decode Time        | The average time it took to decode one frame in the last second (bugged on Android [#26](https://github.com/redphx/better-xcloud/issues/26))      |
+| BR    | Bitrate            | The amount of data the server sent to your device in the last second                                                                              |
+| PL    | Packets Lost       | The total number of packets lost                                                                                                                  |
+| FL    | Frames Lost        | The total number of frames dropped prior to decode or dropped because the frame missed its display deadline                                       |
 
 This info is provided by WebRTC API. You can use browser's built-in tool to see more info:  
 - Chrome/Edge/Chromium variants: `chrome://webrtc-internals`  
@@ -195,7 +243,7 @@ Colors:
 5. Screenshot will be saved by the browser.
 6. You can double-tap that corner to capture screenshot.
 
-<img width="600" alt="Screenshot button" src="https://github.com/redphx/better-xcloud/assets/96280/a911b141-5dc0-450a-aeac-30d9cf202b44">
+![screenshot](https://github.com/redphx/better-xcloud/assets/96280/b277193e-df94-4d72-b75c-3f728c984974)
 
 ## FAQ
 1. **Will I get banned for using this?**  
@@ -205,19 +253,36 @@ I think it's very unlikely that you'll get banned for using this. Most of the fe
 It's because not many browsers on Android support installing extensions (and not all extensions can be installed).
 
 3. **Why doesn't the xCloud website implement *this* or *that* feature from Better xCloud?**  
-For being an unofficial tool, **Better xCloud** has the luxury to implement anything on the xCloud website. On the xCloud's side, they have a lot more users and devices to support, so it's more difficult for them to implement a new feature. Also it's not easy to explain some of the features of **Better xCloud** to normal xCloud users.  
+Think of this project as an unofficial beta version of xCloud.  
+    - **Better xCloud** doesn't have to worry about the compatibility much: if it doesn't work on this browser, it can just suggest you switch to another one. xCloud can't do the same.  
+    - On the xCloud's side, they have a lot more users and devices to support, so it's more difficult for them to implement a new feature.  
+    - Also, it's not easy to explain some of the features of **Better xCloud** to normal xCloud users.  
 
 4. **Can I use this with the Xbox Android app?**  
 No, you can't. You'll have to modify the app.
 
 5. **Will it be able to enable the "Clarity Boost" feature on non-Edge browsers?**  
-No. The "Clarity Boost" feature uses an exclusive API (`Video.msVideoProcessing`) that's only available on Edge browser for desktop at the moment.
+~~No. The "Clarity Boost" feature uses an exclusive API (`Video.msVideoProcessing`) that's only available on Edge browser for desktop at the moment.~~  
+Fake news! This feature has been implemented in **Better xCloud** since version 1.12, but the original "Clarity Boost" still perform better.  
 
-6. **Will it be able to request a lower FPS or increase the maximum bitrate (15Mbps) of the stream?**  
-Sorry, no. The server decides all these settings.  
+7. **Will it be able to request a lower FPS or increase the maximum bitrate (15Mbps) of the stream?**  
+Sorry, no. The server decides all these settings.
 
-## User-Agent
-Moved to [wiki](https://github.com/redphx/better-xcloud/wiki/User‐Agent).
+8. **What's the meaning behind the name "Better xCloud"?**  
+It's a reference to an Userscript called "better360" that I created many years ago. I regret not choosing the name "xCloud Enhancement Suite", or XES for short.  
+
+## Translators
+  - **Portuguese (Brazilian)**: [@ricardo404](https://github.com/ricardo404), [@Haisom](https://github.com/Haisom)
+  - **Russian**: [anpom6](https://crowdin.com/profile/anpom6)
+  - **Turkish**: [@transbebek](https://github.com/transbebek)
+  - **Vietnamese**: [@redphx](https://github.com/redphx)
+
+Visit [here](https://crowdin.com/project/better-xcloud) if you want to translate **Better xCloud** to more languages.  
+Use [this post](https://github.com/redphx/better-xcloud/discussions/131) for discussion.  
+
+## Donation
+I'm doing this for fun, so you don't have to donate anything. You're already supporting me by using this script. Save that money toward your Xbox Game Pass Ultimate subscription 😄.  
+But if you still really want to donate, I have a [Ko-fi page](https://ko-fi.com/redphx). Thank you.
 
 ## Acknowledgements  
 - [n-thumann/xbox-cloud-server-selector](https://github.com/n-thumann/xbox-cloud-server-selector) for the idea of IPv6 feature

better-xcloud.meta.js

@@ -1,5 +1,5 @@
 // ==UserScript==
 // @name         Better xCloud
 // @namespace    https://github.com/redphx
-// @version      1.10.1
+// @version      1.17.1
 // ==/UserScript==