mirror of
https://github.com/redphx/better-xcloud.git
synced 2025-06-28 18:31:44 +02:00
Compare commits
57 Commits
Author | SHA1 | Date | |
---|---|---|---|
9d7c537eaa | |||
eccd306d03 | |||
e15afd2396 | |||
f0dbc72987 | |||
25bf6c209d | |||
f229dbdbe4 | |||
e845c902b2 | |||
c424c6f94b | |||
1619fb2b26 | |||
d72641ba77 | |||
7c3f00f277 | |||
9bd0ee9097 | |||
a9bb977311 | |||
3e0653fadf | |||
36f6b04ad9 | |||
60b70e259b | |||
c50e0d6aff | |||
a3fd3c9ebe | |||
c47caea65e | |||
6f540cca7a | |||
7a202ba8a7 | |||
1f787b7888 | |||
0cc96135c9 | |||
ed2fb13e17 | |||
b91474c20b | |||
18eec8b8da | |||
949a180047 | |||
c9a67cf6b7 | |||
b469ba4867 | |||
a0d0d6e1e6 | |||
cc466ff2ac | |||
b1bfe96935 | |||
241be49d09 | |||
7c48b7e6fb | |||
cc9a644a5e | |||
a77db68afb | |||
cd7a7c92c7 | |||
651402a6b4 | |||
6cd2648325 | |||
fa0d761d24 | |||
f01d7a3b0b | |||
b520e8173e | |||
f15f43faf7 | |||
e470cb20a3 | |||
d1882046e2 | |||
fb7bd2da0d | |||
d9a14f9d83 | |||
18dd006aad | |||
f74de11e10 | |||
2a71e17d2d | |||
2a85dd574e | |||
9692286f1e | |||
26498efa7c | |||
d1c724ff2c | |||
eec41c58b6 | |||
38cc78e0da | |||
3cf029818e |
1
.github/FUNDING.yml
vendored
Normal file
1
.github/FUNDING.yml
vendored
Normal file
@ -0,0 +1 @@
|
||||
ko_fi: redphx
|
153
README.md
153
README.md
@ -2,35 +2,76 @@
|
||||
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.
|
||||
|
||||
Supported platforms:
|
||||
- Windows, macOS, Linux
|
||||
- Android, Android TV
|
||||
- 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 🙏.
|
||||
|
||||
[](https://github.com/redphx/better-xcloud/releases)
|
||||
[](https://github.com/redphx/better-xcloud/stargazers)
|
||||
<!--
|
||||
[](https://github.com/redphx/better-xcloud/releases)
|
||||
-->
|
||||
[](https://github.com/redphx/better-xcloud/stargazers)
|
||||
|
||||
|
||||
## Table of Contents
|
||||
- [**Features**](#features)
|
||||
- [**How to install**](#how-to-install)
|
||||
- [**Compatibility**](#compatibility)
|
||||
- [**Features**](#features)
|
||||
- [**Stream stats**](#stream-stats)
|
||||
- [**Capture screenshot**](#capture-screenshot)
|
||||
- [**FAQ**](#faq)
|
||||
- [**Translators**](#translators)
|
||||
- [**Donation**](#donation)
|
||||
- [**Acknowledgements**](#acknowledgements)
|
||||
- [**Disclaimers**](#disclaimers)
|
||||
|
||||
## How to install
|
||||
1. Install an userscript extension:
|
||||
- **Safari**: Install [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.
|
||||
- **All other browsers**: Install [Tampermonkey extension](https://www.tampermonkey.net/).
|
||||
3. 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)-->
|
||||
I only distribute **Better xCloud** on GitHub, *DO NOT* download it on other websites or from unknown sources.
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
## Compatibility
|
||||
- 👍 = best choice, all features work as intended
|
||||
- ✅ = confirmed to be working, might miss some features
|
||||
- ❌ = not supported (mostly because of lacking Userscript/extension support)
|
||||
- ➖ = unavailable
|
||||
- 🗒️ = see custom notes
|
||||
|
||||
| | Windows/Linux | macOS | Android/Android TV | iOS |
|
||||
|-----------------------------------------|:-----------------|:-----------------|:-------------------|:-----------------|
|
||||
| Chrome/Edge/Chromium variants | 👍 | 👍 | ❌ | ❌ |
|
||||
| Firefox | ✅ | ✅ | 🗒️<sup>(1)</sup> | ❌ |
|
||||
| Safari | ➖ | ✅<sup>(2)</sup> | ➖ | ✅<sup>(3)</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). Check [this page](https://github.com/redphx/better-xcloud/wiki/Using-with-Safari) before using.
|
||||
|
||||
---
|
||||
- **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.
|
||||
|
||||
## Features
|
||||
|
||||
<img width="400" alt="Settings UI" src="https://github.com/redphx/better-xcloud/assets/96280/0eedde97-74c7-44df-bc89-2ebf8edb6e2c">
|
||||
<img width="400" alt="Settings UI" src="https://github.com/redphx/better-xcloud/assets/96280/8baddcfa-b528-4ba7-9392-7b5fe60cea11">
|
||||
<br>
|
||||
<img width="600" alt="Stream HUD" src="https://github.com/redphx/better-xcloud/assets/96280/e30f6514-13ca-41c6-bff2-979573cff956">
|
||||
<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="Video settings" src="https://github.com/redphx/better-xcloud/assets/96280/a8614693-7f56-4a49-82ad-c1fd7e2e00a5">
|
||||
|
||||
<img width="600" alt="Stream settings" src="https://github.com/redphx/better-xcloud/assets/96280/18ed4598-4eca-4626-9434-5f74266b00e7">
|
||||
|
||||
|
||||
|
||||
@ -62,14 +103,14 @@ If you like this project please give it a 🌟. Thank you 🙏.
|
||||
- **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.
|
||||
- **Change visual quality**
|
||||
> Increase/decrease the quality of the stream to your liking. Only works in Chrome/Edge/Kiwi...
|
||||
> Comparison video with the setting ON & OFF: https://youtu.be/-9PuBJJSgR4
|
||||
- **Disable bandwidth checking**
|
||||
> xCloud won't warn about slow connection speed.
|
||||
> xCloud won't warn about slow connection speed.
|
||||
- **Enable volume control feature**
|
||||
> Allow increasing stream's volume up to 600%
|
||||
> ⚠️ Disable this setting if you experience slowdown, choppy/muted stream
|
||||
- **Enable microphone on game launch**
|
||||
> Automatically enable the mic when starting to play a game.
|
||||
- **Hide mouse cursor on idle**
|
||||
@ -93,14 +134,13 @@ If you like this project please give it a 🌟. Thank you 🙏.
|
||||
> <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
|
||||
- **Show game art**
|
||||
> Replace the black background with game art if it's available.
|
||||
- Show the estimated wait time
|
||||
- **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.
|
||||
> It's not 100% correct: you might get in the game sooner or later.
|
||||
> Check [#51](https://github.com/redphx/better-xcloud/issues/51) for more info.
|
||||
- Show/hide the rocket animation
|
||||
- **Show/hide the rocket animation**
|
||||
> Always show/Hide when queuing/Always hide.
|
||||
> Hide this animation might save some battery life while queuing.
|
||||
|
||||
@ -123,8 +163,10 @@ If you like this project please give it a 🌟. Thank you 🙏.
|
||||
- **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
|
||||
|
||||
### In-game settings
|
||||
- **Volume control**
|
||||
> Increase stream's volume up to 600%
|
||||
> Can be disabled in the Main Settings
|
||||
- **🔥 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".
|
||||
@ -135,7 +177,7 @@ If you like this project please give it a 🌟. Thank you 🙏.
|
||||
> 
|
||||
> *(click to enlarge)*
|
||||
|
||||
- **Stretch video to full sctreen**
|
||||
- **Change video's ratio**
|
||||
> Useful when you don't have a 16:9 screen
|
||||
- **Adjust video filters**
|
||||
> Brightness/Contrast/Saturation.
|
||||
@ -155,55 +197,11 @@ 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 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)
|
||||
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/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). 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
|
||||
|
||||

|
||||
|
||||
<img width="500" alt="Stream stats" src="https://github.com/redphx/better-xcloud/assets/96280/0d4abb6b-49ab-4c9a-a52d-df7e396d2145">
|
||||
<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.
|
||||
@ -213,9 +211,9 @@ Don't see your browser in the table? If it supports Tampermonkey/Userscript then
|
||||
|
||||
| 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) |
|
||||
| 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)) |
|
||||
| DT | Decode Time | The average time it took to decode one frame in the last second (bugged on Android [#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 |
|
||||
@ -278,11 +276,20 @@ 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 😄.
|
||||
## Translators
|
||||
- **Chinese (Simplified)**: [@nyavana](https://github.com/nyavana)
|
||||
- **Korean**: [@rightones](https://github.com/rightones)
|
||||
- **Portuguese (Brazilian)**: [@ricardo404](https://github.com/ricardo404), [@Haisom](https://github.com/Haisom)
|
||||
- **Russian**: [anpom6](https://crowdin.com/profile/anpom6)
|
||||
- **Turkish**: [@transbebek](https://github.com/transbebek)
|
||||
- **Vietnamese**: [@redphx](https://github.com/redphx)
|
||||
|
||||
## User-Agent
|
||||
Moved to [wiki](https://github.com/redphx/better-xcloud/wiki/User‐Agent).
|
||||
Visit [here](https://crowdin.com/project/better-xcloud) if you want to translate **Better xCloud** to more languages.
|
||||
Use [this post](https://github.com/redphx/better-xcloud/discussions/131) for discussion.
|
||||
|
||||
## 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 😄.
|
||||
But if you still really want to donate, I have a [Ko-fi page](https://ko-fi.com/redphx). Thank you.
|
||||
|
||||
## Acknowledgements
|
||||
- [n-thumann/xbox-cloud-server-selector](https://github.com/n-thumann/xbox-cloud-server-selector) for the idea of IPv6 feature
|
||||
|
@ -1,5 +1,5 @@
|
||||
// ==UserScript==
|
||||
// @name Better xCloud
|
||||
// @namespace https://github.com/redphx
|
||||
// @version 1.13
|
||||
// @version 1.17.2
|
||||
// ==/UserScript==
|
||||
|
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user