Bump version to 3.0.5

* Add initial support for MKB

* Refactor icons

* Enable native MKB support for some games

* Move Stream settings & stats buttons to Stream HUD bar

* Split stream settings into tabs

* Use bx-gone class to show/hide Settings sidebar

* Update translations

* Update Toast class

* Press F9 to toggle MKB feature

* Disable Gamepad Disconnected screen

* Change from F9 key to F8 key

* Reverse back to F9 key + disable "disableGamepadDisconnectedScreen" patch

* Fix "disableGamepadDisconnectedScreen" patch

* Add fade in/out animations for Toast

* Fix Settings tabs not showing

* Fix touch controller not showing sometimes

* Add basic remapping screen

* Update MKB layout

* Add edit/save states

* Add borders to highlight Quick Settings tabs

* Get key name from key code

* Move the Dots button to the beginning

* Disable non-working native MKB games

* Optimize Patcher class: only apply "playing" patches when needed

* Refactor renderMkbSettings() to MkbRemapper class

* Refactor the rendering process of MkbRemapper

* Implement new method to control analog stick using mouse

Heavily inspired by Yuzu's "Mouse panning" feature

* Update README.md

* Refactor setting elements

* Reduce button prompt's font size

* Render mouse settings

* Add a warning in MKB remapper

* Update preset's structure

* Disable "contextmenu" event of dialog & its overlay

* Fix bug in MkbPreset.convert()

* Detect scrolling events while binding

* Convert wheel events to button press

* Fix minor bugs in Stream settings

* Fix RT mapping

* Add setValue() method to SettingElement

* Update preset after binding new key

* Update preset after changing mouse's settings

* Update UI of mouse's settings

* Update style

* Fixed action buttons at the bottom

* Add support for "exactTicks" param to Number Stepper element

* Don't render first & last markers

* Add basic LocalDb class

* Allow switching between presets

* Enable/disable elements when editing preset

* Update translations

* Refactor code

* Define  "CE = createElement" globally

* Add createButton()

* Add icons to buttons

* Implement the "Cancel" button

* Implement the "Rename" button

* Add styling for disabled buttons

* Implement "New" & "Copy" buttons

* Implement "Delete" button

* Refactor code

* Fix exception when creating Default preset

* Set default name when copying preset

* Implement "Save" button

* Implement "Activate" button

* Implement switching preset data

* Pre-calculate mouse's sensitivities + fix not converting preset before using

* Fix mouse buttons not working

* Remove "not working" line

* Show "right-click-to-unbind" text

* Bug fixes

* Add ENABLE_NATIVE_MKB_BETA flag

* Update styling

* Add mention to Yuzu emu

* Pre-calculate mouse's sensitivities in MkbPreset.convert()

* Update translations

* Add donation link

* Update translations

* Add "Map mouse to" setting

* Fix styling

* Bug fixes

* Implement requestPointerLock()

* Hide pointerLock message when StreamMenu is being shown

* Fix bugs in Chrome

* Fix a bug causing Remote Play not working

* Remove "Disable bandwidth checking" feature as it's useless

* Update README.md

* Update styling

* Add URL to document

* Temporary disable the "Controller shortcuts" feature as it conflicts with the MKB feature

* Update translations

* Update README.md

.github/FUNDING.yml

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

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,33 +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):**
- - OS: [e.g. Android]
- - Browser: [e.g. chrome, firefox]
- - 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:**  
+...

LICENSE

@@ -1,6 +1,7 @@
 MIT License
 
 Copyright (c) 2023 redphx
+Copyright (c) 2020 Phosphor Icons
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,3 +20,5 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+---

README.md

@@ -1,170 +1,78 @@
 # 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.
+Improve Xbox Cloud Gaming (xCloud) experience on [xbox.com/play](https://www.xbox.com/play). It also allows you to use Remote Play on the xCloud website.  
 
-Give this project a 🌟 if you like it. Thank you 🙏.
+**Supported platforms:**  
+- Windows
+- macOS
+- Linux, SteamOS (including Steam Deck)
+- Android, Android TV (including Meta Quest VR Headsets)
+- iOS, iPadOS
+
+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 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)  
 
