Compare commits

...

20 Commits
v1.2 ... v1.3

Author SHA1 Message Date
0cb09bb455 Update README.md 2023-07-16 12:41:51 +07:00
14cf9d5877 Stop recommending changing User-Agent 2023-07-16 12:39:28 +07:00
b96b115182 Bump version to 1.3 2023-07-16 12:30:55 +07:00
766c5b8682 Update README.md 2023-07-16 12:30:14 +07:00
5f9564de45 Update CSS of reload page button 2023-07-16 12:01:22 +07:00
3a7dea6c75 Add missing code 2023-07-16 11:54:40 +07:00
8dd17bb021 Add setting to force HQ codec 2023-07-16 11:54:23 +07:00
e63f998f5a Update README.md 2023-07-16 06:43:49 +07:00
0685cd8038 Update README.md 2023-07-15 21:48:05 +07:00
f246faf796 Update README.md 2023-07-15 21:26:10 +07:00
68ef703bdb Update README.md 2023-07-15 21:17:01 +07:00
f9d683a2e4 Update README.md 2023-07-15 21:11:51 +07:00
fec2c4a22a Update README.md 2023-07-15 21:04:15 +07:00
c3df18d7be Update README.md 2023-07-15 20:59:10 +07:00
9971fe6c0c Update README.md 2023-07-15 20:55:34 +07:00
cc11bcea41 Bump version to 1.2.1 2023-07-15 20:54:15 +07:00
048d085e91 Merge branch 'main' of https://github.com/redphx/better-xcloud 2023-07-15 20:53:37 +07:00
ed32044480 Update Video settings UI 2023-07-15 20:53:28 +07:00
32c087966b Update README.md 2023-07-15 20:52:51 +07:00
e4ad010e0a Remove video settings in the main Settings UI 2023-07-15 20:29:50 +07:00
2 changed files with 133 additions and 137 deletions

121
README.md
View File

