mirror of
https://github.com/redphx/better-xcloud.git
synced 2025-06-29 02:41:44 +02:00
Compare commits
23 Commits
Author | SHA1 | Date | |
---|---|---|---|
cd82c5a94c | |||
140005bda5 | |||
76d99a994a | |||
48e1eb1a52 | |||
2ecd6f23ff | |||
3e97263caa | |||
19856e6381 | |||
d6852e132d | |||
a5d340e4e8 | |||
34f33f2508 | |||
ebde464bfa | |||
244fef1475 | |||
d43659da30 | |||
1dc411281c | |||
3d3811b8f3 | |||
e940524ab1 | |||
fe7b8d1ade | |||
6264eaf32d | |||
e6980b5204 | |||
4a0830895f | |||
92157cdd5d | |||
066d999241 | |||
1307b43f0c |
91
README.md
91
README.md
@ -14,13 +14,15 @@ Give this project a 🌟 if you like it. Thank you 🙏.
|
||||
|
||||
## Features
|
||||
|
||||
<img width="475" alt="Settings UI" src="https://github.com/redphx/better-xcloud/assets/96280/575d566a-7759-4cce-962d-7e5f55a70d9e">
|
||||
|
||||
<img width="475" alt="Stream HUD UI" src="https://github.com/redphx/better-xcloud/assets/96280/b4f943f1-d0b4-4401-a8cb-0fd677a5c6f0">
|
||||
<img width="400" alt="Settings UI" src="https://github.com/redphx/better-xcloud/assets/96280/6e74fdaf-dc84-416a-a2bc-5e117a3717e3">
|
||||
<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">
|
||||
|
||||
|
||||
|
||||
**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.
|
||||
@ -29,35 +31,58 @@ 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**
|
||||
> Set stream's resolution.
|
||||
- **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 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.
|
||||
|
||||
### 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.
|
||||
- **Disable touch controller**
|
||||
> 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, Retroid, etc.
|
||||
- **Simplify Stream's menu**
|
||||
> Hide the labels of the menu buttons.
|
||||
- **Hide mouse cursor while playing**
|
||||
> Hide the mouse cursor after 3 seconds of not moving.
|
||||
- **Reduce UI animations**
|
||||
> 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**
|
||||
@ -67,16 +92,12 @@ Give this project a 🌟 if you like it. Thank you 🙏.
|
||||
> Current playtime of the session.
|
||||
> Current battery level.
|
||||
> Estimated total data sent/received.
|
||||
- **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.
|
||||
|
||||
### 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).
|
||||
- **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.
|
||||
@ -86,9 +107,10 @@ Give this project a 🌟 if you like it. Thank you 🙏.
|
||||
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.
|
||||
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).
|
||||
|
||||
@ -125,16 +147,16 @@ Don't see your browser in the table? If it supports Tampermonkey/Userscript then
|
||||
## Stream stats
|
||||
<img width="500" alt="Stream stats" src="https://github.com/redphx/better-xcloud/assets/96280/0d4abb6b-49ab-4c9a-a52d-df7e396d2145">
|
||||
|
||||
- While playing > `...` > `Stream Stats` (the one with the eye icon).
|
||||
- While playing > `...` > `Stream Stats`.
|
||||
- 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 buttons bar is expanded. The 👀 emoji at the beginning indicates that the stats bar is in the quick glance mode.
|
||||
- **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 |
|
||||
|------:|:-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| 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) |
|
||||
| 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 |
|
||||
@ -185,15 +207,18 @@ For being an unofficial tool, **Better xCloud** has the luxury to implement anyt
|
||||
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.
|
||||
|
@ -1,5 +1,5 @@
|
||||
// ==UserScript==
|
||||
// @name Better xCloud
|
||||
// @namespace https://github.com/redphx
|
||||
// @version 1.9
|
||||
// @version 1.10
|
||||
// ==/UserScript==
|
||||
|
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user