Version 1.14 (#116)

* Update README.md

* Update better-xcloud.meta.js

* Bump version to 1.14

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,18 +1,18 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: "[Bug]"
+title: "[Bug] ..."
 labels: bug
 assignees: ''
 
 ---
 
 **Platform**
- - Device: [e.g. Phone, Laptop, Desktop, TV]
- - OS: [e.g. Windows, Android, iOS]
- - Browser: [e.g. Chrome, Kiwi]
- - Browser Version: [e.g. 100]
- - Better xCloud Version: [e.g. 1.10]
+ - Device: Phone, Laptop, Desktop, TV...
+ - OS: Windows, Android, iOS...
+ - Browser: Chrome, Safari, Kiwi...
+ - Browser Version:
+ - Better xCloud Version:
 
 **Describe the bug**
 ...

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,7 +1,7 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: "[Feature]"
+title: "[Feature] ..."
 labels: enhancement
 assignees: ''
 

README.md

@@ -25,17 +25,19 @@ If you like this project please give it a 🌟. Thank you 🙏.
 
 ## Features
 
-<img width="400" alt="Settings UI" src="https://github.com/redphx/better-xcloud/assets/96280/65ee4193-c31d-46fb-b580-196614246ee6">
-
+<img width="400" alt="Settings UI" src="https://github.com/redphx/better-xcloud/assets/96280/0eedde97-74c7-44df-bc89-2ebf8edb6e2c">
 <br>
 <img width="600" alt="Stream HUD" src="https://github.com/redphx/better-xcloud/assets/96280/e30f6514-13ca-41c6-bff2-979573cff956">
 <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="Video settings" src="https://github.com/redphx/better-xcloud/assets/96280/a8614693-7f56-4a49-82ad-c1fd7e2e00a5">
+
 
 &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**
@@ -48,7 +50,9 @@ If you like this project please give it a 🌟. 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**
@@ -74,18 +78,34 @@ If you like this project please give it a 🌟. Thank you 🙏.
 
 ### 🔥 Touch controller
 - **Availability**
-  > Only for devices with touch support (Android/iOS/iPadOS/...).  
+  > 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)
+  > &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.
+  > Don't be mad when the estimated time is inaccurate.  
+  > 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">
+
 
 ### UI
 - **Simplify Stream's menu**
@@ -104,12 +124,22 @@ If you like this project please give it a 🌟. Thank you 🙏.
   > 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)).  
+
+- **🔥 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**
   > Useful when you don't have a 16:9 screen
 - **Adjust video filters**
   > 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.  
@@ -126,7 +156,7 @@ If you like this project please give it a 🌟. 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 install
-1. Install [Tampermonkey extension](https://www.tampermonkey.net/) on suppported browsers. For Safari, use [Userscripts app](https://apps.apple.com/us/app/userscripts/id1463298887) (not working properly, see [#81](https://github.com/redphx/better-xcloud/issues/81)).  
+1. Install [Tampermonkey extension](https://www.tampermonkey.net/) on suppported browsers. For Safari, use the [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).  
 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)  
@@ -170,7 +200,10 @@ Don't see your browser in the table? If it supports Tampermonkey/Userscript then
 - **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.
@@ -179,10 +212,10 @@ Don't see your browser in the table? If it supports Tampermonkey/Userscript then
 - ⚠️ Using **Better xCloud** or showing the stats bar also affects the performance of the stream.  
 
 | 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 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                                       |
@@ -217,7 +250,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?**  
@@ -236,12 +269,13 @@ Think of this project as an unofficial beta version of xCloud.
 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?**  
+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.
 
-7. **What's the meaning behind the name "Better xCloud"?**  
+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.  
 
 ## Donation

better-xcloud.meta.js

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