Skip to content

Commit

Permalink
Docs: General Updates (#325)
Browse files Browse the repository at this point in the history
  • Loading branch information
kamfretoz authored Jun 15, 2024
1 parent 8045815 commit e24f872
Show file tree
Hide file tree
Showing 14 changed files with 148 additions and 58 deletions.
16 changes: 13 additions & 3 deletions docs/post/controllers.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Only use if you are having issues with SDL or XInput.

## Mapping the buttons

To start mapping your controller, you can first check if your controller is availale for automatic mapping by clicking on the "Automatic Mapping" button on the top right. If automatic mapping is not available, you will have to map the buttons to your controller manually.
To start mapping your controller, you can first check if your controller is available for automatic mapping by clicking on the "Automatic Mapping" button on the top right. If automatic mapping is not available, you will have to map the buttons to your controller manually.

:::caution
Automatic Mapping is not available for controllers using the DInput source.
Expand All @@ -73,7 +73,7 @@ Some third party controllers may fail to map using Automatic Mapping, even with

:::info
PCSX2 currently doesn't have any way to test your inputs directly from the UI.
:::info
:::

To test your controller input, grab this [PS2 Pad Tester ELF](https://github.com/PCSX2/tools/releases/download/tests%2Fpad/padtest_ps2.elf) file then drag and drop it into PCSX2's main window.

Expand All @@ -93,14 +93,24 @@ Only the original DualShock 3 OEM controllers are compatible with pressure sensi

This allows you to take advantage DualShock 3's pressure sensitive face button on PCSX2.

Follow this step:
### Windows

1. Install [DsHidMini](https://forums.pcsx2.net/Thread-DsHidMini-Windows-10-driver-for-the-DualShock-3)
2. Set DsHidMini to SXS mode
3. Drop DsHidMini's custom XInput DLL into the PCSX2 folder
4. Enable the XInput source in PCSX2
5. Use "Automatic Binding" button and select XInput

### Linux and Mac (Experimental)

The auto binding system doesn't fully support it, but the backend does.

- Bind all your keys, then close PCSX2 and edit the `PCSX2.ini` file to delete all the buttons and change all the axes from `-Axis##` or `+Axis##` to `FullAxis##`

:::caution
On Linux, [you may need to add udev rules to give PCSX2 access to the controller](https://wiki.rpcs3.net/index.php?title=Help:Controller_Configuration#On_Linux).
:::

## Multitap

Multitaps are physical devices sold separately for the Playstation 2. A multitap fills both a controller and memory card port, and expands those out to four controller and memory card slots each.
Expand Down
2 changes: 2 additions & 0 deletions docs/post/general.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ Go to `Settings > Game Properties`

## Portable mode

### What is Portable mode?

Portable mode allows you to confine all of PCSX2's related data and configuration into its own folder instead of using the user's Documents folder, essentially making it "Portable".

- To enable portable mode, simply create an empty `portable.ini` file in the root directory of your PCSX2 folder.
Expand Down
127 changes: 127 additions & 0 deletions docs/setup/dumping.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
---
title: "Dumping Discs"
date: 2024-03-20
summary: "Steps on how to dump your PS2 discs"
draft: false
toc: true
sidebar_position: 3
---

This section will help you make a backup of your physical game disc to be used on PCSX2.

:::info
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

#### 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

- Install and run ImgBurn
- Put your game disc into an optical drive
- Create an image file from a disc inside ImgBurn (highlighted in screenshot below)

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

### Alternative: Dumping PlayStation 2 discs with 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.

#### 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.

#### How to use it

- Extract and run MPF
- Put your game disc into an optical drive
- Select PS2 for system/media type
- Select whether it is a CD-ROM PS2 game or DVD-ROM PS2 game
- Select output file name and directory
- Select the appropriate drive letter for the drive with the optical media in it
- Select "Start dumping"

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

## Dumping disc on Linux

### Dumping PS2 disc using K3b

#### The dumping process

- You will need to install K3b first. Depending on the distro this process will vary, here are a few examples:
- Ubuntu: `sudo apt install k3b`
- Fedora: `sudo dnf install k3b`
- Arch Linux: `sudo pacman -S k3b`
- Put your game disc into an optical drive
- Open K3b, and you will be greeted with this screen:
<Image src={require("./img/k3b.webp").default} />

- Click on Copy Medium.
- Make sure your disc is selected and enable the "Only Create Image" option.
<Image src={require("./img/k3b_source.webp").default} />

- Go to the Image tab and define 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.

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

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

:::caution
DD can cause data loss if not used carefully.
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.

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

:::tip
CD and DVD drives on Linux are usually located either in `/dev/cdrom0` or `/dev/sr0` respectively.
:::

We have now identified the location of our DVD drive, in our example it is in `/dev/sr0`

#### Dumping the disc

- Run `dd` with the following Syntax:

```bash
dd if=[DRIVE_NAME] of=./[IMAGE_NAME].iso status=progress

WHERE:
[DRIVE_NAME] = DVD Drive location (/dev/sr0).
[IMAGE_NAME] = The name for the ISO.

NOTE: DO NOT include the brackets
```

- This will dump the disc into the current directory.
- An example of a complete command:

```bash
dd if=/dev/sr0 of=./GT3.iso status=progress
```

Now wait until the dumping process is completed.

<Image src={require("./img/dd_dump.webp").default} />
45 changes: 2 additions & 43 deletions docs/setup/gather.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Gathering Files"
title: "Dumping BIOS"
date: 2024-03-20
summary: "Steps on how to gather required files for you to be able to use PCSX2"
draft: false
toc: true
sidebar_position: 2
---

This section will help you gather all the required files needed for PCSX2 to run.
This section will help you dump the BIOS files that are required for PCSX2 to run.

:::caution
In order for PCSX2 to function properly, both a legitimate BIOS and copies of games must be obtained from **your own** PlayStation 2 console and original PlayStation 2 discs respectively.
Expand Down Expand Up @@ -92,44 +92,3 @@ biosdrain supports USB and HOST through PS2link. If your console does not have n
- When using PS2client, cd into the directory where you have `biosdrain.elf`, and simply 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.

## Dumping PS2 Discs via ImgBurn

PlayStation 2 game discs are unencrypted DVDs and CDs. This means they can be dumped quickly using a standard optical drive that supports DVD and CD optical media and the ImgBurn software. Dumping discs does not harm optical media directly.

### Where to get ImgBurn

- Via [Ninite](https://ninite.com/imgburn) (Recommended, safe and fast):
- Via [ImgBurn](http://www.imgburn.com/index.php?act=download) themselves (Not recommended, comes with adware in the installer that must be manually unchecked during the install):

### How it works

- Install and run ImgBurn
- Put your game disc into an optical drive
- Create an image file from a disc inside ImgBurn (highlighted in screenshot below)

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

## Alternative: Dumping PlayStation 2 discs with Media Preservation Frontend (more advanced)

This 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.

### 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.

### How to use it

- Extract and run MPF
- Put your game disc into an optical drive
- Select PS2 for system/media type
- Select whether it is a CD-ROM PS2 game or DVD-ROM PS2 game
- Select output file name and directory
- Select the appropriate drive letter for the drive with the optical media in it
- Select "Start dumping"

One quick note, 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.

<Image src={require("./img/MPF.webp").default} />
Binary file added docs/setup/img/dd_dump.webp
Binary file not shown.
Binary file added docs/setup/img/k3b.webp
Binary file not shown.
Binary file added docs/setup/img/k3b_dumping.webp
Binary file not shown.
Binary file added docs/setup/img/k3b_name.webp
Binary file not shown.
Binary file added docs/setup/img/k3b_source.webp
Binary file not shown.
Binary file added docs/setup/img/lsblk.webp
Binary file not shown.
10 changes: 1 addition & 9 deletions docs/setup/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ date: 2024-03-20
summary: "Steps on how to install and run PCSX2 on Linux"
draft: false
toc: true
sidebar_position: 4
sidebar_position: 5
---

This section will help you through the process of setting up PCSX2 on Linux.
Expand Down Expand Up @@ -52,11 +52,3 @@ This section will help you through the process of setting up PCSX2 on Linux.
:::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).
:::

- PCSX2 can be built from source using **Ninja**.
- This method is not recommended for inexperienced users and assumes you know how to navigate directories from the command line.
- To obtain the source code from the command line, type `git clone https://github.com/PCSX2/pcsx2 --recurse`.
- Next, enter the `pcsx2` directory you created and type `cmake --preset=clang-release`.
- Finally, enter the `build` subdirectory which was just created and enter the command `ninja`.
- This will build PCSX2, which could take several minutes depending on your CPU.
- After the build is compiled, the executable file `pcsx2-qt` will be in the `build/bin` directory.
2 changes: 1 addition & 1 deletion docs/setup/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ date: 2024-03-20
summary: "Steps on how to install and run PCSX2 on Windows"
draft: false
toc: true
sidebar_position: 3
sidebar_position: 4
---

This section will help you through the process of setting up PCSX2 on Windows.
Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ toc: true
sidebar_position: 4
---

Here are some known Linux-specific issue that can happen to PCSX2
Here are some known Linux-specific issue that can occur.

### libfuse2

Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ toc: true
sidebar_position: 3
---

Here are some known Windows-specific issue that can happen to PCSX2
Here are some known Windows-specific issue that can occur.

## Missing "MSVCP140.dll"

Expand Down

0 comments on commit e24f872

Please sign in to comment.