Version 1.13 (#105)

* Update README.md

* Bump version to 1.13

* Bump version to 1.13

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,21 @@
+---
+name: Bug report
+about: Create a report to help us improve
+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**
+...
+
+**Screenshots/Videos**
+If applicable, add screenshots/videos to help explain your problem.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,16 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[Feature] ..."
+labels: enhancement
+assignees: ''
+
+---
+
+**I'm using:**  
+- Device:
+- OS:
+- Browser:
+  
+**I want to suggest this feature:**  
+...

README.md

@@ -1,109 +1,293 @@
 # 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.  
+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) 
+-->
+
+## Table of Contents
+- [**Features**](#features)
+- [**How to install**](#how-to-install)
+- [**Compatibility**](#compatibility)
+- [**Stream stats**](#stream-stats)
+- [**Capture screenshot**](#capture-screenshot)
+- [**FAQ**](#faq)
+- [**Donation**](#donation)
+- [**Acknowledgements**](#acknowledgements)
+- [**Disclaimers**](#disclaimers)
 
-Give this project a 🌟 if you like it. Thank you 🙏.
 
 ## Features
 
-<img width="500" alt="Settings UI" src="https://github.com/redphx/better-xcloud/assets/96280/2f5b81f7-f739-4f8e-bb30-7b404fa35628">
-<img width="500" alt="Video Settings UI" src="https://github.com/redphx/better-xcloud/assets/96280/130aa870-6938-4604-9e23-45e217b800cc">
+<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/a8614693-7f56-4a49-82ad-c1fd7e2e00a5">
 
-- **Switch region of streaming server**  
-  > Connect to another server instead of the default one. Check [FAQ section](#faq) for some notes.
-- **Prefer IPv6 streaming server**
-  > Might reduce latency
-- **Force high quality stream**
-  > Force xCloud to use the best streaming codec profile (same as desktop & TV). You don't have to change User-Agent anymore.  
-  > Use more bandwitdh & battery.  
-  > Comparison video with the setting ON & OFF: https://youtu.be/-9PuBJJSgR4
-- **Disable bandwidth checking**
-  > xCloud won't reduce quality when the internet speed is slow
+
+&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**
+  > Exclusive to **Better xCloud**. Check the [**Capture screenshot** section](#capture-screenshot) for more info.
+- **🔥 Hold the "Quit game" button for one second to refresh the stream**
+  > Sometimes you can fix the bad connection to the stream simply by refreshing the page.  
+  > Useful on mobile where the pull-to-refresh feature doesn't work while playing.  
+- **🔥 Touch controller**
+  > Enable touch controller support for all games.
+
+### Server
+- **Set the region of streaming server**  
+  > 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
+- **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.  
+  > Comparison video with the setting ON & OFF: https://youtu.be/-9PuBJJSgR4  
+- **Disable bandwidth checking**  
+  > xCloud won't warn about slow connection speed.  
+- **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.  
+
+
+### 🔥 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.  
+  > &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**
+  > Hide the labels of the menu buttons.  
 - **Skip Xbox splash video**
-  > Save 3 seconds
-- **Hide Dots icon while playing**
-  > You can still click on it, but it doesn't block the screen anymore
+  > Save 3 seconds.
+- **Hide System menu's icon**
+  > You can still click on it, but it doesn't block the screen anymore.
 - **Reduce UI animations**
-  > Disable `transition` CSS property in some elements. The smooth scrolling cannot be disabled.
+  > Disable `transition` CSS property in some elements. The smooth scrolling cannot be disabled.  
+
+### Other  
+- **Disable social features**
+  > Features like friends, chat... Disable these will make the page load faster.  
+- **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
+
+- **🔥 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
-- **Disable social features**
-  > Features like friends, chat... Disable these will make the page load faster.
-- **Disable xCloud analytics**
-  > The analytics contains statistics of your streaming session, so I'd recommend to allow analytics to help Xbox improve xCloud's experence in the future.
+  > 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. Not working on [some browsers](https://caniuse.com/battery-status).  
+  > Estimated total data sent/received.  
+
+### Advanced features  
+- **Change User-Agent**
+  > Useful when you're using unsupported browsers.  
+  > This setting only affects xCloud, and it doesn't change browser's global User-Agent.  
+  > 📝 If you get 404 error after using this feature, try refreshing the page a few times. See [#34](https://github.com/redphx/better-xcloud/issues/34).  
 - **Hide footer and other UI elements**
 
-## How to use
-1. Install [Tampermonkey extension](https://www.tampermonkey.net/) on suppported browsers. It's also available for Firefox on Android.
+<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 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)  
-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.  
-6. Don't forget to enable auto updating for the script in Tampermonkey.
+    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).
 
+⚠️⚠️⚠️ 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.
+
+### 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          | iOS             |
-|----------------------------------------|------------------|------------------|-----------------|
-| Chrome/Edge/Chromium variants          | ✅               | ❌               | ❌               |
-| Firefox                                | ✅               | ✅               | ❌               |
-| Safari                                 | ✅<sup>(1)</sup> | ❌               | ✅<sup>(2)</sup> |
-| [Hermit](https://hermit.chimbori.com)  | ❌               | ⚠️<sup>(3)</sup> | ❌               |
+|                                         | 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, 2</sup> Requires [Userscripts app](https://apps.apple.com/us/app/userscripts/id1463298887).  
-<sup>3</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). It's still my favorite app to play xCloud on because it's lightweight, supports Userscript (premium features, only $1.99) without having to install anything else. I built **Better xCloud** just so I could use it with Hermit.  
+<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.  
+<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  
+
+![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/0d4abb6b-49ab-4c9a-a52d-df7e396d2145">
+
+- While playing > `...` > `Stream Stats`.
+- Double-click on the stats bar to show the Settings dialog.
+- This bar is updated every second.  
+- **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)                                        |
+| 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)                |
+| 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)) |
+| 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`  
+- Firefox: `about:webrtc`
+
+Colors:  
+- Red = Bad
+- Yellow = Okay
+- Green = Good
+- White = Great
+
+⚠️ Having this info on all the time will drain the battery faster, so I'd recommend only using it when having network problems.  
+
+## Capture screenshot  
+- This feature is only available in **Better xCloud**.  
+- Works on both desktop & mobile, but it was designed for mobile users.
+- It's client-side only.
+- It captures the current frame of the stream and saves it to a file. That means you won't get the raw quality like when you play on a console, but it's still better than using the built-in screenshot feature on your phone.  
+- Screenshot's resolution & quality depend on the quality of the stream at the moment.  
+- Screenshot doesn't include touch UI, notification bar... only the gameplay.  
+- There might be a slight delay.  
+- ⚠️ It's not possible to map the Share/Screenshot button on your controller to this feature.  
+
+### How to capture screenshot  
+1. Enable this feature in the Settings.
+2. Play a game.
+3. Tap once at the bottom left/right (depending on your setting) to show the Screenshot button.
+4. Tap on that button to capture screenshot.
+5. Screenshot will be saved by the browser.
+6. You can double-tap that corner to capture screenshot.
+
+![screenshot](https://github.com/redphx/better-xcloud/assets/96280/b277193e-df94-4d72-b75c-3f728c984974)
 
 ## FAQ
 1. **Will I get banned for using this?**  
-I think it's very unlikely that you'll get banned for using this. Most of the features only affect client-side, except for switching region of streaming server (you'll connect to another server instead of the default one). If you want to be safe just avoid using that. As always, use as your own risk.
+I think it's very unlikely that you'll get banned for using this. Most of the features only affect client-side, except for switching region of streaming server (you'll connect to another server instead of the default one). If you want to be safe just avoid using that. As always, use it as your own risk.
 
-2. **Why is it an Userscript and not extension?**  
+2. **Why is it an Userscript and not an extension?**  
 It's because not many browsers on Android support installing extensions (and not all extensions can be installed).
 
-3. **I see "???" button instead of server's name**  
-That means Tampermonkey is not working properly. Please make sure you're using the latest version or switch to a well-known browser.  
+3. **Why doesn't the xCloud website implement *this* or *that* feature from Better xCloud?**  
+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.
+No, you can't. You'll have to modify the app.
 
-5. **Will you able to enable "Clarity Boost" feature on non-Edge browsers?**  
-No. "Clarity Boost" feature uses an exclusive API (`Video.msVideoProcessing`) that's only available on Edge browser for desktop at the moment.
+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.~~  
+Fake news! This feature has been implemented in **Better xCloud** since version 1.12, but the original "Clarity Boost" still perform better.  
+
+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.
+
+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
+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 😄.
 
 ## User-Agent
-You're no longer needed to change User-Agent since you can just use the **Force high quality stream** setting.  
-If your browser doesn't support **Force high quality stream** setting, try changing User-Agent to:  
-```
-Mozilla/5.0 (SMART-TV; LINUX; Tizen 7.0) AppleWebKit/537.36 (KHTML, like Gecko) 94.0.4606.31/7.0 TV Safari/537.36
-```
-This will change your device to a Samsung TV running Tizen OS. It will improve the stream quality.  
-
----
-Change User-Agent to:
-```
-Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36 Edg/114.0.1823.67
-```
-This will trick xCloud into thinking you're using Edge browser on desktop.
-
-Other options (only do one of these):
-- Add ` smarttv` to switch to Smart TV layout.
-- Add ` Xbox;` to become an Xbox console.
-- Add ` 36102dd3-6953-45f6-8b48-031fb95e0e0d` to become a Logitech G Cloud device.
-- Add ` 0ed22b6f-b61d-41eb-810a-a1ed586a550b` to become a Razer Edge device.
+Moved to [wiki](https://github.com/redphx/better-xcloud/wiki/User‐Agent).
 
 ## Acknowledgements  
 - [n-thumann/xbox-cloud-server-selector](https://github.com/n-thumann/xbox-cloud-server-selector) for the idea of IPv6 feature
-- Icons by [Adam Design](https://www.iconfinder.com/iconsets/user-interface-outline-27)
+- Icons by [Phosphor Icons](https://phosphoricons.com)
 
 ## Disclaimers  
-- Use as your own risk.  
+- Use as it your own risk.  
 - This project is not affiliated with Xbox in any way. All Xbox logos/icons/trademarks are copyright of their respective owners.

better-xcloud.meta.js

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