From d889457cee6551551eea2679d93297c05fbfb45f Mon Sep 17 00:00:00 2001
From: redphx <96280+redphx@users.noreply.github.com>
Date: Sun, 28 Apr 2024 18:02:43 +0700
Subject: [PATCH] Add GitHub files
---
.github/FUNDING.yml | 1 +
.github/ISSUE_TEMPLATE/01-bug-report.yml | 83 +++++++++++++++++
.github/ISSUE_TEMPLATE/02-feature-request.yml | 61 +++++++++++++
LICENSE | 24 +++++
README.md | 90 ++++++++++++++++---
5 files changed, 249 insertions(+), 10 deletions(-)
create mode 100644 .github/FUNDING.yml
create mode 100644 .github/ISSUE_TEMPLATE/01-bug-report.yml
create mode 100644 .github/ISSUE_TEMPLATE/02-feature-request.yml
create mode 100644 LICENSE
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
new file mode 100644
index 0000000..507e07c
--- /dev/null
+++ b/.github/FUNDING.yml
@@ -0,0 +1 @@
+ko_fi: redphx
diff --git a/.github/ISSUE_TEMPLATE/01-bug-report.yml b/.github/ISSUE_TEMPLATE/01-bug-report.yml
new file mode 100644
index 0000000..6225427
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/01-bug-report.yml
@@ -0,0 +1,83 @@
+name: Bug Report 🐞
+description: File a bug report
+title: "[Bug] "
+labels:
+ - bug
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Please fill out the following information to help us resolve the issue.
+ > [!warning]
+ > Only use English. Any other languages will be deleted.
+ - type: dropdown
+ id: device_type
+ attributes:
+ label: Device
+ description: "Which device are you using?"
+ options:
+ - Phone/Tablet
+ - Laptop
+ - Desktop
+ - TV
+ - Other
+ multiple: false
+ validations:
+ required: true
+ - type: dropdown
+ id: os
+ attributes:
+ label: "Operating System"
+ description: "Which operating system is it running?"
+ options:
+ - Windows
+ - macOS
+ - Linux
+ - Android
+ - iOS/iPadOS
+ - Other
+ multiple: false
+ validations:
+ required: true
+ - type: dropdown
+ id: browser
+ attributes:
+ label: "Browser"
+ description: "Which browser are you using?"
+ options:
+ - Chrome/Edge/Chromium
+ - Kiwi Browser
+ - Safari
+ - Other
+ multiple: false
+ validations:
+ required: true
+ - type: input
+ id: browser_version
+ attributes:
+ label: "Browser Version"
+ description: "What is the version of the browser?"
+ placeholder: "e.g., 122.0"
+ validations:
+ required: true
+ - type: input
+ id: extension_version
+ attributes:
+ label: "Better xCloud Version"
+ description: "What is the version of Better xCloud?"
+ placeholder: "e.g., 3.5.0"
+ validations:
+ required: true
+ - type: textarea
+ id: repro
+ attributes:
+ label: "Reproduction Steps"
+ description: |
+ How did you trigger this bug? Please provide screenshot/video if possible.
+ placeholder: |
+ Example:
+ 1. Open game X
+ 2. Click on Y
+ 3. Error
+ validations:
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/02-feature-request.yml b/.github/ISSUE_TEMPLATE/02-feature-request.yml
new file mode 100644
index 0000000..37c0dbe
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/02-feature-request.yml
@@ -0,0 +1,61 @@
+name: Feature Request 🚀
+description: Request a new feature, improvement, or general suggestion
+title: "[Feature] "
+labels:
+ - enhancement
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Please fill out the following information to help us understand your request.
+ > [!warning]
+ > Only use English. Any other languages will be deleted.
+ - type: dropdown
+ id: device_type
+ attributes:
+ label: Device
+ description: "Which device are you using?"
+ options:
+ - Phone/Tablet
+ - Laptop
+ - Desktop
+ - TV
+ - Other
+ multiple: false
+ validations:
+ required: true
+ - type: dropdown
+ id: os
+ attributes:
+ label: "Operating System"
+ description: "Which operating system is it running?"
+ options:
+ - Windows
+ - macOS
+ - Linux
+ - Android
+ - iOS/iPadOS
+ - Other
+ multiple: false
+ validations:
+ required: true
+ - type: dropdown
+ id: browser
+ attributes:
+ label: "Browser"
+ description: "Which browser are you using?"
+ options:
+ - Chrome/Edge/Chromium
+ - Kiwi Browser
+ - Safari
+ - Other
+ multiple: false
+ validations:
+ required: true
+ - type: textarea
+ id: suggestion
+ attributes:
+ label: "Suggestion"
+ description: "What do you want to suggest?"
+ validations:
+ required: true
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..91d8739
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,24 @@
+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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+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.
+
+---
diff --git a/README.md b/README.md
index 07b6246..d612cdc 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,85 @@
-# better-xcloud
+# Better xCloud
+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.
-To install dependencies:
+> [!TIP]
+> The Android app is in development at [redphx/better-xcloud-android](https://github.com/redphx/better-xcloud-android)
-```bash
-bun install
-```
+> [!IMPORTANT]
+> I don't accept pull requests at the moment (except PR for custom touch controls)
-To run:
+**Supported platforms:**
+- Windows
+- macOS
+- Linux, SteamOS (including Steam Deck)
+- Android, Android TV (including Meta Quest VR Headsets)
+- iOS, iPadOS
-```bash
-bun run src/index.ts
-```
+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 🙏.
-This project was created using `bun init` in bun v1.1.4. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
+[](https://github.com/redphx/better-xcloud/releases)
+[](https://github.com/redphx/better-xcloud/releases)
+[](https://github.com/redphx/better-xcloud/stargazers)
+
+## Full documentations
+- For the full details please visit: https://better-xcloud.github.io
+- [Demo video](https://youtu.be/hyp69Jrb2sQ)
+
+⚠️ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+**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/)
+
+## 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.
+
+## 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 [Phosphor Icons](https://phosphoricons.com)
+- [PromptFont](https://shinmera.com/promptfont) by Yukari "Shinmera" Hafner
+
+## Disclaimers
+- 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.