[skip ci] PCSX2 1.6 Documentation Overhaul #3139

RedPanda4552 · 2019-10-24T02:57:39Z

Documentation overhaul for 1.6 release 🔜

Starting with a rewrite of the old FAQ PDF, now in Markdown. Modernized, dropped some irrelevant bits, added some new ones.

WIP, ideally should have all docs ready in this PR before merge. Starting with this and putting PR up for visibility.

pgert · 2019-10-27T00:13:45Z

I'm saddened that you haven't included my BIOS & memcard tools guide.
https://forums.pcsx2.net/Thread-An-orientation-through-some-of-the-PCSX2-BIOS-memcard-tools-Windows?pid=183709#pid183709

README.md

pcsx2/Docs/License.txt

ssakash · 2019-11-02T10:54:26Z

PassMark Single Thread Performance rating near or greater than 1600

This value feels too high for minimum requirements.

lightningterror · 2019-11-02T14:56:52Z

This value feels too high for minimum requirements.

Feels right to me, we've been recommending 1600 for several years now.

pcsx2/Docs/PCSX2_FAQ.md

tadanokojin · 2019-11-02T14:56:52Z

pcsx2/Docs/PCSX2_FAQ.md

+* 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).
+


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

tadanokojin · 2019-11-02T14:58:33Z

pcsx2/Docs/PCSX2_FAQ.md

