Skip to content

Commit b491c1c

Browse files
JaajeesJaajees
authored
General readme update (#1597)
* Small update to the USB description Add information about EXFAT support on USB devices * Improve README formatting for device support section Reformat device support list and clarify formats. * Format README again Format README again * Enhance README formatting and add logo Updated README to improve formatting and clarity. * Fix a Minor error * Re format * App addition instructions Added details on adding apps. * Minor fixes * Minor Fixes Updated formatting and corrected file names in the README. * Minor fixes Correct formatting of instructions for adding ELF files. * ...
1 parent e4144bd commit b491c1c

File tree

1 file changed

+105
-15
lines changed

1 file changed

+105
-15
lines changed

‎README.md‎

Lines changed: 105 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Open PS2 Loader
22

3+
![logo](https://github.com/ps2homebrew/Open-PS2-Loader/blob/master/gfx/logo.png)
4+
35
Copyright 2013, Ifcaro & jimmikaelkael
46
Licensed under Academic Free License version 3.0
57
Review the LICENSE file for further details.
@@ -12,23 +14,36 @@ Review the LICENSE file for further details.
1214
## Introduction
1315

1416
Open PS2 Loader (OPL) is a 100% Open source game and application loader for
15-
the PS2 and PS3 units. It supports five categories of devices: USB mass
16-
storage devices, MX4SIO (SD card connected to memory card port via adapter), iLink (SBP2 compliant storage devices via IEE1394), SMBv1 shares and the PlayStation 2 HDD unit.
17-
USB/SMB/MX4SIO/iLink support both USBExtreme and \*.ISO formats while PS2 HDD supports HDLoader format,
18-
all devices also support ZSO format (compressed ISO). It's now the most compatible homebrew loader.
17+
the PS2 and PS3 units.
1918

20-
OPL is developed continuously - anyone can contribute improvements to the project due to its open-source nature.
19+
It supports five categories of devices:
2120

22-
You can visit the Open PS2 Loader forum at:
21+
1. USB mass storage devices;
22+
2. MX4SIO (SD card connected to memory card port via adapter);
23+
3. iLink (SBP2 compliant storage devices via IEE1394);
24+
4. SMBv1 shares;
25+
5. ATA/IDE HDDs.
2326

24-
<https://www.psx-place.com/forums/open-ps2-loader-opl.77/>
27+
All of the devices mentioned above support multiple file formats, including:
2528

26-
You can report compatibility game problems at:
29+
- ISO;
30+
- ZSO (Compressed ISO);
31+
- USB Extreme (ul);
32+
- Homebrews (Apps) in ELF format;
33+
- HDDs support the HDLoader format.
2734

28-
<https://www.psx-place.com/threads/open-ps2-loader-game-bug-reports.19401/>
35+
It's now the most compatible homebrew loader.
2936

30-
For an updated compatibility list, you can visit the OPL-CL site at:
37+
>[!NOTE]
38+
OPL is developed continuously - anyone can contribute improvements to the project due to its open-source nature.
39+
40+
You can visit the Open PS2 Loader forum at:\
41+
<https://www.psx-place.com/forums/open-ps2-loader-opl.77/>
3142

43+
You can report compatibility game problems at:\
44+
<https://www.psx-place.com/threads/open-ps2-loader-game-bug-reports.19401/>
45+
46+
For an updated compatibility list, you can visit the OPL-CL site at:\
3247
<http://sx.sytes.net/oplcl/games.aspx>
3348

3449
<details>
@@ -66,6 +81,7 @@ USB modes:
6681
| `THM` | for themes support | all |
6782
| `LNG` | for translation support | all |
6883
| `CHT` | for cheats files | all |
84+
| `APPS` | for ELF files | all |
6985

7086
OPL will automatically create the above directory structure the first time you launch it and enable your favorite device.
7187

@@ -80,15 +96,19 @@ HDDs are also able to be formatted as exFAT to avoid the 2TB limitation. Please
8096

8197
<details>
8298
<summary> <b> USB/MX4SIO/iLink </b> </summary>
99+
<p>
83100

101+
Supported file systems:
102+
EXFAT (since OPL v1.2.0 beta - rev1880) and FAT32, both use the MBR partition table
84103

85-
Game files should be *ideally* defragmented either file by file or by whole drive,
86-
and games larger than 4gb must use USBExtreme format if device uses FAT32 format (see OPLUtil or USBUtil programs).
87-
We do **not** recommend using any defrag programs. The best way for defragmenting - copy all files to pc, format USB, copy all files back.
88-
Repeat it once you faced defragmenting problem again.
104+
Game files should be *ideally* defragmented either file by file or by whole drive.
105+
106+
> NOTE: Partial file fragmentation is supported (up to 64 fragments!) since OPL v1.2.0 beta - rev1893
89107
90-
> NOTE: partial file fragmentation is supported (up to 64 fragments!) since OPL v1.2.0 - rev1893
108+
If you choose to use the FAT32 file system, games larger than 4gb must use USBExtreme format (see OPLUtil or USBUtil programs).
91109

110+
We do **not** recommend using any defrag programs. The best way for defragmenting - copy all files to pc, format USB, copy all files back.
111+
Repeat it once you faced defragmenting problem again.
92112

93113
</p>
94114
</details>
@@ -120,6 +140,76 @@ For PS2, 48-bit LBA internal HDDs are supported. The HDD can be formatted as:
120140
</p>
121141
</details>
122142

143+
<details>
144+
<summary> <b> APPS </b> </summary>
145+
<p>
146+
147+
There are two methods to add apps to OPL.
148+
149+
### conf_apps.cfg method (Legacy)
150+
151+
Composed of two parts separated by an "=" sign\
152+
Where, the first part consists of the name that will appear in your OPL apps list.\
153+
And the second part consists of the path to the ELF.
154+
155+
To begin:
156+
157+
1. Create a text file called `conf_apps.cfg`.
158+
2. In this file, put the name you want to appear in the list of apps, followed by the "=" sign.
159+
3. Put the device identifier
160+
(for a USB device it would be `mass:`, for MemoryCard it would be `mc:`, and so on for other devices)\
161+
And finally path to the desired ELF
162+
163+
> NOTE: Be careful to enter the exact path, OPL is case sensitive
164+
165+
The structure should look like this:
166+
167+
```
168+
My App Name=mass:APPS/MYAPP.ELF
169+
```
170+
171+
let's use OPL itself as an example:
172+
173+
```
174+
OPL=mass:APPS/OPNPS2LD.ELF
175+
```
176+
177+
With this method the ELFs don't need to be in the APPS folder, but keeping them there helps keep everything organized.
178+
179+
the conf_apps.cfg file must be in the OPL folder, on your MemoryCard.\
180+
Or at the root of the storage device
181+
182+
183+
### title.cfg method
184+
185+
Also composed of two parts, or to be more exact, two lines
186+
Where, in the first line we put the name that will appear in the list of apps, and in the second line we put the ELF
187+
188+
To begin:
189+
190+
1. In the APPS folder, create a new folder with the name of the ELF you want to add
191+
2. In this new folder, place the ELF and create also a text file called `title.cfg`.
192+
3. In that file, add the following instructions:
193+
194+
```
195+
title=My App Name
196+
boot=MYAPP.ELF
197+
```
198+
199+
Using OPL again as an example:
200+
201+
```
202+
title=Open PS2 Loader
203+
boot=OPNPS2LD.ELF
204+
```
205+
206+
I would like to emphasize that in this method it is necessary that the ELF file and the title.cfg file must be in a folder, within the APPS folder.
207+
208+
> NOTE: In both methods, it is necessary attention to the file names, because, as already mentioned: OPL is case sensitive.
209+
210+
</p>
211+
</details>
212+
123213
<details>
124214
<summary> <b> Cheats </b> </summary>
125215
<p>

0 commit comments

Comments
 (0)