Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

stops using pre compiled images #89

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

stops using pre compiled images #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
62dbf91
An installation script is a much better way to install psx-pi-smbshare.
georgewoodall82 Mar 8, 2024
9fbbd8f
Delete provisionRelease.sh
georgewoodall82 Mar 8, 2024
bc82c45
Update README.md
georgewoodall82 Jun 8, 2024
9c706de
Update README.md
georgewoodall82 Jun 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 31 additions & 42 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,10 @@ You can see it in action in this video from [@versatileninja](https://github.com

[![Play PS2 Games Over SMB Using Raspberry Pi 3b+ and psx-pi-smbshare (2019)](https://img.youtube.com/vi/Ilx5NYoUkNA/0.jpg)](https://www.youtube.com/watch?v=Ilx5NYoUkNA)

## Upgrading an existing install
The following commands can be used to upgrade an existing psx-pi-smbshare device. These instructions can also be used to convert an unsupported device into a psx-pi-smbshare (for example [Raspberry Pi4](https://github.com/toolboc/psx-pi-smbshare/issues/10) and potentially other devices running a debian based OS with an accessible ethernet port).
```
cd ~
wget -O setup.sh https://raw.githubusercontent.com/toolboc/psx-pi-smbshare/master/setup.sh
chmod 755 setup.sh
./setup.sh
```
> **Note:** Ensure you are using the latest version of Open PS2 Loader (OPL), downloaded from [here](https://github.com/ps2homebrew/Open-PS2-Loader/releases). Older versions are known to give error 300.

## How it works
psx-pi-smbshare is a preconfigured Raspbian based image for Raspberry Pi 1, 2, 3 and [4](https://www.youtube.com/watch?v=8qaJcbSye-E). It runs a [Samba](https://en.wikipedia.org/wiki/Samba_(software)) share, a pi-compatible build of [ps3netsrv](https://github.com/dirkvdb/ps3netsrv--), and reconfigures the ethernet port to act as a router. This gives low-latency, direct access to the Samba service through an ethernet cable connection between a PS2/PS3 and Raspberry Pi. This configuration is achieved by running [setup.sh](/setup.sh). A pre-supplied [image](https://github.com/toolboc/psx-pi-smbshare/releases/) can be applied directly to a Micro-SD card using something like [etcher.io](https://etcher.io/). The image allows you to use the full available space on the SD card after the OS is first booted.
psx-pi-smbshare is a collection of shell scripts for the Raspberry Pi. It can run a [Samba](https://en.wikipedia.org/wiki/Samba_(software)) share, a pi-compatible build of [ps3netsrv](https://github.com/dirkvdb/ps3netsrv--), and can reconfigure the ethernet port to act as a router. This gives low-latency, direct access to the Samba service through an ethernet cable connection between a PS2/PS3 and Raspberry Pi. This configuration is achieved by running [setup.sh](/setup.sh).

An [XLink Kai](http://www.teamxlink.co.uk/) client is also included and accessible on the device at http://smbshare:34522/. This allows for multi-player gaming over extended LAN. The service is possible to use on a variety of devices including PS2, PS3, PS4, Xbox, Xbox 360, Xbox One, Gamecube, Switch, Wii, Wii U (and PSP). Just connect an ethernet cable to your game console and access the XLink Kai Service over Wi-Fi with a smart phone, tablet, or computer.

Expand All @@ -29,18 +22,28 @@ psx-pi-smbshare also works out of the box on PS2 with [Open Playstation Loader](
psx-pi-smbshare supports an ability to route traffic from the ethernet port through a wireless network connection to the outside world. With this configuration, the XLink Kai Service can be used on pretty much any device with an ethernet port. This includes Xbox, Xbox 360, PS2, PS3, and Gamecube. There is also support for Ad-Hoc multiplayer on PSP using XLink Kai.

# Quickstart
> **Note:** Ensure you are using the latest version of Open PS2 Loader (OPL) if using a PS2, downloaded from [here](https://github.com/ps2homebrew/Open-PS2-Loader/releases). Older versions are known to give error 300.

*Prerequisites*
* Raspberry Pi 1, 2, or 3
* Any Raspberry Pi
* Micro-SD Card (8GB+ suggested)

A detailed [video guide](https://www.youtube.com/watch?time_continue=1&v=Ilx5NYoUkNA) is provided by Project Phoenix Media which walks through the processes described below.
## Install Raspberry Pi OS
**If you already have Raspberry Pi OS installed, you can skip this step.**

Download the latest [Raspberry Pi Imager](https://github.com/raspberrypi/rpi-imager), choose your Raspberry Pi model, and flash the lite or desktop image of Raspberry Pi OS to a Micro-SD Card.

## Flash the image
Download the latest [psx-pi-smbshare release image](https://github.com/toolboc/psx-pi-smbshare/releases/) and burn it to a Micro-SD card with [etcher.io](http://etcher.io)
## Run the Installation Script
The following commands can be used to install psx-pi-smbshare on Raspberry Pi OS (and potentially other debian-based distros).
```
cd ~
wget -O setup.sh https://raw.githubusercontent.com/toolboc/psx-pi-smbshare/master/setup.sh
chmod 755 setup.sh
./setup.sh
```

## Configuring Wireless Network
If you wish to configure the wireless network on a Raspberry Pi 2 or 3, you need to add a file to **/boot** on the Micro-SD card.
If you wish to configure the wireless network, you need to add a file to **/boot** on the Micro-SD card.

Create a file on **/boot** named **wpa_supplicant.conf** and supply the following (change country to a [valid 2 letter code](https://en.wikipedia.org/wiki/ISO_3166-1)):

Expand All @@ -53,21 +56,7 @@ Create a file on **/boot** named **wpa_supplicant.conf** and supply the followin
psk="<PASSWORD>"
}

When the pi is next booted, it will attempt to connect to the wireless network in this configuration. You are then able to access the raspberry pi on the network and allow for outbound connections from a PS2/PS3 over the wireless network.
The raspberry pi is configured to have a hostname `smbshare` with a user `pi` and a password of `raspberry`.

## Disable DHCP server on Raspberry Pi

The default behavior of psx-pi-smbshare is to enable a console-to-pi connection by means of the high speed ethernet port available on many video game consoles. This connection is used to provide a direct access from the console to the services on the pi (WiFi, XLinkKai, SMB, ps3netsrv etc), and by default, a DHCP server runs on the ethernet interface (eth0) to facilitate this. The following steps will describe how to disable this mechanism and is not recommended for typical users. Please be aware that disabling the DHCP server will produce a side-effect of [no longer being able to directly connect your video game console to the pi via the ethernet interface](https://github.com/toolboc/psx-pi-smbshare/issues/22#issuecomment-667469343).

In some use cases, the user may wish to connect the Raspberry Pi via ethernet to an external router (for example: [to have psx-pi-smbshare act as an XLinkKai server for primarily PSP games](https://github.com/toolboc/psx-pi-smbshare/issues/21)). To disable the DHCP server that would usually run automatically on this interface, [ssh into your device](https://www.raspberrypi.org/documentation/remote-access/ssh/) and execute the following command to modify the startup scripts that run at boot time:
```
crontab -e
```
Next, find and comment the line containing `@reboot sudo bash /home/pi/wifi-to-eth-route.sh` by adding a '#' as shown below:
```
#@reboot sudo bash /home/pi/wifi-to-eth-route.sh
```
When the pi is next booted, it will attempt to connect to the wireless network in this configuration. You are then able to access the raspberry pi on the network and allow for outbound connections from a PS2/PS3 over the wireless network.

## Accessing the XLink Kai Service
Visit http://smbshare:34522/ or http://<YOUR_PSX_PI_SMBSHARE_DEVICE_IP>:34522/
Expand Down Expand Up @@ -201,11 +190,11 @@ Don't forget to select "Save Config" when you return to "Settings"
* An XLink Kai account from http://www.teamxlink.co.uk/

*Steps*
1. Burn the [latest psx-pi-smbshare image](https://github.com/toolboc/psx-pi-smbshare/releases) to a Micro-SD card
2. Configure Wi-fi per the steps above in ["Configuring the Wireless Network"](https://github.com/toolboc/psx-pi-smbshare#configuring-wireless-network)
3. Add a second Wi-fi dongle to the pi as described in [Using a second wifi interface as an access point to XLink Kai](https://github.com/toolboc/psx-pi-smbshare#using-a-second-wifi-interface-as-an-access-point-to-xlink-kai)
1. Setup psx-pi-smbshare as described in [Quickstart](#quickstart)
2. Setup Wi-Fi on the pi and get the IP via `ifconfig` and looking at the wlan0 section
3. Add a second Wi-fi dongle to the pi as described in [Using a second wifi interface as an access point to XLink Kai](#using-a-second-wifi-interface-as-an-access-point-to-xlink-kai)
4. Configure your Switch to connect to the "XLinkKai" access point and set the `DNS Settings` to manual and set the `Primary DNS` to 10.254.0.1 and ensure that `Autoconnect` is set to "on" as described in the [XLinkKai Nintendo Switch Tutorial](https://www.teamxlink.co.uk/wiki/Nintendo_Switch_XLink_Kai_Setup).
4. Vist the XLink Kai service running on the pi @ http://smbshare:34522 or http://<YOUR_PSX_PI_SMBSHARE_DEVICE_IP>:34522/ and login with your XLink Kai account
4. Vist the XLink Kai service running on the pi @ http://<YOUR_PSX_PI_SMBSHARE_DEVICE_IP>:34522/ and login with your XLink Kai account
5. In the XLink Kai portal, select `Configuration` and ensure that `Network Adapter` is set to to `wlan1` to ensure that XLinkKai captures packets from the proper wireless interface.
6. In the XLink Kai portal , select `Game Arenas` and navigate to the room for the game that you wish to play
7. Launch the game on your Switch and start up LAN mode and create a LAN game (Do not confuse with Local Wireless, many games involve a special keypress combination to enable LAN mode, please research accordingly). If asked to connect to a network during this process, select the "XLinkKai" SSID that is being served from the raspberry pi.
Expand All @@ -223,10 +212,10 @@ Don't forget to select "Save Config" when you return to "Settings"
* An XLink Kai account from http://www.teamxlink.co.uk/

*Steps*
1. Burn the [latest psx-pi-smbshare image](https://github.com/toolboc/psx-pi-smbshare/releases) to a Micro-SD card
2. Configure Wi-fi per the steps above in ["Configuring the Wireless Network"](https://github.com/toolboc/psx-pi-smbshare#configuring-wireless-network)
1. Setup psx-pi-smbshare as described in [Quickstart](#quickstart)
2. Configure Wi-fi per the steps above in ["Configuring the Wireless Network"](#configuring-wireless-network)
3. Plug the pi into the Xbox ethernet port and verify that you are able to obtain an ip automatically in Network Settings
4. Vist the XLink Kai service running on the pi @ http://smbshare:34522 or http://<YOUR_PSX_PI_SMBSHARE_DEVICE_IP>:34522/ and login with your XLink Kai account
4. Vist the XLink Kai service running on the pi @ http://<YOUR_PSX_PI_SMBSHARE_DEVICE_IP>:34522/ and login with your XLink Kai account
5. Select an available Halo game from the XLink Kai portal (there are usually a few running in South America)
6. Launch Halo 2 and select "System Link"
7. Join a game and have fun!
Expand All @@ -239,8 +228,8 @@ Don't forget to select "Save Config" when you return to "Settings"
* An XLink Kai account from http://www.teamxlink.co.uk/

*Steps*
1. Burn the [latest psx-pi-smbshare image](https://github.com/toolboc/psx-pi-smbshare/releases) to a Micro-SD card
2. Configure Wi-fi per the steps above in ["Configuring the Wireless Network"](https://github.com/toolboc/psx-pi-smbshare#configuring-wireless-network)
1. Setup psx-pi-smbshare as described in [Quickstart](#quickstart)
2. Configure Wi-fi per the steps above in ["Configuring the Wireless Network"](#configuring-wireless-network)
3. Plug the pi into the PS2 ethernet port
4. The following setup needs to be performed one time: Boot your PS2 up with SOCOM 2 and select "Online" at the title screen. Once you hit the first blue screen hit edit network configuration to be sent to the network setup. Now delete any old network settings and create a new one. Using Automatic settings is fine but you may wish to set the following manual settings if you have issues:

Expand All @@ -257,9 +246,9 @@ Don't forget to select "Save Config" when you return to "Settings"
* 1 external wifi dongle for RPi 2/3 or 2 external wifi dongles for RPi 1

*Steps*
1. Burn the [latest psx-pi-smbshare image](https://github.com/toolboc/psx-pi-smbshare/releases) to a Micro-SD card
1. Setup psx-pi-smbshare as described in [Quickstart](#quickstart)
2. Plug in the external wifi dongle(s)
3. Configure Wi-fi per the steps above in ["Configuring the Wireless Network"](https://github.com/toolboc/psx-pi-smbshare#configuring-wireless-network)
3. Configure Wi-fi per the steps above in ["Configuring the Wireless Network"](#configuring-wireless-network)
4. Configure the device to connect to "XLinkKai" SSID when the pi has booted using Password `XLinkKai`

Note: XLinkKai will only work on one network interface (wifi or ethernet) at a time and will lock onto the first interface connected to from a compatible device until reboot
Expand All @@ -273,8 +262,8 @@ Note: XLinkKai will only work on one network interface (wifi or ethernet) at a t
* An XLink Kai account from http://www.teamxlink.co.uk/

*Steps*
1. Burn the [latest psx-pi-smbshare image](https://github.com/toolboc/psx-pi-smbshare/releases) to a Micro-SD card
2. Configure Wi-fi per the steps above in ["Configuring the Wireless Network"](https://github.com/toolboc/psx-pi-smbshare#configuring-wireless-network)
1. Setup psx-pi-smbshare as described in [Quickstart](#quickstart)
2. Configure Wi-fi per the steps above in ["Configuring the Wireless Network"](#configuring-wireless-network)
3. SSH to you psx-pi-smbshare instance using the default username `pi` and default password `raspberry`
4. Ensure that your PSP is set to Automatic in Network Settings under Ad Hoc Mode
5. Run the following commands to disable the hostapd access point and enable Ad-Hoc Wifi:
Expand Down
12 changes: 0 additions & 12 deletions provisionRelease.sh
View file
Open in desktop

This file was deleted.