Update README.md

* Update README.md

* Fix sometimes the touch controller layout doesn't show at the beginning

* Restore GAME_TITLE_ID

* Update README.md

* Bump version to 1.10

* Bump version to 1.10

.github/ISSUE_TEMPLATE/bug_report.md

@@ -24,10 +24,11 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Platform (please complete the following information):**
- - OS: [e.g. Android]
+ - Device: [e.g. Phone/Laptop/Desktop/TV]  
- - Browser: [e.g. chrome, firefox]
+ - OS: [e.g. Android]  
- - Browser Version: [e.g. 100]
+ - Browser: [e.g. Chrome, Kiwi]  
-- Better xCloud Version: [e.g. 1.4]
+ - Browser Version: [e.g. 100]  
+- Better xCloud Version: [e.g. 1.4]  
 
 **Additional context**
 Add any other context about the problem here.

README.md

@@ -2,72 +2,124 @@
 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.
 
+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 🙏.
 
 [![Latest version](https://img.shields.io/github/v/release/redphx/better-xcloud?label=latest)](https://github.com/redphx/better-xcloud/releases) 
-[![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)  
+<!--
+[![Total downloads](https://img.shields.io/github/downloads/redphx/better-xcloud/total?color=%23e15f2c)](https://github.com/redphx/better-xcloud/releases) 
+-->
+
 
 ## Features
 
-<img width="475" alt="Settings UI" src="https://github.com/redphx/better-xcloud/assets/96280/20aca05d-ff20-4adb-ac21-08b4b1cfd07f">
+<img width="400" alt="Settings UI" src="https://github.com/redphx/better-xcloud/assets/96280/6e74fdaf-dc84-416a-a2bc-5e117a3717e3">
-
+<br>
-<img width="475" alt="Stream HUD UI" src="https://github.com/redphx/better-xcloud/assets/96280/ff695d3a-b077-4b21-b778-beb0a1fdd6be">  
+<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)  
 
-- **Switch region of streaming server**  
+- **🔥 Show stream stats**  
-  > Connect to another server instead of the default one. Check the [**FAQ** section](#faq) for some notes.  
+  > Check [Stream stats section](#stream-stats) for more info.  
-- **Force 1080p stream**
-  > By default you only get 1080p stream when playing on desktop.  
-  > This feature will give you 1080p stream even on mobile, without having to change User-Agent.  
-- **Force high quality codec (if possible)<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.  
-  > 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.  
 - **🔥 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. 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.  
+- **Prefer IPv6 server**
+  > Might reduce latency.
+
+### Stream quality
+- **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.  
+
+### Controller
+- **🔥 Touch controller**
+  > Only for mobile (Android/iOS/iPadOS).  
+  > - **Default**: nothing change.  
+  > - **All games**: enable touch controller support for all games. Games with custom layout won't be affected.  
+  > - **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.  
+- **Hide mouse cursor on idle**  
+  > Hide the mouse cursor after 3 seconds of not moving.  
+
+### 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
+  > 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
+⚠️ 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**
   > Brightness/Contrast/Saturation.
 - **Display stream's statuses**
-  > Region/Server/Quality/Resolution...
+  > Region/Server/Codecs/Resolution...  
-- **Disable social features**
+  > Current playtime of the session.  
-  > Features like friends, chat... Disable these will make the page load faster.  
+  > Current battery level.  
-- **Disable xCloud analytics**
+  > Estimated total data sent/received.  
-  > The analytics contains statistics of your streaming session, so I'd recommend allowing analytics to help Xbox improve xCloud's experience in the future.  
+
+### 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**
-- **🔥 Show stream stats**
-  > Check [Stream stats section](#stream-stats) for more info.  
 
 <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.  
+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)  
-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 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  
@@ -93,21 +145,22 @@ 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/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.  
-- This bar is updated every second.  
-- Showing the stats bar does affect the performance of the stream.  
 
-| Abbr. | Full name          | Explain                                                                                                                            |
+- While playing > `...` > `Stream Stats`.
-|------:|:-------------------|:-----------------------------------------------------------------------------------------------------------------------------------|
+- Double-click on the stats bar to show the Settings dialog.
-| 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)                         |
+- This bar is updated every second.  
-| DT    | Decode Time        | The average time it took to decode one frame in the last second (might be bugged)                                                  |
+- **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.  
-| 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) |
+- ⚠️ Using **Better xCloud** or showing the stats bar also affects the performance of the stream.  
-| 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                                                                                                   |
+| Abbr. | Full name          | Explain                                                                                                                                    |
-| FL    | Frames Lost        | The total number of frames dropped prior to decode or dropped because the frame missed its display deadline                        |
+|------:|:-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------|
+| 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                                |
 
 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`  
@@ -119,8 +172,7 @@ Colors:
 - Green = Good
 - White = Great
 
-📝 Having this info on all the time might reduce your enjoyment, so I'd recommend only using it when having network problems.
+⚠️ 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**.  
@@ -149,21 +201,24 @@ 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.  
+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.  
 
 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.  
+
 ## 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.6.2
+// @version      1.10
 // ==/UserScript==