Version 1.11 (#91)

* Update README.md

* Bump version to 1.11

* Bump version to 1.11

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,27 +7,15 @@ assignees: ''
 
 ---
 
-**Describe the bug**
+**Platform**
-A clear and concise description of what the bug is.
+ - Device: [e.g. Phone, Laptop, Desktop, TV]
-
+ - OS: [e.g. Windows, Android, iOS]
-**To Reproduce**
+ - Browser: [e.g. Chrome, Kiwi]
-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):**
- - OS: [e.g. Android]
- - Browser: [e.g. chrome, firefox]
  - Browser Version: [e.g. 100]
-- Better xCloud Version: [e.g. 1.4]
+ - Better xCloud Version: [e.g. 1.10]
 
-**Additional context**
+**Describe the bug**
-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

@@ -7,14 +7,10 @@ assignees: ''
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
+**I'm using:**  
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+- Device:
-
+- OS:
-**Describe the solution you'd like**
+- Browser:
-A clear and concise description of what you want to happen.
+  
-
+**I want to suggest this feature:**  
-**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.

README.md

@@ -1,9 +1,9 @@
 # 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)  
@@ -11,17 +11,30 @@ Give this project a 🌟 if you like it. Thank you 🙏.
 [![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)
+
 
 ## Features
 
-<img width="475" alt="Settings UI" src="https://github.com/redphx/better-xcloud/assets/96280/f4187ef8-fa10-4eab-b085-ef3c3aed3201">
+<img width="400" alt="Settings UI" src="https://github.com/redphx/better-xcloud/assets/96280/65ee4193-c31d-46fb-b580-196614246ee6">
-
-<img width="475" alt="Stream HUD UI" src="https://github.com/redphx/better-xcloud/assets/96280/68f91041-10b2-4fd9-adc1-e2a21db7e36f">
 
+<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">
 
 &nbsp;  
   
-**Demo video:** https://youtu.be/oDr5Eddp55E  
+**Demo video:** [https://youtu.be/oDr5Eddp55E  ](https://youtu.be/AYb-EUcz72U)  
 
 - **🔥 Show stream stats**  
   > Check [Stream stats section](#stream-stats) for more info.  
@@ -30,33 +43,69 @@ Give this project a 🌟 if you like it. Thank you 🙏.
 - **🔥 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.  
-- **Switch region of streaming server**  
+- **🔥 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. Check the [**FAQ** section](#faq) for some notes.
 - **Preferred game's language**
   > If the game doesn't support this language, it will use the same language as xCloud's website.  
-- **Stream's target resolution**
+- **Prefer IPv6 server**
-  > Set stream's resolution.  
+  > 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 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 the [changing User-Agent method](https://github.com/redphx/better-xcloud/wiki/User‐Agent) instead.  
+  > Not available for some browsers (Firefox, Safari...).  
   > Use more bandwidth & battery.  
   > Comparison video with the setting ON & OFF: https://youtu.be/-9PuBJJSgR4  
-- **Prefer IPv6 streaming server**
-  > Might reduce latency.
 - **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/...).  
+  > - **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)
+- **Button styles**
+  > - Default  
+  > - Muted  
+  > - All white (only for standard/default controller)
+  > <img width="400" alt="Button styles" src="https://github.com/redphx/better-xcloud/assets/96280/2bfef2b3-6712-4924-b067-c2312f8c8062">
+
+
+### UI
+- **Simplify Stream's menu**
+  > Hide the labels of the menu buttons.  
 - **Skip Xbox splash video**
   > Save 3 seconds.
-- **Hide Dots icon while playing**
+- **Hide System menu's icon**
   > You can still click on it, but it doesn't block the screen anymore.
-- **Disable touch controller**
+- **Reduce UI animations**
-  > Stop the touch controller from showing when touching the screen.  
+  > Disable `transition` CSS property in some elements. The smooth scrolling cannot be disabled.  
-  > Useful when you play on a device with a built-in controller like Logitech G Cloud, Steam Deck, Retroid, etc.
+
-- **Hide mouse cursor while playing**  
+### Other  
-  > Hide the mouse cursor after 3 seconds of not moving.  
+- **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
+⚠️ These features don't work when xCloud's "Clarity Boost" feature is ON ([#64](https://github.com/redphx/better-xcloud/issues/64)).  
+
 - **Stretch video to full sctreen**
   > Useful when you don't have a 16:9 screen
 - **Adjust video filters**
@@ -64,34 +113,33 @@ Give this project a 🌟 if you like it. Thank you 🙏.
 - **Display stream's statuses**
   > Region/Server/Codecs/Resolution...  
   > Current playtime of the session.  
-  > Current battery level. Only visible on battery-powered devices.  
+  > Current battery level. Not working on [some browsers](https://caniuse.com/battery-status).  
-- **Disable social features**
+  > Estimated total data sent/received.  
-  > Features like friends, chat... Disable these will make the page load faster.  
+
-- **Disable xCloud analytics**
+### Advanced features  
-  > The analytics contains statistics of your streaming session, so I'd recommend allowing analytics to help Xbox improve xCloud's experience in the future.
 - **Change User-Agent**
   > Useful when you're using unsupported browsers.  
-  > If you're on Safari, changing User-Agent to "Edge on Windows" will allow you to use Mic feature.  
   > 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).  
-- **Reduce UI animations**
-  > Disable `transition` CSS property in some elements. The smooth scrolling cannot be disabled.  
 - **Hide footer and other UI elements**
 
 <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
+## How to install
-1. Install [Tampermonkey extension](https://www.tampermonkey.net/) on suppported browsers.  
+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)).  
 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/).
+    I only distribute **Better xCloud** on GitHub, *DO NOT* download it on other websites or from unknown sources.  
-5. Click on the new "SERVER NAME" button next to your profile picture to adjust settings.  
+3. Refresh [xCloud web page](https://www.xbox.com/play/).
-6. Don't forget to enable auto updating for the script in Tampermonkey.
+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'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)
@@ -114,29 +162,30 @@ If you still have trouble installing **Better xCloud**, you can follow one of th
 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>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).  
+- **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/70f4b1bb-4e3d-4f27-9b2f-afcfe1b8b261">
+<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 Settings dialog.  
+- 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                                                                                                                            |
+| Abbr. | Full name          | Explain                                                                                                                                    |
-|------:|:-------------------|:-----------------------------------------------------------------------------------------------------------------------------------|
+|------:|:-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------|
-| FPS   | Frames per Seconds | The number of decoded frames in the last second of the stream (equal to or lower than the FPS of the game)                         |
+| 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 (might be bugged [#26](https://github.com/redphx/better-xcloud/issues/26))                                                  |
+| 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) |
+| 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                                                               |
+| 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                                                                                                   |
+| 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                        |
+| 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`  
@@ -177,21 +226,33 @@ I think it's very unlikely that you'll get banned for using this. Most of the fe
 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 the server's name**  
+3. **Why doesn't the xCloud website implement *this* or *that* feature from Better xCloud?**  
-That means Tampermonkey is not working properly. Please make sure you're using the latest version or switch to a well-known browser.  
+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 you be able to enable the "Clarity Boost" feature on non-Edge browsers?**  
+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.
 
+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. **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
 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 it your own risk.  

better-xcloud.meta.js

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