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.

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

[skip ci] PCSX2 1.6 Documentation Overhaul #3139

Merged
merged 46 commits into from Feb 10, 2020
Merged
Changes from 1 commit
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
b550469
PCSX2 FAQ, attempt 1
RedPanda4552 Oct 24, 2019
5fc004d
Add pgert's memcard/BIOS guides
RedPanda4552 Oct 27, 2019
9efcbe1
First attempt at project readme rewrite
RedPanda4552 Oct 27, 2019
735393e
Use requirements table made for readme
RedPanda4552 Oct 27, 2019
b31c879
Reference BIOS guide links in body
RedPanda4552 Oct 27, 2019
ddf907e
Update year on license template
RedPanda4552 Oct 27, 2019
2b04cf9
Remove old 1.2 release notes
RedPanda4552 Oct 27, 2019
caaa2c7
Not using word docs, remove instructions
RedPanda4552 Oct 27, 2019
831e0f7
Replaced by markdown file
RedPanda4552 Oct 27, 2019
c44648b
LT's review
RedPanda4552 Nov 2, 2019
fb7a2da
Kojin's word recommendation
RedPanda4552 Nov 23, 2019
b3da36f
Start a Windows config guide
RedPanda4552 Nov 23, 2019
90cbb62
Rework CPU core note
RedPanda4552 Nov 24, 2019
743182e
How's this for a lower STR notice?
RedPanda4552 Nov 28, 2019
ce379cf
Typo
RedPanda4552 Nov 28, 2019
a004b1b
Add GitHub issues to contributing section
RedPanda4552 Dec 1, 2019
e822c38
Single tier list, make GitHub happy
RedPanda4552 Dec 1, 2019
1d591ee
Update tested games count
RedPanda4552 Dec 1, 2019
ec1a391
Merge bosit's requirements suggestions
RedPanda4552 Dec 1, 2019
e91d2b5
Fix URL format
RedPanda4552 Dec 1, 2019
27bf4fd
Windows Config Guide + Break out setting details to new doc
RedPanda4552 Dec 1, 2019
3d6dcc5
Various proofs
RedPanda4552 Dec 23, 2019
0b8945b
And more proofs
RedPanda4552 Dec 23, 2019
4f98d55
Remove "Windows", this applies to Linux too.
RedPanda4552 Jan 2, 2020
051b4aa
Scrap the insane details file
RedPanda4552 Feb 5, 2020
106fe3b
Fix the fixmes
RedPanda4552 Feb 5, 2020
aa2d687
Reduce image size slightly
RedPanda4552 Feb 5, 2020
8ea324a
Spacing
RedPanda4552 Feb 5, 2020
39092bc
HTML conversions because PDF page breaks are terrible
RedPanda4552 Feb 5, 2020
095762b
Remove hw hacks from path to blending
RedPanda4552 Feb 5, 2020
855c2a7
Comments tell the story
RedPanda4552 Feb 5, 2020
588c5e9
But actually we have PDFs instead of HTML now
RedPanda4552 Feb 5, 2020
cb132b3
First time setup panel
RedPanda4552 Feb 5, 2020
738b3c2
Tabs instead of spaces cause LT is dumb
RedPanda4552 Feb 6, 2020
2e97124
PCSX2 Documentation Overhaul for 1.6 Release
RedPanda4552 Oct 24, 2019
6316b1c
Adjust first time setup panel to match new doc locations
RedPanda4552 Feb 5, 2020
4ecfafd
Move final PDFs to bin
RedPanda4552 Feb 9, 2020
b79b11b
Lightning Review
RedPanda4552 Feb 9, 2020
aa70bcb
Move final PDFs to bin
RedPanda4552 Feb 9, 2020
4ddd46b
Lightning Review
RedPanda4552 Feb 9, 2020
94b4d56
Fix note spaces
RedPanda4552 Feb 9, 2020
2394bd7
Merge branch 'docs' of https://github.com/RedPanda4552/pcsx2 into docs
RedPanda4552 Feb 9, 2020
1f21abe
Bigger screenshots
RedPanda4552 Feb 9, 2020
5d525a7
And finalize PDFs again
RedPanda4552 Feb 9, 2020
a71c07b
Version
RedPanda4552 Feb 9, 2020
f96f8e4
Use RedDevilus' PDF fixes
RedPanda4552 Feb 10, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Next
PCSX2 FAQ, attempt 1
  • Loading branch information
RedPanda4552 committed Oct 24, 2019
commit b550469489c2893ad70d00b978b3f89480d672dc
@@ -0,0 +1,215 @@
# PCSX2 - Frequently Asked Questions

---
## About the PCSX2 Project

### What is the purpose of the PCSX2 project?
PCSX2 intends to emulate the PlayStation 2 console, allowing PS2 games to be played on a PC. This requires having an original PlayStation 2 console to supply a BIOS dump, and of course the original games to either be played directly off the disc, or be dumped and played as ISO images.

