Skip to content

Commit

Permalink
Add Network Streaming user guides
Browse files Browse the repository at this point in the history
  • Loading branch information
LoveMHz committed Sep 18, 2024
1 parent 98295fa commit a3da36b
Show file tree
Hide file tree
Showing 41 changed files with 180 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Overview

On the Xbox, the dashboard is the default application that starts up when no game is loaded into the system.

However, with a modified setup, there's an option to integrate a custom dashboard. These custom dashboards, crafted by the community, come with an extensive array of features and enhancements.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Overview

![Screenshot](./images/screenshot_01.png)

Network Streaming is an experimental feature of Project Stellar that enables
you to play ISO images directly over your network on the original Xbox.

This functionality allows you to stream game images from a network location,
eliminating the need for physical discs or transferring files to local storage.
By leveraging your existing network infrastructure, Network Streaming provides a
convenient way to access and enjoy your game library.

- **Unlimited Storage:** Network streaming bypasses all drive size limits and has been tested with network shares larger than 100TB. No longer are you bound by the physical constraints of internal or external drives; your entire library can now live on a centralized server, accessible with just a few clicks.
- **Simple Setup:** Setting up an SMB2 server is incredibly straightforward across various platforms like Windows, macOS, Linux, and RetroNAS. Best of all, it requires no custom or homebrew server applications. If you already have a network share configured, you're halfway there.
- **Broad Image Support:** Whether you’re using ISO, XISO, CSO, or REDUMP images, NetISO handles them all seamlessly. This versatility ensures that whatever format your game backups are in, they’ll work without a hitch.
No More Splitting: Splitting large ISO images is no longer required. Enjoy the ease of playing your games as they were meant to be, without the tedious task of dividing files into smaller parts.

## Additional Resources
* [Project Stellar - Firmware Update 1.6.0 - Blog Post](https://makemhz.com/blogs/news/project-stellar-firmware-update-1-6-0)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Configuration
This guide will step you through enabling NetISO and adding a network share.

:::tip
Follow one of the ``Network Share Setup`` guides for an insight on how to setup an SMB share.
:::

## Enable SMB Filesystem Driver

In StellarOS under ``Enhancements`` enable ``SMB Filesystem Driver - NetISO``. Save and reboot.

![Screenshot](./images/screenshot_01.png)

## Adding Network Share
Back within StellarOS under ``File Explorer``, add a new network share with your network share information.

![Screenshot](./images/screenshot_02.png)

![Screenshot](./images/screenshot_03.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# Windows PC

## Custom Dashboards

Press the ``Windows Key + R`` and type ``compmgmt.msc`` and click ``OK``.
![Screenshot](./images/screenshot_01.png)

## Network Share
Share out the intended local directory containing your ISOs.

![Screenshot](./images/screenshot_02.png)

![Screenshot](./images/screenshot_03.png)

![Screenshot](./images/screenshot_04.png)

![Screenshot](./images/screenshot_05.png)

![Screenshot](./images/screenshot_06.png)

![Screenshot](./images/screenshot_07.png)

## User Authentication
Create a local user with a secure password.

![Screenshot](./images/screenshot_08.png)

![Screenshot](./images/screenshot_09.png)

Add the user to the share and give them read permissions.

![Screenshot](./images/screenshot_10.png)

![Screenshot](./images/screenshot_11.png)

![Screenshot](./images/screenshot_12.png)

![Screenshot](./images/screenshot_13.png)

![Screenshot](./images/screenshot_14.png)

## Windows Firewall Exclusions
From Windows search, locate ``Windows Defender Firewall with Advanced Security``

![Screenshot](./images/screenshot_15.png)

Create a firewall exclusion from SMB traffic by right-clicking on the ``Inbound Rules``.

![Screenshot](./images/screenshot_16.png)

![Screenshot](./images/screenshot_17.png)

![Screenshot](./images/screenshot_18.png)

![Screenshot](./images/screenshot_19.png)

![Screenshot](./images/screenshot_20.png)

![Screenshot](./images/screenshot_21.png)

## Enabled SMB2
Run PowerShell as Adminstrator and execture the following two commands to enable and confirm SMB2 is enabled.

![Screenshot](./images/screenshot_22.png)

![Screenshot](./images/screenshot_23.png)

## StellarOS Share Config
Within StellarOS, under the ``Enhancements`` section, enable ``SMB Filesystem Driver - NetISO``, then save and reboot.

![Screenshot](./images/screenshot_26.png)

Back within StellarOS under ``File Explorer``, add a new network share with your information from above.

| Setting | Value | Description |
|-------------|-----------------------------|-----------------------------------------------|
| Share Name | Laptop | You can name this whatever |
| Network URL | [email protected]/XboxGames | Replace the IP with your computer's IP |
| Password | | The xbox user password you've created above |

![Screenshot](./images/screenshot_24.png)

![Screenshot](./images/screenshot_25.png)
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Network Share Setup"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Legacy Dashboards
Support for legacy dashboards is provided via [stellar-attach](https://github.com/MakeMHz/stellar-attach).
This tool allows you to use any legacy dashboard to directly launch ISO images over the network.

## Download Latest Release
![Latest Release](./images/latest_release.png)

Begin by downloading the latest release of ``attach.xbe`` from [https://github.com/MakeMHz/stellar-attach/releases/latest](https://github.com/MakeMHz/stellar-attach/releases/latest)

## Determining File Path
In StellarOS, navigate to the ``File Explorer`` and locate the ISO image you
wish to stream. Take note of the network device path, as you'll need it for
the configuration file.

![Latest Release](./images/file_path.png)

In the example above, the configuration would be as followed:

```
VIRTUAL_IMAGE_FILE_PATH=\Device\Network\net0\Games\Xbox\007 - Agent Under Fire (USA).iso
```

## Creating Configuration File
Using a text editor of your choice, create a file named ``attach.ini``.

Inside this file, specify the path to your ISO image so that ``attach.xbe`` knows
where to find it. Depending on whether you're using a single ISO image or
split images, use one of the following templates as a guide.

**Single ISO Image**
```
VIRTUAL_IMAGE_FILE_PATH=\Device\Network\net0\Games\Xbox\4x4 Evo 2 (USA).iso
```

**ISO Image Split**
```
VIRTUAL_IMAGE_FILE_PATH=\Device\Network\net0\Games\Xbox\Halo (USA).1.iso
VIRTUAL_IMAGE_FILE_PATH=\Device\Network\net0\Games\Xbox\Halo (USA).2.iso
```

## Dashboard Setup
Transfer both ``attach.xbe`` and ``attach.ini`` to your Xbox, placing them in their own directory.

:::tip
In most cases, you would place them in a folder like ``F:\Games\Halo 2`` so your dashboard can detect and display the game.
:::

![XBMC Example](./images/xbmc.png)
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Dashboard Integration"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Network Streaming",
"position": 5
}

0 comments on commit a3da36b

Please sign in to comment.