+## Full documentations
+For the full details please visit: https://better-xcloud.github.io  
+
+⚠️ Please DO NOT report **Better xCloud**'s bugs on [/r/xcloud subreddit](https://reddit.com/r/xcloud/). Report bugs in [Issues](https://github.com/redphx/better-xcloud/issues) or [Telegram channel](https://t.me/betterxcloud) instead.
+
+## Table of Contents
+- [**How to install**](#how-to-install)
+- [**Features**](#features)
+- [**Donation**](#donation)
+- [**Acknowledgements**](#acknowledgements)
+- [**Disclaimers**](#disclaimers)
+
+## How to install
+Visit [this page](https://better-xcloud.github.io/browsers) to know how to install Better xCloud on your device.
+
 ## 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/4bec2d62-31df-499c-9aad-2485626b6925">
+<br>
+<img width="400" alt="Remote Play dialog" src="https://github.com/redphx/better-xcloud/assets/96280/daf7f698-a228-4f9c-8f23-9669e061a64c">
+<br>
+<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="Stream settings" src="https://github.com/redphx/better-xcloud/assets/96280/ed513cb3-6e6c-4e8e-9e06-c62e71e41c90">
+<br>
+<img width="600" alt="Remapper" src="https://github.com/redphx/better-xcloud/assets/96280/f2e2bc51-f673-4b24-b127-c7169b86462b">
 
-<img width="475" alt="Stream HUD UI" src="https://github.com/redphx/better-xcloud/assets/96280/ff695d3a-b077-4b21-b778-beb0a1fdd6be">  
 
 &nbsp;  
   
-**Demo video:** https://youtu.be/oDr5Eddp55E  
+**Demo video:** [https://youtu.be/oDr5Eddp55E  ](https://youtu.be/AYb-EUcz72U)  
+- **🔥 Totally free and open-source**
+- **🔥 Allow playing with [Mouse & Keyboard](https://better-xcloud.github.io/mouse-and-keyboard)**
+- **🔥 Enable [Remote Play](https://better-xcloud.github.io/remote-play) support**  
+  > 1080p resolution and can stream Xbox 360 games.  
+- **🔥 [Improve visual quality](https://better-xcloud.github.io/ingame-features/#improve-streams-clarity) 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](https://better-xcloud.github.io/stream-stats)**  
+- **🔥 [Screenshot capture](https://better-xcloud.github.io/screenshot-capture)**
+- **🔥 [Touch controller](https://better-xcloud.github.io/features/#touch-controller)**
+  > Enable touch controller support for all games.
+- [And more...](https://better-xcloud.github.io/features/)
 
-- **Switch region of streaming server**  
-  > Connect to another server instead of the default one. Check the [**FAQ** section](#faq) for some notes.  
-- **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.
-- **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
-- **Reduce UI animations**
-  > Disable `transition` CSS property in some elements. The smooth scrolling cannot be disabled.
-- **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...
-- **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.  
-- **Hide footer and other UI elements**
-- **🔥 Show stream stats**
-  > Check [Stream stats section](#stream-stats) for more info.  
+## Donation
+If you think this project is useful and want to support future developments, please consider making a donate via [my Ko-fi page](https://ko-fi.com/redphx).  
+Or you can give this project a star, that's also helpful.  
+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.  
-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.
-
-To update manually, just install the script again (you won't lose your settings).
-
-## 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/70f4b1bb-4e3d-4f27-9b2f-afcfe1b8b261">
-  
-- 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                                                                                                                            |
-|------:|:-------------------|:-----------------------------------------------------------------------------------------------------------------------------------|
-| 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)                         |
-| DT    | Decode Time        | The average time it took to decode one frame in the last second (might be bugged)                                                  |
-| 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`  
-- Firefox: `about:webrtc`
-
-Colors:  
-- Red = Bad
-- Yellow = Okay
-- 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.
-
-
-## 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.
-
-<img width="600" alt="Screenshot button" src="https://github.com/redphx/better-xcloud/assets/96280/a911b141-5dc0-450a-aeac-30d9cf202b44">
-
-## 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 it as your own risk.
-
-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**  
-That means Tampermonkey is not working properly. Please make sure you're using the latest version or switch to a well-known browser.  
-
-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?**  
-No. The "Clarity Boost" feature uses an exclusive API (`Video.msVideoProcessing`) that's only available on Edge browser for desktop at the moment.
-
-## User-Agent
-Moved to [wiki](https://github.com/redphx/better-xcloud/wiki/User‐Agent).
+## Translation  
+Help translating **Better xCloud** to another languagues using [Crowdin](https://crowdin.com/project/better-xcloud).  
+Use [this post](https://github.com/redphx/better-xcloud/discussions/131) for discussion. 
 
 ## Acknowledgements  
+- The mouse controlling feature is heavily inspired by the "Mouse spinning" feature in [Yuzu emulator](https://github.com/yuzu-emu/yuzu-mainline)
 - [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)
+- [PromptFont](https://shinmera.com/promptfont) by Yukari "Shinmera" Hafner
 
 ## Disclaimers  
-- Use as it your own risk.  
+- Use it at 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

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