+| Operating System | CPU | GPU | RAM |
+| --- | --- | --- | --- |
+| - Windows 7 or newer (32 or 64 bit) <br/> - Ubuntu 18.04/Debian or newer, Arch Linux, or other distro (32 or 64 bit) | - Supports SSE2 <br/> - [PassMark Single Thread Performance](https://www.cpubenchmark.net/singleThread.html) rating near or greater than 1600 <br/> - Two physical cores, with hyperthreading | - Direct3D11 support <br/> - OpenGL 3.x support <br/> - [PassMark G3D Mark](https://www.videocardbenchmark.net/high_end_gpus.html) rating around 3000 (GeForce GTX 750) <br/> - 2 GB Video Memory | 4 GB |
+


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

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.

tadanokojin · 2019-11-02T15:02:49Z

@lightningterror @ssakash then a wise man said "we shall add more threads"

README.md

pcsx2/Docs/PCSX2_FAQ.md

mirh · 2019-11-24T00:12:29Z

Feels right to me, we've been recommending 1600 for several years now.

And? Requirements should depend on how well games run, not whether most people can afford to buy such hardware or not.
And I, for one, can play plenty of games (actually every one I ever tried) with barely more than 1000

Maybe it's just me to be lucky, but the I'd like some more discussion on how game heaviness distribution goes.

EDIT: the cores note is very perfect now btw, gg

ssakash · 2019-11-26T13:56:33Z

I agree with @mirh, minimum requirement should be the utmost minimum single thread performance you need to emulate the system, some games need really high value, but that doesn't make that 4th gen i3 with 1.4K STP not fit for PCSX2.

I'm not even sure how you come up with the 1600 value either, there are tons of games which are less demanding on the CPU that even lower values like the one mirh mentioned would be enough. I don't want anyone to come to the wrong conclusion thinking their PC is not fit for PCSX2 just by this high minimum requirement you have for it.

mirh · 2019-11-26T14:13:23Z

It will be a good deal of arguing though, whether "the absolute minimum", or "some decent number of games works" (and even then, whether you should just take "raw frequency", or discount titles for popularity) is gomna be the better metrics.

Also, most of these considerations are also true for recommended requirements I guess. I don't think that we should have "play SOTC at full speed" as it.

tadanokojin · 2019-11-26T19:51:49Z

And I, for one, can play plenty of games (actually every one I ever tried) with barely more than 1000

here are tons of games which are less demanding on the CPU that even lower values like the one mirh mentioned would be enough

Then name some.

turtleli · 2020-02-09T01:14:58Z

I think you need to modify the main CMakeLists.txt.

lightningterror · 2020-02-09T01:32:06Z

For cmake btw here, need to add the config guide

pcsx2/CMakeLists.txt

Line 75 in 959d652

    
           INSTALL(FILES "${CMAKE_SOURCE_DIR}/bin/docs/PCSX2_FAQ.pdf"      DESTINATION "${DOC_DIR}")

lightningterror

Think we are good, maybe we can squash the newest commit in first.

pcsx2/Docs/PCSX2_FAQ.md

lightningterror

The images for the config guide look low res, can you use better quality ones, also use images from the pr but rebased with latest dev build since DPI scaling was fixed in the first time wizard as well as to match the config and faq doc strings.

RedDevilus · 2020-02-09T23:30:44Z

Nitpicky: The header of the Configuration_Guide ( PDF ) says Configuration_Guide.md + There is an empty page number 6.

Header for PCSX2_FAQ (PDF) says PCSX2_FAQ.md too.

lightningterror · 2020-02-10T00:24:30Z

It's how the conversion is done so it's fine.

RedDevilus · 2020-02-10T01:21:15Z

I have changed it myself if u still want the changes i proposed. But i don't want to pollute with making another PR.

7da0ff6
Also in my branch: docs2
I'm sorry if i'm being too excessive in doing this.

lightningterror

Looks good, let's get it finally merged.

Update all documentation for 1.6. Source files for documentation are in md format and are kept in pcsx2\pcsx2\Docs, final exported/converted docs are in pdf format (Configuration_Guide and PCSX2_FAQ). Update First time wizard to reflect recent documentation changes. Update cmake to reflect recent documentation changes. PO/POT/MO Localisation needs to be updated for the First time wizard to include the documentation changes. NSIS installer needs to be updated to reflect the recent changes.

PCSX2 FAQ, attempt 1

b550469

turtleli added Documentation WIP labels Oct 24, 2019

RedPanda4552 added 8 commits October 26, 2019 21:05

Add pgert's memcard/BIOS guides

5fc004d

First attempt at project readme rewrite

9efcbe1

Use requirements table made for readme

735393e

Reference BIOS guide links in body

b31c879

Update year on license template

ddf907e

Remove old 1.2 release notes

2b04cf9

Not using word docs, remove instructions

caaa2c7

Replaced by markdown file

831e0f7

lightningterror reviewed Oct 29, 2019

View reviewed changes

README.md Outdated Show resolved Hide resolved

lightningterror reviewed Oct 29, 2019

View reviewed changes

README.md Show resolved Hide resolved

lightningterror reviewed Oct 29, 2019

View reviewed changes

pcsx2/Docs/License.txt Show resolved Hide resolved

LT's review

c44648b

tadanokojin reviewed Nov 2, 2019

View reviewed changes

lightningterror reviewed Nov 13, 2019

View reviewed changes

README.md Outdated Show resolved Hide resolved

MrCK1 added this to the Release 1.6 milestone Nov 15, 2019

turtleli reviewed Nov 23, 2019

View reviewed changes

pcsx2/Docs/PCSX2_FAQ.md Outdated Show resolved Hide resolved

RedPanda4552 added 2 commits November 23, 2019 17:01

Kojin's word recommendation

fb7a2da

Start a Windows config guide

b3da36f

Rework CPU core note

90cbb62

RedPanda4552 force-pushed the docs branch from e68cd67 to 3369d12 Compare February 9, 2020 01:06

lightningterror added the Changes translatable strings label Feb 9, 2020

RedPanda4552 force-pushed the docs branch from 3369d12 to eb24849 Compare February 9, 2020 01:20

Move final PDFs to bin

4ecfafd

RedPanda4552 force-pushed the docs branch from 528d1c4 to 4ecfafd Compare February 9, 2020 01:58

lightningterror removed the Needs work label Feb 9, 2020

lightningterror approved these changes Feb 9, 2020

View reviewed changes

lightningterror reviewed Feb 9, 2020

View reviewed changes

pcsx2/Docs/PCSX2_FAQ.md Outdated Show resolved Hide resolved

lightningterror reviewed Feb 9, 2020

View reviewed changes

pcsx2/Docs/PCSX2_FAQ.md Outdated Show resolved Hide resolved

lightningterror added the Needs work label Feb 9, 2020

lightningterror requested changes Feb 9, 2020

View reviewed changes

RedPanda4552 added 8 commits February 9, 2020 16:28

Lightning Review

b79b11b

Move final PDFs to bin

aa70bcb

Lightning Review

4ddd46b

Fix note spaces

94b4d56

Merge branch 'docs' of https://github.com/RedPanda4552/pcsx2 into docs

2394bd7

Bigger screenshots

1f21abe

And finalize PDFs again

5d525a7

Version

a71c07b

Use RedDevilus' PDF fixes

f96f8e4

lightningterror removed the Needs work label Feb 10, 2020

lightningterror approved these changes Feb 10, 2020

View reviewed changes

lightningterror merged commit a7285ff into PCSX2:master Feb 10, 2020

RedPanda4552 deleted the docs branch January 3, 2021 00:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[skip ci] PCSX2 1.6 Documentation Overhaul #3139

[skip ci] PCSX2 1.6 Documentation Overhaul #3139

RedPanda4552 commented Oct 24, 2019

pgert commented Oct 27, 2019

ssakash commented Nov 2, 2019

lightningterror commented Nov 2, 2019

tadanokojin Nov 2, 2019

tadanokojin Nov 2, 2019

mirh Dec 6, 2019

tadanokojin commented Nov 2, 2019

mirh commented Nov 24, 2019 •

edited

ssakash commented Nov 26, 2019

mirh commented Nov 26, 2019

tadanokojin commented Nov 26, 2019

turtleli commented Feb 9, 2020

lightningterror commented Feb 9, 2020 •

edited

lightningterror left a comment

lightningterror left a comment

RedDevilus commented Feb 9, 2020

lightningterror commented Feb 10, 2020

RedDevilus commented Feb 10, 2020

lightningterror left a comment

[skip ci] PCSX2 1.6 Documentation Overhaul #3139

[skip ci] PCSX2 1.6 Documentation Overhaul #3139

Conversation

RedPanda4552 commented Oct 24, 2019

pgert commented Oct 27, 2019

ssakash commented Nov 2, 2019

lightningterror commented Nov 2, 2019

tadanokojin Nov 2, 2019

Choose a reason for hiding this comment

tadanokojin Nov 2, 2019

Choose a reason for hiding this comment

mirh Dec 6, 2019

Choose a reason for hiding this comment

tadanokojin commented Nov 2, 2019

mirh commented Nov 24, 2019 • edited

ssakash commented Nov 26, 2019

mirh commented Nov 26, 2019

tadanokojin commented Nov 26, 2019

turtleli commented Feb 9, 2020

lightningterror commented Feb 9, 2020 • edited

lightningterror left a comment

Choose a reason for hiding this comment

lightningterror left a comment

Choose a reason for hiding this comment

RedDevilus commented Feb 9, 2020

lightningterror commented Feb 10, 2020

RedDevilus commented Feb 10, 2020

lightningterror left a comment

Choose a reason for hiding this comment

mirh commented Nov 24, 2019 •

edited

lightningterror commented Feb 9, 2020 •

edited