@ -2,36 +2,89 @@
Improve [Xbox Cloud Gaming (xCloud)](https://www.xbox.com/play/) experience on web browser. Improve [Xbox Cloud Gaming (xCloud)](https://www.xbox.com/play/) experience on web browser.
The main target of this script is Android users, but it should work great on desktop too. The main target of this script is Android users, but it should work great on desktop too.
Give this project a 🌟 if you like it. Thank you.
## Features ## Features
<img width="474" alt="image" src="https://github.com/redphx/better-xcloud/assets/96280/2793d404-3185-4c91-a500-dde362c661dd"> <img width="500" alt="Settings UI" src="https://github.com/redphx/better-xcloud/assets/96280/4f60c2e6-9706-4326-940f-f46998177633">
<img width="500" alt="Video Settings UI" src="https://github.com/redphx/better-xcloud/assets/96280/130aa870-6938-4604-9e23-45e217b800cc">
- Switch region of streaming server. - **Switch region of streaming server**
- Prefer IPv6 streaming server (might reduce latency). > Connect to another server instead of the default one
- Force HD stream by disabling bandwidth checking -> xCloud always tries to use the best possible quality. - **Prefer IPv6 streaming server**
- Skip Xbox splash video (save 3 seconds). > Might reduce latency
- Make the top-left dots icon invisible while playing. You can still click on it, but it doesn't block the screen anymore. - **Force high quality stream**
- Stretch video to full sctreen. Useful when you don't have a 16:9 screen. > Force xCloud to use the best streaming codec (same as desktop). You don't have to change User-Agent anymore. Affect battery life.
- Adjust video filters (brightness/contrast/saturation). - **Disable bandwidth checking**
- You can change video settings while playing. > xCloud won't reduce quality when the internet speed is slow
- Hide footer and other UI elements. - **Skip Xbox splash video**
- Reduce UI animations (the smooth scrolling cannot be disabled). > Save 3 seconds
- Disable social features (friends, chat...). - **Hide Dots icon while playing**
- 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. > 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
- **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.
- **Hide footer and other UI elements**
## How to use ## How to use
1. Install [Tampermonkey extension](https://www.tampermonkey.net/) on suppported browsers. It's also available for Firefox on Android. 1. Install [Tampermonkey extension](https://www.tampermonkey.net/) on suppported browsers. It's also available for Firefox on Android.
2. Install **Better xCloud**: 2. Install **Better xCloud**:
- [Directly on Github](https://github.com/redphx/better-xcloud/releases/latest/download/better-xcloud.user.js) - [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/). 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. 5. Click on the new "SERVER NAME" button next to your profile picture to adjust settings.
6. Optional but recommended: change your browser's User-Agent. Check the [User-Agent section](#user-agent) below for more info. 6. Don't forget to enable auto updating for the script in Tampermonkey.
7. Don't forget to reload the page after changing settings.
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)
⚠️ = see custom notes
| | Desktop | Android | iOS |
|----------------------------------------|----------|------------------|-----|
| Chrome/Edge/Chromium variants | ✅ | ❌ | ❌ |
| Firefox | ✅ | ✅ | ❌ |
| Safari | ❓ | ❌ | ❓ |
| [Hermit](https://hermit.chimbori.com) | ❌ | ⚠️<sup>(1)</sup> | ❌ |
Don't see your browser in the table? If it supports Tampermonkey/Userscript then the answer is likely **"YES"**.
<sup>1</sup> NOT RECOMMENDED at the moment since its Userscript implementation is not working properly. Non-network related features (skip splash video, video settings...) still work. 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.
## 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.
2. **Why is it an Userscript and not 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.
4. **Can I use this with the Xbox Android 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.
## 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)
## User-Agent ## User-Agent
Optional, as changing User-Agent won't guarantee a better streaming experience, but it's worth a try. You might need to install an external extension to do that. > You're no longer needed to change User-Agent since you can just use the **Force high quality stream** setting.
> I'll still keep this section because it has some interesting info.
It's recommended to change User-Agent to: 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 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
``` ```
@ -43,38 +96,6 @@ Other options (only do one of these):
- Add ` 36102dd3-6953-45f6-8b48-031fb95e0e0d` to become a Logitech G Cloud device. - 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. - Add ` 0ed22b6f-b61d-41eb-810a-a1ed586a550b` to become a Razer Edge device.
## Compatibility
✅ = confirmed to be working
❓ = not yet tested
❌ = not supported (mostly because of lacking Userscript/extension support)
⚠️ = see custom notes
| | Desktop | Android | iOS |
|----------------------------------------|----------|------------------|-----|
| Chrome | ✅ | ❌ | ❌ |
| Firefox | ✅ | ✅ | ❌ |
| Edge | ❓ | ❌ | ❌ |
| Safari | ❓ | ❌ | ❓ |
| [Hermit](https://hermit.chimbori.com) | ❌ | ⚠️<sup>(1)</sup> | ❌ |
<sup>1</sup> NOT RECOMMENDED at the moment since its Userscript implementation is not working properly. Non-network related features (skip splash video, video settings...) still work. It's still my favorite app to play xCloud on because it's lightweight, supports both custom User-Agent and Userscript (premium features, only $1.99 for Userscript feature or $7.99 if you want both) without having to install anything else. I built **Better xCloud** just so I could use it with Hermit.
## FAQ
1. **Why is it an Userscript and not extension?**
It's because not many browsers on Android support installing extensions (and not all extensions can be installed).
2. **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. **Can I use this with the Xbox Android app?**
No you can't. You'll have to modify the app.
4. **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.
## 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)
## Disclaimers ## Disclaimers
- Use as your own risk. - Use as your own risk.
- This project is not affiliated with Xbox in any way. All Xbox logos/icons/trademarks are copyright of their respective owners. - This project is not affiliated with Xbox in any way. All Xbox logos/icons/trademarks are copyright of their respective owners.

View File

@ -1,7 +1,7 @@
// ==UserScript== // ==UserScript==
// @name Better xCloud // @name Better xCloud
// @namespace https://github.com/redphx // @namespace https://github.com/redphx
// @version 1.2 // @version 1.3
// @description Improve Xbox Cloud Gaming (xCloud) experience // @description Improve Xbox Cloud Gaming (xCloud) experience
// @author redphx // @author redphx
// @license MIT // @license MIT
@ -13,7 +13,7 @@
// ==/UserScript== // ==/UserScript==
'use strict'; 'use strict';
const SCRIPT_VERSION = '1.2'; const SCRIPT_VERSION = '1.3';
const SCRIPT_HOME = 'https://github.com/redphx/better-xcloud'; const SCRIPT_HOME = 'https://github.com/redphx/better-xcloud';
const SERVER_REGIONS = {}; const SERVER_REGIONS = {};
@ -22,6 +22,7 @@ const SERVER_REGIONS = {};
class Preferences { class Preferences {
static get SERVER_REGION() { return 'server_region'; } static get SERVER_REGION() { return 'server_region'; }
static get PREFER_IPV6_SERVER() { return 'prefer_ipv6_server'; } static get PREFER_IPV6_SERVER() { return 'prefer_ipv6_server'; }
static get USE_DESKTOP_CODEC() { return 'use_desktop_codec'; }
static get BLOCK_TRACKING() { return 'block_tracking'; } static get BLOCK_TRACKING() { return 'block_tracking'; }
static get BLOCK_SOCIAL_FEATURES() { return 'block_social_features'; } static get BLOCK_SOCIAL_FEATURES() { return 'block_social_features'; }
@ -48,9 +49,15 @@ class Preferences {
'default': false, 'default': false,
}, },
{
'id': Preferences.USE_DESKTOP_CODEC,
'label': 'Force high quality stream (same as desktop)',
'default': false,
},
{ {
'id': Preferences.DISABLE_BANDWIDTH_CHECKING, 'id': Preferences.DISABLE_BANDWIDTH_CHECKING,
'label': 'Force HD stream', 'label': 'Disable bandwitdh checking',
'default': false, 'default': false,
}, },
@ -88,6 +95,7 @@ class Preferences {
'id': Preferences.VIDEO_FILL_FULL_SCREEN, 'id': Preferences.VIDEO_FILL_FULL_SCREEN,
'label': 'Stretch video to full screen', 'label': 'Stretch video to full screen',
'default': false, 'default': false,
'hidden': true,
}, },
{ {
@ -96,6 +104,7 @@ class Preferences {
'default': 100, 'default': 100,
'min': 0, 'min': 0,
'max': 150, 'max': 150,
'hidden': true,
}, },
{ {
@ -104,6 +113,7 @@ class Preferences {
'default': 100, 'default': 100,
'min': 0, 'min': 0,
'max': 150, 'max': 150,
'hidden': true,
}, },
{ {
@ -112,6 +122,7 @@ class Preferences {
'default': 100, 'default': 100,
'min': 0, 'min': 0,
'max': 150, 'max': 150,
'hidden': true,
}, },
] ]
@ -246,29 +257,14 @@ function addCss() {
line-height: 24px; line-height: 24px;
} }
@media (hover: hover) {
.better_xcloud_settings_wrapper .setting_button:hover { .better_xcloud_settings_wrapper .setting_button:hover {
background-color: #06743f; background-color: #00753c;
}
} }
.better_xcloud_settings_preview_screen { .better_xcloud_settings_wrapper .setting_button:active {
display: none; background-color: #00753c;
aspect-ratio: 20/9;
background: #1e1e1e;
border-radius: 8px;
overflow: hidden;
max-height: 180px;
margin: 10px auto;
}
.better_xcloud_settings_preview_video {
display: flex;
aspect-ratio: 16/9;
height: 100%;
margin: auto;
}
.better_xcloud_settings_preview_video div {
flex: 1;
} }
/* Hide UI elements */ /* Hide UI elements */
@ -536,31 +532,6 @@ function createElement(elmName, props = {}) {
} }
function generateVideoPreviewBox() {
const $screen = createElement('div', {'class': 'better_xcloud_settings_preview_screen'});
const $video = createElement('div', {'class': 'better_xcloud_settings_preview_video'});
const COLOR_BARS = [
'white',
'yellow',
'cyan',
'green',
'magenta',
'red',
'blue',
'black',
];
COLOR_BARS.forEach(color => {
$video.appendChild(createElement('div', {
style: `background-color: ${color}`,
}));
});
$screen.appendChild($video);
return $screen;
}
function injectSettingsButton($parent) { function injectSettingsButton($parent) {
if (!$parent) { if (!$parent) {
return; return;
@ -593,8 +564,11 @@ function injectSettingsButton($parent) {
$wrapper.appendChild($title); $wrapper.appendChild($title);
for (let setting of Preferences.SETTINGS) { for (let setting of Preferences.SETTINGS) {
let $control; if (setting.hidden) {
continue;
}
let $control;
if (setting.id === Preferences.SERVER_REGION) { if (setting.id === Preferences.SERVER_REGION) {
$control = CE('select', {id: 'xcloud_setting_' + setting.id}); $control = CE('select', {id: 'xcloud_setting_' + setting.id});
$control.addEventListener('change', e => { $control.addEventListener('change', e => {
@ -616,33 +590,6 @@ function injectSettingsButton($parent) {
$control.appendChild($option); $control.appendChild($option);
} }
} else if (typeof setting.default === 'number') {
$control = CE('input', {
id: 'xcloud_setting_' + setting.id,
type: 'number',
size: 5,
'data-key': setting.id,
});
if ('min' in setting) {
$control.setAttribute('min', setting.min);
}
if ('max' in setting) {
$control.setAttribute('max', setting.max);
}
$control.value = PREFS.get(setting.id);
if (setting.id.startsWith('video_')) {
$control.addEventListener('change', e => {
if (!e.target.value) {
return;
}
PREFS.set(e.target.getAttribute('data-key'), parseInt(e.target.value));
updateVideoPlayerPreview();
});
}
} else { } else {
$control = CE('input', { $control = CE('input', {
id: 'xcloud_setting_' + setting.id, id: 'xcloud_setting_' + setting.id,
@ -670,9 +617,6 @@ function injectSettingsButton($parent) {
$wrapper.appendChild($elm); $wrapper.appendChild($elm);
} }
const $videoPreview = generateVideoPreviewBox();
$wrapper.appendChild($videoPreview);
const $reloadBtn = CE('button', {'class': 'setting_button'}, 'Reload page to reflect changes'); const $reloadBtn = CE('button', {'class': 'setting_button'}, 'Reload page to reflect changes');
$reloadBtn.addEventListener('click', e => window.location.reload()); $reloadBtn.addEventListener('click', e => window.location.reload());
$wrapper.appendChild($reloadBtn); $wrapper.appendChild($reloadBtn);
@ -897,6 +841,31 @@ function patchVideoApi() {
} }
function patchRtcCodecs() {
if (typeof RTCRtpTransceiver === 'undefined' || !PREFS.get(Preferences.USE_DESKTOP_CODEC)) {
return;
}
RTCRtpTransceiver.prototype.orgSetCodecPreferences = RTCRtpTransceiver.prototype.setCodecPreferences;
RTCRtpTransceiver.prototype.setCodecPreferences = function(codecs) {
// Use the same codecs as desktop
codecs = [
{
'clockRate': 90000,
'mimeType': 'video/H264',
'sdpFmtpLine': 'level-asymmetry-allowed=1;packetization-mode=1;profile-level-id=4d001f',
},
{
'clockRate': 90000,
'mimeType': 'video/H264',
'sdpFmtpLine': 'level-asymmetry-allowed=1;packetization-mode=0;profile-level-id=4d001f',
}
].concat(codecs);
this.orgSetCodecPreferences(codecs);
}
}
function numberPicker(key) { function numberPicker(key) {
let value = PREFS.get(key); let value = PREFS.get(key);
let $text, $decBtn, $incBtn; let $text, $decBtn, $incBtn;
@ -907,7 +876,7 @@ function numberPicker(key) {
const CE = createElement; const CE = createElement;
const $wrapper = CE('div', {}, const $wrapper = CE('div', {},
$decBtn = CE('button', {'data-type': 'dec'}, '-'), $decBtn = CE('button', {'data-type': 'dec'}, '-'),
$text = CE('span', {}, value), $text = CE('span', {}, value + '%'),
$incBtn = CE('button', {'data-type': 'inc'}, '+'), $incBtn = CE('button', {'data-type': 'inc'}, '+'),
); );
@ -929,7 +898,7 @@ function numberPicker(key) {
value = (value >= MAX) ? MAX : value + 1; value = (value >= MAX) ? MAX : value + 1;
} }
$text.textContent = value; $text.textContent = value + '%';
PREFS.set(key, value); PREFS.set(key, value);
updateVideoPlayerCss(); updateVideoPlayerCss();
@ -1022,8 +991,9 @@ function setupVideoSettingsBar() {
} }
.better_xcloud_quick_settings_bar label { .better_xcloud_quick_settings_bar label {
font-size: 24px; font-size: 20px;
display: block; display: block;
margin-bottom: 8px;
} }
.better_xcloud_quick_settings_bar input { .better_xcloud_quick_settings_bar input {
@ -1037,8 +1007,9 @@ function setupVideoSettingsBar() {
height: 24px; height: 24px;
margin: 0 8px; margin: 0 8px;
line-height: 24px; line-height: 24px;
background-color: #fff; background-color: #515151;
color: #000; color: #fff;
border-radius: 4px;
} }
@media (hover: hover) { @media (hover: hover) {
@ -1055,7 +1026,9 @@ function setupVideoSettingsBar() {
.better_xcloud_quick_settings_bar span { .better_xcloud_quick_settings_bar span {
display: inline-block; display: inline-block;
width: 26px; width: 40px;
font-weight: bold;
font-family: Consolas, "Courier New", Courier, monospace;
} }
`); `);
@ -1106,6 +1079,8 @@ if (PREFS.get(Preferences.DISABLE_BANDWIDTH_CHECKING)) {
}); });
} }
patchRtcCodecs();
interceptHttpRequests(); interceptHttpRequests();
patchVideoApi(); patchVideoApi();