luanroger / xbox_launcher

Launcher with the Xbox Series X/S's dashboard to play Xbox Cloud Gaming (XCloud) games.

xbox_launcher

Launcher with the Xbox Series X/S's dashboard to play Xbox Cloud Gaming (XCloud) games.

🚧 The project is current in development (Alpha phase) so it can be unstable and occurs errors commonly. 🚧

Features

• Play Xbox Cloud Gaming (XCloud) directly from the launcher;
• Change the background from Home to a image, gif or solid color;
• Change the accent color;
• Create a profile, with your own cofiguration sets;
• Modify a existing profile with a new avatar or name;
• Set a image or gif as avatar image;
• Change the xbox.com/play region easely in the configurations;
• Fullscreen support;

Dependencies

• fluent_ui.
• webview-windows.
• provider.
• xinput_gamepad (First-party).
• virtual_keyboard (First-party).
• clock.
• window_manager.
• shared_preferences.
• file_picker.
• sprintf.
• carousel_slider.
• path_provider.
• flutter_svg.

Setup

Pre-requires

• A Xbox Game Pass Ultimate subscription
• Flutter 3.0+
• WebView2 Runtime
• Windows 10 1809+
• UWP SDK with Visual Studio 2022
• Python 3.10
• Microsoft Edge WebDriver
• Selenium Python

The Python 3.10, Microsoft Edge WebDriver and Selenium is required to get the games from xbox.com/play, but you can use xcloud_games.json that have some games on it. This file is not updated regularly, so some games that are on Xbox Cloud Gaming may not be there.

1. Get the games

Go to .\tools\xcloud_game_picker\ and execute the file xcloud_game_picker.py:

python .\xcloud_game_picker.py

and the Selenium will start to get the games, is important that you dont use the opened browser while dont finish.

2. Runing xbox_launcher

Go to root of the project and run on terminal:

flutter run --release

For now, not exist binaries or installers to use, so you need to build on its own.

3. Configuring

On xbox_launcher's Home page go to My Games > Apps > Configurations > Cloud gaming in the JSON file path field you paste the path to your xcloud_games.json file and confirm the changes.

Screenshots

Home Page.

Profile Selector.

Contribute

The project is in Alpha phase, therefore it is important that you consider contributing to the project in your spare time. Open an issue, pull request or engage in discussions to make the project better.

We are always needing help to:

• See the open issues.
• We still don't have a logo or visual identity.
• Improve the design of pages or widgets.
• Improve the code architecture.
• Improve performance and decrease memory consumption (memory leak).

For more info check the Contribuition Guideline.

Contribute to used packages

This project uses first-party and third-party open-source packages, so consider contributing to those as well.

Go to dependencies.

xbox_launcher's Issues

Create splash-screen to apps

Motivation

On Xbox, when enter in a app or game, a splash-screen is brevely showned.

Implementation

Not every app have a splash-screen by default, just the games, so is considered to automatcly create for system apps.

Remarks

In the future is internaly planed to create a kind of API to anyone create apps for the launcher, but this idea is in validation.
In this is issue is related with the fact that each app on the planed API will implement a splash-screen.

Focus Element system

This system will be used to get the last valid focused element.
The focused element can store an Object value.

The valid element just need to be focable, but not all element need to update the object.
This value need to have a timeout to be cleared.

Motivation

The stored value will use to get the games information to be used in context menu on My Games section.

TODO

• #29

Fix minor bugs

Known bugs

• Back twice in one page ahead of HomePage show a black screen.
• You can press select in GamePage and shows the game options menu, this can't happen.

Updata xcloud-game-picker to fit in the new xbox.com/play site

Redesing the keyboard

Update the keyboard's desing.

• Change icons.
• Remove current black background.

Currently, it is not possible to suggest or correct words.

Expose the focus from custom widgets

This will make the focus system more accessible and be more effectively.

Improve the experience in WebView

• Login automatically when enter in a game.
• Play automatically when enter in a game.
• Focus on WebView when start.
• Hide the cursor.

Get more infos about the game with xcloud_game_picker

New infos in xcloud_game model.

• Game developer.
• Game genre.
• Release date.
• Supported controllers.
• Is GamePass game.

Sync the XCloud game picker

[Bug] Visual of profile selector it's soo flattened

Probably this occurs because the buttons design has changed.

Add localization

All strings are hard coded. So it's need to change this when implement the localization.

The default language is the English, and all the other languagues will start from there.
To garantee the quality of the translation is required a contribuitor that have fluency on the language that will be translated.

Checklist

• Implement the package localization.
• Replace all hard-coded string by the localization string placeholder.
• Search for contributors that interesting to contribute with more languages.

Shortcuts support

Create shortcuts in the pages and shows it in bottom right corner.

Not all pages will support it.

Original implementation.

Create a controller to get the recently added games to Game Pass

Use HTTP request to get the recently added games to Game Pass in Recently Added page.

Requirements

• The script will get the page's HTML and from there get the name of the game.
• Store the game's name in cache.
• Use the current xcloud_games.json file to show the game information.

All this process will be made on time per day to update the cached games.

Motivations

• Show the Recently Added games in the Games&Apps page.
• Show the games in the future home dashboard. #8

TODO

• Create script in tools to get the recently added games.
• Made the script be rocoganized by the xbox_launcher.

