Add files via upload

Author: NathanNeurotic

installer_res/1966/INSTALL/APP_NHDDL/NHDDL.ELF

@@ -0,0 +1,256 @@
+# NHDDL — a PS2 launcher for Neutrino
+
+<p align="center">
+  <img src="img/logo/logo.png">
+</p>
+
+NHDDL is a Neutrino launcher that scans MMCE, APA or _FAT/exFAT-formatted_ BDM devices for ISO files,
+lists them and boots selected ISO via Neutrino.  
+
+It displays visual Game ID to trigger per-title settings on the Pixel FX line of products and triggers per-title memory cards on SD2PSX and MemCard PRO2.
+
+Note that this not an attempt at making a Neutrino-based Open PS2 Loader replacement.  
+Since NHDDL only launches Neutrino, PADEMU, IGR, IGS, cheats and other features supported by OPL are _out-of-scope_ unless they are implemented in Neutrino.
+
+## Usage
+
+### Title list controls
+
+ - Press **Up** on the d-pad to select the **previous title** in the list
+ - Press **Down** on the d-pad to select the **next title** in the list
+ - Press **L1** to switch to the **previous page** or go to the **start of the list**
+ - Press **R1** to switch to the **next page** or go to the **end of the list**
+
+### Important notes
+
+NHDDL requires a full [Neutrino](https://github.com/rickgaiser/neutrino) installation to be present at one of the following paths:
+- `<NHDDL launch directory>/neutrino.elf` (__might be case-sensitive__ depending on device)
+- `massX:/neutrino/neutrino.elf` (BDM devices, if any of BDM modes are enabled)
+- `hdd0:/<OPL partition>/neutrino/neutrino.elf` (APA device, if HDL mode is enabled)  
+  `OPL partition` is read from `hdd0:__common/OPL/conf_hdd.cfg`, with `+OPL` or `__common/OPL` used as a fallback
+- `mmceX:/neutrino/neutrino.elf` (MMCE devices, will work even if MMCE mode is _not_ enabled unless MX4SIO mode is set)
+- `mcX:/APPS/neutrino/neutrino.elf` (memory cards, __case-sensitive__)
+- `mcX:/NEUTRINO/NEUTRINO.ELF` (SAS-compliant path on memory cards, __case-sensitive__)
+- `mcX:/NEUTRINO/neutrino.elf` (SAS-compliant path on memory cards, __case-sensitive__)
+
+By default, NHDDL tries to initialize all supported devices. You can override this behavior and reduce initialization times by setting specific mode in launcher configuration file.  
+See [this](#launcher-configuration-file) section for details on `nhddl.yaml`.  
+
+Note that if your ELF loader resets IOP (e.g. `PS2BBL` and recent versions of `wLE_ISR`), NHDDL will try loading `nhddl.yaml` from memory cards and MMCE devices first to avoid
+loading modules for all devices.  
+If `nhddl.yaml` is not present on any of the memory cards or MMCE devices, NHDDL will initialize all modules first and then will attempt to search for `nhddl.yaml` again.
+
+**Do not plug in any BDM storage devices while running NHDDL!**  
+Doing so might crash NHDDL and/or possibly corrupt the files on your target device due to how BDM drivers work.
+
+#### Manual installation
+
+To use NHDDL:
+- Get the [latest `nhddl.elf`](https://github.com/pcm720/nhddl/releases)
+- Copy `nhddl.elf` to your memory card or storage device wherever you want.
+- _Additional step if you need only some of the available modes or MX4SIO support_:  
+  Modify `nhddl.yaml` [accordingly](#launcher-configuration-file) and copy it next to `nhddl.elf`
+- Get the [latest Neutrino release](https://github.com/rickgaiser/neutrino/releases/tag/latest)
+- Copy Neutrino folder to the root of your PS2 memory card or your storage device. 
+
+#### Save Application System PSU
+
+You can also get NHDDL as an easy-to-use PSU package [here](https://pcm720.github.io/nhddl-psu/).  
+To install it:
+- Copy generated `nhddl.psu` to your USB drive
+- Open wLaunchELF on your PS2
+- Choose your USB device and copy `nhddl.psu`
+- Go back and open your memory card (`mc0` or `mc1`)
+- Open file menu and select `psuPaste`
+- Get the [latest Neutrino release](https://github.com/rickgaiser/neutrino/releases/tag/latest)
+- Copy Neutrino folder to the root of your PS2 memory card or your storage device. 
+
+This will install NHDDL to your memory card along with the PS2 Browser icon.
+ 
+Updating `nhddl.elf` is as simple as replacing `nhddl.elf` with the latest version.
+
+### Supported modes
+
+#### ATA
+
+To skip all other devices, `mode: ata` must be present in `nhddl.yaml`.
+
+#### MX4SIO
+
+MX4SIO support requires explicit configuration due to conflicts with memory cards and MMCE devices.  
+`mode: mx4sio` must be present in `nhddl.yaml` on __the memory card__ for MX4SIO to work.  
+
+Note that __MMCE devices will not be available__ when this mode is enabled.
+
+#### USB
+
+Using more than one USB mass storage device at the same time is not recommended.
+To skip all other devices, `mode: usb` must be present in `nhddl.yaml`.
+
+#### UDPBD
+
+To skip all other devices, `mode: udpbd` must be present in `nhddl.yaml`.
+
+UDPBD module requires PS2 IP address to work.  
+NHDDL attempts to retrieve PS2 IP address from the following sources:
+- `udpbd_ip` flag in `nhddl.yaml`
+- `SYS-CONF/IPCONFIG.DAT` on the memory card (usually created by w/uLaunchELF)
+
+`udpbd_ip` flag takes priority over `IPCONFIG.DAT`.
+
+Make sure to set the IP address in Neutrino config files (as of Neutrino 1.6.0, `config/bsd-udpbd.toml`).  
+Consult Neutrino documentation for more details.
+
+#### iLink
+
+To skip all other devices, `mode: ilink` must be present in `nhddl.yaml`.
+
+#### MMCE (SD2PSX, MemCard PRO2)
+
+To skip all other devices, `mode: mmce` must be present in `nhddl.yaml`.
+
+#### HDL (APA-formatted HDD with HD Loader partitions)
+
+Note that HDL backend **does not support** VMCs and virtual HDDs.  
+Cover art and title options will be loaded from one of the following APA partitions:
+- `+OPL`
+- `OPL`
+- `__common`
+
+To skip all other devices, `mode: hdl` must be present in `nhddl.yaml`.
+
+### Storing ISO (MMCE, BDM backends)
+
+ISOs can be stored almost anywhere on the storage device, but no more than 5 directories deep.  
+For example, ISOs stored in `DVD/A/B/C/D` will be scanned and added to the list, but ISOs stored in `DVD/A/B/C/D/E` will be ignored.  
+
+Furthermore, directories that start with `.`, `$` and the following directories are ignored to speed up the scanning process:
+ - `nhddl`
+ - `APPS`
+ - `ART`
+ - `CFG`
+ - `CHT`
+ - `LNG`
+ - `THM`
+ - `VMC`
+ - `XEBPLUS`
+ - `MemoryCards`
+
+### Displaying cover art
+
+NHDDL uses the same file naming convention and file format used by OPL.  
+Just put **140x200 PNG** files named `<title ID>_COV.png` (e.g. `SLUS_200.02_COV.png`) into the `ART` directory on the root of your device.  
+If unsure where to get your cover art from, check out the latest version of [OPL Manager](https://oplmanager.com).
+
+## Configuration files
+
+NHDDL uses YAML-_like_ files to load and store its configuration options.
+
+### Launcher configuration file
+
+Launcher configuration is read from the `nhddl.yaml` file.
+
+Configuration file is loaded from one of the following paths:
+- `<NHDDL launch directory>/nhddl.yaml` (__might be case-sensitive__ depending on device)
+- `massX:/nhddl/nhddl.yaml` (BDM devices, if any of BDM modes are enabled)
+- `hdd0:/<OPL partition>/neutrino/neutrino.elf` (APA device, if HDL mode is enabled)  
+  `OPL partition` is read from `hdd0:__common/OPL/conf_hdd.cfg`, with `+OPL` or `__common/OPL` used as a fallback
+- `mmceX:/nhddl/nhddl.yaml` (MMCE devices, will work even if MMCE mode is _not_ enabled unless MX4SIO mode is set)
+- `mcX:/APP_NHDDL/nhddl.yaml` (memory cards, __case-sensitive__)
+
+This file is _completely optional_ and must be used only to force video mode in NHDDL UI or set NHDDL device mode.  
+By default, default video mode is used and all BDM devices are used to look for ISO files.
+
+To disable a flag, you can just comment it out with `#`.
+
+See [this file](examples/nhddl.yaml) for an example of a valid `nhddl.yaml` file.
+
+### Additional configuration files on storage device
+
+NHDDL stores and looks for ISO-related config files in `nhddl` directory in the root of your BDM drive.  
+
+#### `lastTitle.bin`
+
+This file stores the full path of the last launched title and is used to automatically navigate to it each time NHDDL starts up.  
+This file is created automatically.
+
+#### `cache.bin`
+
+Contains title ID cache for all ISOs located during the previous launch, making building ISO list way faster.  
+This file is also created automatically.
+
+#### Argument files
+
+These files store arbitrary arguments that are passed to Neutrino on title launch.  
+Arguments stored in those files __are passed to `neutrino.elf` as-is__.
+
+_For a list of valid arguments, see Neutrino README._
+
+Example of a valid argument file:
+```yaml
+# All flags are passed to neutrino as-is for future-proofing, comments are ignored
+gc: 2
+mc0: /memcard0.bin # all file paths must be relative to device root
+$mc1: /VMC/memcard1.bin # this argument is disabled
+# Arguments that don't have a value
+# Empty values are treated as a simple flag
+dbc:
+logo:
+```
+
+To be able to parse those arguments and allow you to dynamically enable or disable them in UI,  
+NHDDL uses a dollar sign (`$`) to mark arguments as enabled or disabled by default.  
+Only enabled arguments get passed to Neutrino.
+
+NHDDL supports two kinds of argument files:
+
+#### global.yaml
+
+Arguments stored in `nhddl/global.yaml` are applied to every ISO by default.
+
+#### ISO-specific files
+
+Arguments stored in `nhddl/<ISO name>.yaml` are applied to every ISO that starts with `<ISO name>`.  
+
+NHDDL can create this file automatically when title compatibility modes are modified and saved in UI.
+
+#### Example of directory sturcture on BDM device
+
+```
+ART/ # cover art, optional
+  |
+  - SLUS_200.02_COV.png
+nhddl/
+  |
+   - lastTitle.txt # created automatically
+   - cache.bin # created automatically
+   - global.yaml # optional argument file, applies to all ISOs
+   - nhddl.yaml # NHDDL options, applied after initialization is complete
+   - Silent Hill 2.yaml # optional argument file, applies only to ISOs that start with "Silent Hill 2"
+CD/
+  |
+   — Ridge Racer V.iso
+DVD/
+  |
+   - Silent Hill 2.iso
+   - TimeSplitters.iso
+```
+
+## UI screenshots
+
+<details>
+    <summary>Title list</summary>
+    <img src="img/titles.png">
+</details>
+<details>
+    <summary>Title options</summary>
+    <img src="img/options1.png">
+    <img src="img/options2.png">
+</details>
+
+
+EXAMPLE YAML:
+#video: ntsc # supported video modes: ntsc, pal, 480p
+mode: ata # supported modes: bdm, ata, mx4sio, udpbd, usb, ilink, mmce, hdl. If not present or commented out, all devices will be used to search for ISO files
+mode: mmce # multiple modes are supported via multiple mode strings
+#udpbd_ip: 192.168.1.6 # PS2 IP address for UDPBD mode (commented out)

installer_res/1966/INSTALL/APP_NHDDL/README.md

@@ -0,0 +1,27 @@
+title=[APP] NHDDL
+boot=NHDDL.ELF
+Title=NHDDL
+CfgVersion=8
+$ConfigSource=1
+Version=v1.0
+Package=1.0
+Release=
+Developer=pcm720
+Genre=Homebrew
+Description=A Neutrino launcher
+PlayersText=2
+ParentalText=E
+ScanText=480i
+AspectText=4:3
+Vmode=vmode/ntsc
+VmodeText=NTSC
+RatingText=3
+Parental=esrb/everyone
+Notes=SAS Compliant
+Players=players/1
+Aspect=aspect/s
+Scan=scan/480i
+Device=device/all
+DeviceText=ALL
+Rating=rating/3
+Source=github.com/pcm720/nhddl