Skip to content

Commit

Permalink
Docs: Proofread setup guides (#369)
Browse files Browse the repository at this point in the history
  • Loading branch information
TheTechnician27 authored Feb 2, 2025
1 parent 2a13649 commit 62f3a85
Show file tree
Hide file tree
Showing 6 changed files with 74 additions and 64 deletions.
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ sidebar_position: 1

# Overview

Here you will find various documentation related to the PCSX2 project, intended for both general user and technical audiences.
Here you will find documentation related to the PCSX2 project, intended for general users and technical audiences.

If this article does not help solve your problem, reach out in the [Discord](https://pcsx2.net/discord) channel or the [forum](https://forums.pcsx2.net/).
If this article does not help solve your problem, please reach out to us through our [Discord](https://pcsx2.net/discord) server or on our [forums](https://forums.pcsx2.net/).
28 changes: 13 additions & 15 deletions docs/setup/bios.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,12 @@ In order for PCSX2 to function properly, both a legitimate BIOS and copies of ga

## How to dump your PS2 BIOS

The following explains the recommended ways to accomplish both of these tasks.

Dumping your PS2 BIOS is conceptually a two-step process:

1. Modify the operation of your PS2 so that it can run any program.
2. Then you can run a "BIOS dumper" utility program on your PS2 that reads its BIOS and writes it to a USB drive.
2. Run a "BIOS dumper" utility program on your PS2 that reads its BIOS and writes it to a USB drive.

There is a generally useful program, uLaunchELF, that lets you browse memory cards, DVDs, and USB drives connected to a PS2 and run programs from them. So for most of the approaches below, you use uLaunchELF to then run the BIOS dumper.
There is a generally useful program, uLaunchELF, that lets you browse memory cards, DVDs, and USB drives connected to a PS2 and run programs from them. Most of the approaches below use uLaunchELF to then run the BIOS dumper.

### Popular approaches to modify PS2 operation

Expand All @@ -31,21 +29,21 @@ There is a generally useful program, uLaunchELF, that lets you browse memory car
2. Fortuna Memory Card
- Works for all slim models. Can also be found for ~10 USD.
3. FreeDVDBoot
- Works for many slim models, and some phat models. Slight effort, but free.
- You will require a blank DVD for this method to work!
- Works for many slim models and some fat models. Slight effort, but free.
- You will need a blank DVD for this method to work!
4. Disc swap exploits
- Technical in nature, involves hardware tampering. Guides can be found quickly by Googling.
- Technical in nature, involves hardware tampering. Guides can easily be found online.
5. Mod chips
- Extremely technical, requires soldering skills. DO NOT ATTEMPT unless you are an electronics pro.
:::caution
Due to how modchips operate, it is possible for your BIOS dump to be incomplete or even corrupted while they are active.
To guarantee a proper BIOS dump, first use your modchip to install FMCB or Fortuna. Then disable your modchip\* and use one of the aforementioned exploits to launch biosdrain.
\*Refer to your modchips documentation to see what button combination disables your modchip.
To guarantee a proper BIOS dump, first use your modchip to install FreeMcBoot or Fortuna. Then disable your modchip and use one of the aforementioned exploits to launch biosdrain.
Refer to your modchip's documentation to see what button combination disables your modchip.
:::

### Downloading the BIOS dumper utility

Our recommended BIOS dumper utility is [biosdrain](https://github.com/F0bes/biosdrain). Therefore the instructions below will be for this tool.
Our recommended BIOS dumper utility is [biosdrain](https://github.com/F0bes/biosdrain). The instructions below will be for this tool.

<Image src={require("./img/biosdrain.webp").default} />

Expand All @@ -55,7 +53,7 @@ The download for the latest stable release of biosdrain is [here](https://github

### Option 1: Starting a PS2 with FreeMcBoot

- Plug the FreeMcBoot memory card into memory card port 1
- Plug the FreeMcBoot memory card into memory card slot 1
- Turn on your PS2 with no disc inside.
- Select uLaunchELF from the menu.

Expand All @@ -73,10 +71,10 @@ biosdrain supports USB and HOST through PS2link. If your console does not have n

#### USB

- Take the biosdrain.elf file that was downloaded above, and transfer it to a FAT32 formatted, with MBR Disk type (not GPT) USB flash drive.
- Transfer the biosdrain.elf file to a USB flash drive formatted as FAT32 and MBR (not GPT).

:::note
Please note that some incompatibilities between certain USB drives and PS2 USB drivers have been reported throughout the years. If your USB drive is not detected by uLaunchELF (`mass:` is empty) please try another one, preferably USB 2.0.
Some incompatibilities between certain USB drives and PS2 USB drivers have been reported throughout the years. If your USB drive is not detected by uLaunchELF (`mass:` is empty) please try another one, preferably USB 2.0.
:::

- Insert your USB flash drive into your PS2.
Expand All @@ -88,7 +86,7 @@ biosdrain supports USB and HOST through PS2link. If your console does not have n

#### PS2client / XLINK & PS2link

- When using XLINK, simply execute the `biosdrain.elf` with the user interface.
- When using PS2client, cd into the directory where you have `biosdrain.elf`, and simply run `ps2client execee host:biosdrain.elf`
- When using XLINK, execute the `biosdrain.elf` with the user interface.
- When using PS2client, `cd` into the directory where you have `biosdrain.elf` and run `ps2client execee host:biosdrain.elf`
- biosdrain will automatically detect that the `host` device is present and will dump your BIOS contents to the root directory of `host` **(Usually where you have the biosdrain.elf file)**.
- You will know that it is finished when biosdrain says `Finished Everything`, either on screen or in your console log.
33 changes: 16 additions & 17 deletions docs/setup/dumping.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,19 @@ This section will help you make a backup of your physical game disc to be used o
PlayStation 2 game discs are unencrypted DVDs and CDs. This means they can be dumped quickly using disc ripping software and a standard optical drive that supports DVD and CD optical media. Dumping discs does not harm optical media directly.
:::

## Dumping disc on Windows

:::tip
The lower the drive speed of the optical drive the more likely you are to get a good dump of the disc. The fastest drive speed will take much less time, but may be incomplete, corrupted, or inaccurate. It could also be perfectly fine, so depending on your drive and your media, try different things and see what works best for you.
:::

### Dumping PS2 disc using ImgBurn
## Dumping disc on Windows

### Using ImgBurn

#### Where to get ImgBurn

- We recommend getting ImgBurn via [Ninite](https://ninite.com/imgburn) because the download from the official site **comes with adware in the installer that must be manually unchecked during the install**.

#### How it works
#### How to use it

- Install and run ImgBurn
- Put your game disc into an optical drive
Expand All @@ -40,19 +40,19 @@ On the disc dumping screen:

<Image src={require("./img/imgburn_setting.webp").default} />

Wait for the dumping process to be completed. Depending on the game size, this will take some time.
Wait for the dumping process to complete. Depending on the game size, this will take some time.

<Image src={require("./img/imgburn_dump.webp").default} />

### Alternative: Dumping PlayStation 2 discs with MPF (more advanced)
### Alternative: Using MPF (more advanced)

Media Preservation Frontend (MPF) is a GUI for several applications aimed at preserving optical media. It can be a bit more involved for non-PlayStation disc dumping, but for PS1 and PS2 its fairly simple.
Media Preservation Frontend (MPF) is a GUI for several applications aimed at preserving optical media. It can be a bit more involved for non-PlayStation disc dumping, but it's fairly simple for PS1 and PS2.

#### Where to get MPF

[MPF's GitHub repo](https://github.com/SabreTools/MPF)

This tool is currently only available on Windows, but Linux support may be added in the future. It should be noted the command-line tools that are used for the backend of this tool are all free, open-source and available on all major operating systems.
This tool is currently only available on Windows, but Linux support may be added in the future. The command-line tools that are used for the backend of this tool are all free, open-source, and available on all major operating systems.

#### How to use it

Expand All @@ -68,14 +68,13 @@ This tool is currently only available on Windows, but Linux support may be added

## Dumping disc on Linux

### Dumping PS2 disc using K3b

#### The dumping process
### Using K3b

- You will need to install K3b first. Depending on the distro this process will vary, here are a few examples:
- You will need to install K3b first. This process will vary by distro, but here are a few examples:
- Ubuntu: `sudo apt install k3b`
- Fedora: `sudo dnf install k3b`
- Arch Linux: `sudo pacman -S k3b`
- Many distros have a graphical package manager as well.
- Put your game disc into an optical drive
- Open K3b
- Click on Copy Medium.
Expand All @@ -84,11 +83,11 @@ This tool is currently only available on Windows, but Linux support may be added
<Image src={require("./img/k3b_source.webp").default} />
- Go to the Image tab and determine the destination folder for the dump
<Image src={require("./img/k3b_name.webp").default} />
- Click on Start and wait for the dumping process to be completed. Depending on the game size, this will take some time
- Click on Start and wait for the dumping process to complete. Depending on the game size, this will take some time

<Image src={require("./img/k3b_dumping.webp").default} />

### Dumping PS2 disc using DD (more advanced)
### Using DD (more advanced)

:::caution
DD can cause data loss if not used carefully.
Expand All @@ -97,10 +96,10 @@ You will also need a basic understanding of the Linux terminal.

#### Figuring out the DVD drive location

You will need to figure out the location of your DVD drive first. We will use `lsblk` for that
You will need to figure out the location of your DVD drive first. We will use `lsblk` for that:

- Open up a terminal and run the `lsblk -f` command.
- This will show the list of all drivers that are recognized by Linux:
- Open a terminal and run the `lsblk -f` command.
- This will show the list of all drives that are recognized by Linux:
<Image src={require("./img/lsblk.webp").default} />

:::tip
Expand Down
25 changes: 17 additions & 8 deletions docs/setup/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,29 +9,34 @@ sidebar_position: 5

This section will help you through the process of setting up PCSX2 on Linux.

:::tip
PCSX2 on Linux is officially supported with an AppImage and a Flatpak. PCSX2 is offered as both a Stable build (updated every several months) and as a Nightly build (updated as PCSX2 is developed).
:::

## AppImage

- Head over to the [download page](https://pcsx2.net/downloads) and grab the latest Nightly AppImage build.
- Head over to the [download page](https://pcsx2.net/downloads) and grab the latest AppImage build.
- You will likely have to make the AppImage file executable. There are a few ways to do this:
- Right-click on the AppImage, choose properties, then find the option to mark as executable.
- This will varies from distros to distros (Below is an example for KDE Plasma).
- This will vary between distros (below is an example for KDE Plasma).
<Image src={require("./img/executable.webp").default} />
- Or in a terminal, run `chmod +x <path-to-AppImage-file>`
<Image src={require("./img/chmod.webp").default} />
- You should be able to open the file by double-clicking it or by running it through terminal.
- You should be able to open the file by double-clicking it or by running it through the terminal.
- Follow the setup wizard, and you are ready to play!

## Flatpak

- PCSX2 is also available on [Flatpak](appstream:net.pcsx2.PCSX2)!
- In order to install PCSX2 from Flatpak using the command line, open the terminal and type `flatpak install net.pcsx2.PCSX2`.
- PCSX2 is available on [Flathub](appstream:net.pcsx2.PCSX2)!
- In order to install PCSX2 from Flathub using the command line, open the terminal and type `flatpak install net.pcsx2.PCSX2`.

- Typing `flatpak install pcsx2` should find this same reference.
- When asked if you want to proceed, type `Y` and press Enter.
- PCSX2 is now installed on your machine!

<Image src={require("./img/flatpakinstall.webp").default} />

- Some distributions and desktop environments have a visual software manager which can also install Flatpak applications.
- Some distributions and desktop environments have a graphical package manager which can also install Flatpak applications.

- These include:
- KDE Plasma's Discover
Expand All @@ -45,10 +50,14 @@ This section will help you through the process of setting up PCSX2 on Linux.
- If you want to exclusively update PCSX2, you can type `flatpak update net.pcsx2.PCSX2`.
- You will be asked if you would like to proceed. Type `Y` and press Enter.

- That's all there is to it!
- Follow the setup wizard, and you are ready to play!

:::note
The Flatpak is also available for [direct download](https://pcsx2.net/downloads). To install it, download the Flatpak file and type `flatpak install <path-to-Flatpak-file>` in the terminal. Downloading from Flathub as described previously is recommended for most Flatpak users.
:::

## Build from source (Advanced users)

:::tip
For more details on building from source for Linux (or even Windows), check out our [GitHub Wiki](https://github.com/PCSX2/pcsx2/wiki/10-Building-on-Linux).
For details on building PCSX2 from source, check out our [GitHub Wiki](https://github.com/PCSX2/pcsx2/wiki/10-Building-on-Linux).
:::
24 changes: 12 additions & 12 deletions docs/setup/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ toc: true
sidebar_position: 1
---

This section list down the system requirements to get PCSX2 up and running.
This section lists the system requirements to get PCSX2 up and running.

## System Requirements

Expand All @@ -19,11 +19,11 @@ This section list down the system requirements to get PCSX2 up and running.
- macOS 11.0 (Big Sur)
- CPU

- Supports SSE4.1
- SSE4.1 support
- [PassMark single thread performance](https://www.cpubenchmark.net/singleThread.html) rating near or greater than 1500
- A quick reference for CPU **intensive games**: [Wiki](https://wiki.pcsx2.net/Category:CPU_intensive_games), [Forum](https://forums.pcsx2.net/Thread-LIST-The-Most-CPU-Intensive-Games)
- And CPU **light** games: [Forum](https://forums.pcsx2.net/Thread-LIST-Games-that-don-t-need-a-strong-CPU-to-emulate)
- Two physical cores, with SMT
- Two physical cores, with simultaneous multithreading (SMT)
:::note
Recommended single thread performance is based on moderately complex games. Games that pushed the PS2 hardware to its limits will struggle on CPUs at this level. Some release titles and 2D games which underutilized the PS2 hardware may run on CPUs rated as low as 1200.
:::
Expand All @@ -49,11 +49,11 @@ This section list down the system requirements to get PCSX2 up and running.
- Ubuntu 24.04/Debian or newer, Arch Linux, or other distro (64-bit)
- macOS 11.0 (Big Sur)
- CPU
- Supports AVX2
- AVX2 support
- [PassMark single thread performance](https://www.cpubenchmark.net/singleThread.html) rating near or greater than 2000
- Four physical cores, with or without SMT
- Four physical cores, with or without simultaneous multithreading (SMT)
- GPU
- Direct3D12 support
- Direct3D 12 support
- OpenGL 4.6 support
- Vulkan 1.3 support
- Metal support
Expand All @@ -69,21 +69,21 @@ This section list down the system requirements to get PCSX2 up and running.
- Ubuntu 24.04/Debian or newer, Arch Linux, or other distro (64-bit)
- macOS 11.0 (Big Sur)
- CPU
- Supports AVX2
- AVX2 support
- [PassMark single thread performance](https://www.cpubenchmark.net/singleThread.html) rating near or greater than 2600
- Six physical cores, with SMT
- Six physical cores, with simultaneous multithreading (SMT)
- GPU
- Direct3D12 support
- Direct3D 12 support
- OpenGL 4.6 support
- Vulkan 1.3 support
- Metal support
- [PassMark G3D Mark](https://www.videocardbenchmark.net/high_end_gpus.html) rating around 12,000 (GeForce RTX 3050, Radeon RX 5600XT)
- 4 GB of Video Memory
- 4 GB video memory
- RAM
- 16 GB of System Memory
- 16 GB system memory

## Version deprecation notes

- Windows XP and Direct3D9 support was dropped after stable release 1.4.0.
- Windows XP and Direct3D 9 support was dropped after stable release 1.4.0.
- Windows 7, Windows 8.0, and Windows 8.1 support was dropped after stable release 1.6.0.
- 32-bit support was dropped after stable release 1.6.0.
24 changes: 14 additions & 10 deletions docs/setup/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,43 +12,47 @@ This section will help you through the process of setting up PCSX2 on Windows.
## Required software

:::tip
Make sure to install all the required software-first before proceeding with the setup.
Make sure to install all the required software first before proceeding with the setup.
:::

### Visual C++ redistributable

- You need the [Visual C++ 2019 x86 Redistributables](https://support.microsoft.com/en-us/help/2977003/) to run PCSX2.
- They are combined with other yearly releases Visual Studio 2015, 2017, 2019, and 2022. 64-bit version (x64) is required for 1.7.0 and higher (though early 1.7 builds still required 32 bit versions)
- You need [the latest x64 Visual C++ runtime](https://support.microsoft.com/en-us/help/2977003/) to run PCSX2.

### FFmpeg (Optional)

- PCSX2 requires some additional FFmpeg libraries to enable video capture.
- Grab the FFmpeg Windows files [here](https://github.com/PCSX2/pcsx2-windows-dependencies/releases/download/FFMPEG/ffmpeglibs-7.0.2.7z).
- Extract the zip file, then place the extracted dll files in your PCSX2 folder. They should be in the same folder as the main PCSX2 exe file.
- Extract the `.zip` file, then place the extracted `.dll` files in your PCSX2 folder. They should be in the same folder as the main PCSX2 `.exe` file.

## Setup process

### Extracting PCSX2

:::tip

- Head over to the [download page](https://pcsx2.net/downloads) and grab the latest Nightly build if you haven't done so already!

:::
- Head over to the [download page](https://pcsx2.net/downloads) and grab the latest build if you haven't done so already! PCSX2 is offered as both a Stable build (updated every several months) and as a Nightly build (updated as PCSX2 is developed).
:::

- Use [7-Zip](https://www.7-zip.org/download.html) to extract the `.7z` archive.

- Install 7-Zip.
- Right click on the archive.
- Right-click on the archive.
- Find the entry for 7-Zip.
- Click on `Extract to [folder name] option.`
<Image src={require("./img/extract.webp").default} />
- This will extract PCSX2 to the same directory where you put the `.7z` file.
- This will extract PCSX2 to the same folder where you put the `.7z` file.

### Launching PCSX2

- Run the `pcsx2-qt.exe` file
<Image src={require("./img/run.webp").default} />

- Follow the setup wizard and you are ready to play!
- Follow the setup wizard, and you are ready to play!
<Image src={require("./img/wizard.webp").default} />

## Build from source (Advanced users)

:::tip
For details on building PCSX2 from source, check out our [GitHub Wiki](https://github.com/PCSX2/pcsx2/wiki/12-Building-on-Windows).
:::

0 comments on commit 62f3a85

Please sign in to comment.