To show the games is nescessary to have the #8 ready, So the issued can be clossed when the TODOs has been solved.

Implement focus on ListViews, GroupsViews and Generators

Create a Context Menu to exit the program

Motivation

For now is not possible to exit the launcher normaly unless forcing the process to stop, so it's to create a more simple way to exit the launcher using the Context Menus

Create context menu overlay

Desing

• Title.
• Action Lists.
• The actions can have leading icon.

Migrate from Provider to Riverpod

Motivation

Riverpod provides a way that is more easily to update the state and rebuild widgets with those changes.

Related

• Riverpod.
• Types of providers. Exist an ChangeNotifierProvider than made easier to migrate.

Riverpod and Hooks migration

This issue is just for track the #33 and #41, since they occurring at the same time.

Tracking

• #33

• #41

Change the initializers on super's constructors for super-initializers

Motivation

This will make the code more cleaner.
This is not priority.

References

• super-parameters
• Already implemented on project

WebView is not getting the controller inputs

The webview used is not longer getting the inputs from controller, just in the game screen but not in-game.

Related

Package used currently: webview_windows

Create MSIX instalator

Create the MSIX instalator with msix.

[internal_package - sys_info_package] Get informations about the system volumes

Create script to get the recently added games to Game Pass

The recently games can be getted on this page.

• Use Selenium to get the games.
• Use the existing functions to get the games like xcloud_game_picker as well.

Update xbox_launcher model

• Add store URL

Features

• Launche URL on ContextMenu when focus on tile with GameModel.

Move XOverlay and ExternalGames support to a separated develop branch

• This features have not been planed to be created.
• Can take a while to be ready to use in the main.
• The implementations of these features does not need a high priority.

Implement Flutter Hooks

Motivation

The flutter_hooks with the migration to Riverpod (#33) will help to manage the lifecicle of the widgets, mainly of the pages widgets, that for now, is hard to manage the shortcuts for this pages.

Cache large images

Large images than take too long to load is recomented to cache them.
Use cached_network_image to do this work.

To cache

• Hero images when open any XCloud game.

[Bug] The volume's progress ring is not showing correctly

The progress ring of the device volumes is showing the wrong information and wrong fill color.

The problem occurs after update the fluent_ui package to ^4.0.0.

Add badge in games tiles

Planed badges

• Game Pass badge.
• Supported controllers.
• Game genre.

The badges will be optional and can be toggled in configurations.

This implementation depends of #3 for the extra game infos.

Create configuration file for the system

Motivation

The configuration file belongs to user, so each user have you own configuration preferences, but some parameters dont need to user-depend.
For separation conserns, it will be created a configuration file that will the shared for all profiles and it will belong to system.

System configuration

This is the list of parameter that will belong to the system:

• preferedServer
• xcloudGamesJsonPath

This list can change at time

Update fluent_ui to 4.0 release candidate

Motivation

This will prepare to future update in the desing.
All must to be made in a dedicated branche, but it's to wait to be ready on release.

Currently is on Prerelease 4:
fluent_ui 4.0.0-pre.4

• Update packge.
• Solve breaking changes.

[Bug] Text is not aligned on the button

The "Confirm" button on the Cloud Gaming section on the Configurations is not aligned right.

The problem occurs after update the fluent_ui package to ^4.0.0.

Create Splash Screen

Motivation

This is a frendely way to show the load progress and made the launcher opening more interactive.

Description

Is not know a desing for the splash screen, but will be made a experimental implementation soon.

Sort right from release date

• Extracted from #32

The sorting from release date in the Games&Apps page is not working correctly.

Change shortcuts on runtime

The shortcut changing has been implemented in e2633cd

Requirements

• #18

Where change

• Update shortcut when focus in a game in My library to access the context menu removed temporarily in b3f1526

Create Games&Apps groups

Implement games and apps groups. For this feature is required to have the shortcuts implemented.

• Use shortcuts to create groups.
• Use shortcuts to add games or apps to groups.
  • #2
• Is not possible to have two identical app or game in a group.

The groups can be managed in the "Groups" section in My Library.

Manage groups

The group name will be clickable, and this will be used to manage the group.
Using a ContextMenu this actions need to be available:

• Rename groups.
• Reorder groups.
• Delete group.

Show the storage usage in Manage section

• Show all disks.
• Use a scrollable Row.
• Show the percentage inside the progress ring.
• Show the volume root path.

Motivation

This will be useful when the external games is implemented.

Requirements

This feature needs to get the system information and for that the sys_info_package is being created.

• Progress: #21

Redesing MyLibraryPage to new Xbox's Games&Apps page

(Image credit: Windows Central)

Features

• Sort games.
• Tabs in Full library section.
• Filter games.
• #17
• #20
• Create Manage section - #26

Desing

• Add icons to sections in the NavigationBar.
• Redesing search button.
• Increase the height of NavigationBar.

Bug

• #42

Update icons to Fluent Icons from Segoe MDL2

Update the icons to use the Fluent UI System Icons instead of Segoe MDL2. Use the new ones in buttons, navigation bar, etc.

References

Fluent UI System Icons
fluentui_system_icons

Redesing the HomePage to new Xbox's dashboard

First impressions

• Symetric tiles.
• Complement tiles with gradient and image.
• Search box at the top right.
• Dynamic background. Change on the focused game.