### Is PCSX2 open source?
PCSX2 is open source, licensed under the GNU General Public License, v3. [Source code is kept on GitHub](https://github.com/pcsx2/pcsx2).


### How can I help the project?
There are a number of ways to help the project, whether it be bug reporting, game patching, or even writing code for the emulator itself. Some examples:

* Want to make changes to emulator code? [Check out the issue tracker](https://github.com/PCSX2/pcsx2/issues), or [fork the PCSX2 repository and work on your own ideas](https://github.com/PCSX2/pcsx2).
* Want to patch games? [Check out the cheats and patches forum thread for inspiration](https://forums.pcsx2.net/Thread-Post-your-PCSX2-cheats-patches-here). There are other threads to find as well, [such as those dedicated to 60 FPS patches](https://forums.pcsx2.net/Thread-60-fps-codes) or [widescreen patches](https://forums.pcsx2.net/Thread-PCSX2-Widescreen-Game-Patches).
* Want to report bugs you have discovered in your games? [Head over to the Bug Reporting section of the PCSX2 forums](https://forums.pcsx2.net/Forum-Bug-reporting).

Copy link
Member

@tadanokojin tadanokojin Nov 2, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe a section on how to report an issue (link to how to make gs dump etc) or link to our issue guidelines

### Is PCSX2 ready to run out-of-the-box?
No, PCSX2 is not ready to run immediately. First, you must dump your PlayStation 2 console's BIOS using the BIOS dumper. The BIOS dumper is [available on the PCSX2 website](https://pcsx2.net/download/releases/tools.html).

After dumping your PlayStation 2 console's BIOS, you may launch PCSX2, step through the first time setup wizard, and then begin playing.

---
## Technical Details of PCSX2

### What are the PC requirements to use PCSX2?

#### Minimum

##### Operating System
* Windows 8.1 or newer (32 or 64 bit)
* Ubuntu/Debian 18.04 or newer, Arch Linux, or other distro (32 or 64 bit)

##### CPU
* Supports SSE2
* [Passmark Single Thread Performance](https://www.cpubenchmark.net/singleThread.html) rating near or greater than 1600
* Two physical cores, with hyperthreading

##### GPU
* Direct3D11 support
* OpenGL 3.x support
* [PassMark G3D Mark](https://www.videocardbenchmark.net/high_end_gpus.html) rating around 2000 (GeForce GTX 860m)
* 2 GB Video Memory

##### RAM
* 4 GB

Copy link
Member

@tadanokojin tadanokojin Nov 2, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe installation instructions for common OS

  • arch
  • debian/ubuntu
  • windows
  • fedora (think there is a community package for it in copr or something)

I know for example ubuntu might be kind of annoying because of multilib

Copy link

@mirh mirh Dec 6, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mentioning each linux distro in the readme may be a bit too "heavy".
Maybe there could be a link over "linux" which points to a wiki page detailing every one.

#### Recommended

##### Operating System
* Windows 10 (64 bit)
* Ubuntu/Debian 19.04 or newer, Arch Linux, or other distro (32 or 64 bit)

##### CPU
* Supports AVX2
* [Passmark Single Thread Performance](https://www.cpubenchmark.net/singleThread.html) rating greater than 2100
* Four physical cores, with or without hyperthreading

##### GPU
* Direct3D11 support
* OpenGL 4.5 support
* For 1080p resolution:
* [PassMark G3D Mark](https://www.videocardbenchmark.net/high_end_gpus.html) rating around 5000 (GeForce GTX 1050 Ti)
* 4 GB Video Memory
* For 4K resolution:
* [PassMark G3D Mark](https://www.videocardbenchmark.net/high_end_gpus.html) rating around 12000 (GeForce GTX 1070 Ti)
* 8 GB Video Memory

##### RAM
* 8 GB

### How many CPU cores can PCSX2 use?
By default, PCSX2 uses two cores for emulation. Enabling the MTVU speedhack allows the PS2's VU1 coprocessor to run on a third core, which is safe for most games.

Software rendering in GSdx can be set to use as many or as few rendering threads as desired. We recommend using no more than 8, or the number of cores (including hyperthreads) that your CPU has, whichever is the lower number.

### My CPU isn't being used 100%. Why?
The CPU load as reported in software such as Windows' Task Manager is usually a *summation* of CPU usage, across *all* cores. Software can only use the resources of the individual CPU cores it is actually running on, and cannot "borrow" CPU time from other cores.

### Will SLI or Crossfire help with performance?
No. PCSX2 does not use or require SLI or Crossfire.

### How do I check if a game is playable?
The PCSX2 website has a [compatibility list](https://pcsx2.net/compatibility-list.html) with every game that has been tested.

### Do PS1 (PSX) games work on PCSX2?

lightningterror marked this conversation as resolved.
Show resolved Hide resolved
#### If you want to enjoy your PS1 games without issues
lightningterror marked this conversation as resolved.
Show resolved Hide resolved
No, they will not work. Please use a proper PS1 emulator, such as Mednafen.

#### If you are a tinkerer and like to break things
PS1 games may work on PCSX2, but compatibility is very limited. Specific settings are often required to get a game to boot, and there are other universal problems including missing and pitch shifted audio, and severe FMV corruption. A [forum thread for PS1 compatibility](https://forums.pcsx2.net/Thread-PSX-Mode-Unofficial-Compatibility-List) is tracking some fixes and compatibility reports.
lightningterror marked this conversation as resolved.
Show resolved Hide resolved

*While we encourage discussion about PS1 games and improving compatibility, bug reports are NOT being accepted for PS1 games. Any reports for PS1 games will be closed immediately as invalid.*

### My game doesn't work like it did in an earlier PCSX2 version. Why?
One change to the emulator may fix one game, but cause problems for another. If the issue is severe and not fixable with different settings, you can always revert back to the last known PCSX2 version to work, and report the build number that broke the game. [Development builds](https://pcsx2.net/download/development.html) are very helpful for finding the exact change that caused a regression.

### Why is PCSX2 slow?
The PlayStation 2 is a complex console, and this complexity substantially raises the PC requirements to emulate it at full speed, accurately. [This forum thread](https://forums.pcsx2.net/Thread-Why-is-PCSX2-slow) helps explain some of the technical reasons behind it, and our current guidelines for PC requirements are listed above.

### Where do I get a PS2 BIOS?
You have to dump the BIOS files from your PlayStation 2 console. There is a BIOS dumper tool [available on the PCSX2 website](https://pcsx2.net/download/releases/tools.html) to do this.

### Where do I get PS2 games?
You can use games from your personal collection of discs, purchase them from local stores that resell old games, or look online at sites like eBay or Amazon.

### Can I use PS2 discs directly with PCSX2?
Yes. However, some games have speed problems, because unlike the PS2 which would constantly keep the disc spinning, PCSX2 will not do the same to your PC's disc drive. It is recommended to instead dump your games to ISO images. ImgBurn is a popular software to do this with, and we recommend [installing ImgBurn by using Ninite](https://ninite.com) to avoid any issues with the ImgBurn installer.

### How do I play a game?
After PCSX2 is set up:

1) Click the CDVD menu
* If you are using an ISO image:

2) Check that "ISO" mode is selected.
turtleli marked this conversation as resolved.
Show resolved Hide resolved
3) Go to "ISO Selector", then Browse.
4) Locate your ISO image.
5) Click the System menu, then Boot ISO.

* If you are using a disc:

2) Check that "Plugin" mode is selected.
3) Click "Plugin Menu", then "Plugin Settings". Verify your disc drive shows up in the menu.
4) Click the System menu, then Boot CDVD.

### What is the difference between Full and Fast boot?
Full boot will launch the PS2 BIOS, which will then launch the game. Some games need this for multi-language settings or times to work.

Fast boot will directly mount and launch the game without first launching the PS2 BIOS. Though slightly faster, this may cause some multi-language games to boot into the wrong language, or games that use the clock to give inaccurate times.

### How do I compile the PCSX2 source code?
* [Windows compile guide](https://wiki.pcsx2.net/PCSX2_Documentation/Compiling_on_Windows)
* [Linux compile guide](https://wiki.pcsx2.net/PCSX2_Documentation/Compiling_on_Linux)

### When will the next version be released?
It will be released when it is ready. Please don't waste your time and ours asking when.

---
## PCSX2 Configuration

### How do I configure the emulator?
Full-length guides from initial setup to launching a game are on the PCSX2 Wiki:
***FIXME: Wikis need updated!!!***
[Windows configuration guide](https://wiki.pcsx2.net/Setting_up_Windows_version)
[Linux configuration guide](https://wiki.pcsx2.net/Setting_up_Linux_version)
lightningterror marked this conversation as resolved.
Show resolved Hide resolved

### I see framelimiter options. What are those? Will they boost my FPS?
The framelimiter has a few options that allow you to alter the pacing of your games. This will directly affect the game's speed itself, NOT your framerate. Useful for speeding through sections of games, or slowing down for precision.
* Turbo (Tab): Bumps the framelimiter to 200%, allowing a game to run up to 2x faster than normal.
* Slowmo (Shift + Tab): Drops the framelimiter to 50%, restricting a game to 0.5x its normal speed.
* Framelimiter Disabled (F4): Completely disables the framelimiter. The game will run as fast as your PC can push it.

Some settings are greyed out; these are advanced counters that should only be modified by those who understand the effects they have on a game's playback speed and frame pacing.

### What is the normal speed for a PlayStation 2 game?
* NTSC games will playback at 59.94 FPS
* PAL games will playback at 50 FPS
lightningterror marked this conversation as resolved.
Show resolved Hide resolved

These framerates are what the PlayStation 2 console would push to a real TV through its video cable. A game itself, typically, internally generates only half of those frames, and repeats frames to fill the gaps. This is why a "full speed" game may not "feel like 60 FPS". The console's "speed" (meaning AI, sound, physics, *everything*) is tied to the playback framerate, which is what PCSX2 reports as its "FPS".

### What are Gamefixes?
Gamefixes are specialized fixes built into PCSX2 for specific games. Gamefixes mostly fix core emulation problems that would crash or soft lock a game, rather than graphical or performance issues. By default, the "System > Automatic Gamefixes" option is enabled, meaning any games that need gamefixes will have them automatically applied, regardless of what gamefix settings you have enabled.

Most games will not need gamefixes, however if your game is having issues, you can try manually enabling them in Emulation Settings.

Gamefixes are not FPS boosters; more often than not, they will degrade performance slightly.

### Are Speedhacks safe?
As the name says, speedhacks are hacks to make things faster. They will speed up games, but risk causing stability problems or crashing some games. PCSX2 ships with some speedhacks enabled in the default "Safe" preset. This selection of speedhacks has been reviewed thoroughly and determined to be safe for nearly all games.

*Bug reports of issues caused by speedhacks will NOT be accepted, and will be immediately closed as invalid.*

### What are all these EE/IOP and VU options?
The PS2 EE, IOP and VU processors are substantially different from a PC CPU and require different rounding and clamping modes to do math accurately. Most games work fine on the default options, but some games might need a different setting. You can check the [PCSX2 Wiki](https://wiki.pcsx2.net/Category:Games) to see if your game needs an alternate setting, or check the [PCSX2 Forums](https://forums.pcsx2.net/) to see if anyone else has posted about it there.

### What are PCSX2 plugins?
PCSX2 uses a plugin framework for various sections of the emulator. A plugin is a small, incomplete piece of software that, when plugged in to another piece of software, provides some sort of additional function. PCSX2 uses plugins for:
* Video (GSdx)
* Audio (SPU2-X)
* Controls (Lilypad for Windows, OnePad for Linux)
* CD/DVD Drives (CDVDGigaherz)
* PS2 Networking/HDD Adapter (DEV9ghzdrk)
* USB (No plugin included)
* Firewire (No plugin included)

Each plugin will have its own Plugin Settings menu, and can be found under the Config menu.

### Why is my sound garbled up?
PCSX2's default audio playback mode is Timestretch, which will attempt to stretch sounds out when the emulator is unable to play at full speed, to fill the gaps in the sound playback and prevent even harsher stutters. If you are unable to get the game running at full speed or an acceptable speed where timestretching does not ruin the sound, you can try changing from Timestretch to Async, but this may break games.

### I have a controller here. Is it supported?
For Windows users running LilyPad, PCSX2 will ship with XInput bindings already created. This will automatically work with an Xbox One controller or any other XInput controller. Bindings can easily be made for DirectInput controllers, such as Xbox 360 controllers. PS3, PS4, or Switch Pro controllers should be set up using a compatibility software, such as Steam's Big Picture mode.

For Linux users running OnePad, PCSX2 will automatically detect and bind controls to any recognizable controller. Unfortunately, if your controller is not automatically recognized and bound, your options are limited, as OnePad only allows manual control binding to your keyboard and mouse.
lightningterror marked this conversation as resolved.
Show resolved Hide resolved

---
## Useful Links

### BIOS Dumping Guides
* [One of the original BIOS dumping guides, originally from ngemu](https://forums.pcsx2.net/Thread-Guide-to-Dumping-Your-PS2-Bios-over-LAN)

### Memory Card and Save File Guides
* [An older guide on merging GameFAQs saves into PCSX2 memory cards](https://forums.pcsx2.net/Thread-How-to-use-the-myMC-tool-to-import-export-saves-from-PCSX2). Note, while the concepts in this guide are accurate, the MyMC software is old, and probably will not run on your PC without some tinkering.
* [MyMC+, a newer replacement for the original MyMC referenced in the above guide](https://github.com/thestr4ng3r/mymcplus),

### PCSX2 Cheats and Patches (PNACH)
* [The currently accepted master-guide to cheats and patches](https://forums.pcsx2.net/Thread-How-PNACH-files-work-2-0).
* [The original guide, outdated](https://forums.pcsx2.net/Thread-How-pnach-files-work).

### PCSX2 with Netplay Support
* [The latest Netplay fork of PCSX2](https://forums.pcsx2.net/Thread-PCSX2-Online-Plus).