mirror of https://github.com/PCSX2/pcsx2.git
docs: Minor edits to existing markdown documentation
This commit is contained in:
Tyler Wilding
lightningterror
parent
cd0bda3ab4
commit
11eba8738c
|
|
@ -1,9 +1,17 @@
|
|||
---
|
||||
title: "PCSX2 - Configuration Guide"
|
||||
date: "2020"
|
||||
footer-left: "[Document Source](https://github.com/PCSX2/pcsx2/blob/v1.6.0/pcsx2/Docs/Configuration_Guide/Configuration_Guide.md)"
|
||||
urlcolor: "cyan"
|
||||
...
|
||||
|
||||
# PCSX2 First Time Setup and Configuration
|
||||
This guide will walk through the initial setup process of PCSX2 and the basics of configuration.
|
||||
|
||||
*Note: While this document is using Windows screenshots, you can still follow this guide for Linux.*
|
||||
|
||||
---
|
||||
\pagebreak
|
||||
|
||||
## First Time Setup
|
||||
The first time you launch PCSX2, you will be prompted with a First Time Configuration wizard.
|
||||
|
||||
|
|
@ -14,8 +22,6 @@ You may choose to change the UI language of PCSX2 here.
|
|||
|
||||
*Note: Translations may not be accurate or actively maintained by translators. If you find translation issues and want to fix them yourself, please get into contact with the PCSX2 team by opening a [thread on the PCSX2 forums](https://forums.pcsx2.net/) or an [issue on GitHub](https://github.com/PCSX2/pcsx2/issues).*
|
||||
|
||||
<div class="page"/> <!-- Because PDFs are terrible -->
|
||||
|
||||
### Plugin Selection
|
||||
Most users running on a modern PC will be able to continue normally here without changing any settings.
|
||||
|
||||
|
|
@ -34,7 +40,6 @@ Advanced users may wish to use a different folder for their BIOS, you can do so
|
|||
|
||||
|
||||
|
||||
---
|
||||
## Post-Setup Configuration
|
||||
A large number of games work out-of-the-box on default PCSX2 settings. However, a subset of games require special settings to run, and some games require special settings to be upscaled. This guide will briefly cover some frequent problems and configuration settings to address them.
|
||||
|
||||
|
|
@ -44,8 +49,6 @@ The MTVU option is a unique case of a recommended setting that is **not** enable
|
|||
### Specific game solutions
|
||||
Looking for information specific to a single game? Head to the [PCSX2 Wiki](https://wiki.pcsx2.net/Main_Page) and search for your game using the search bar in the top right. Known issues and solutions should be towards the bottom of a game's wiki page.
|
||||
|
||||
<div class="page"/> <!-- Because PDFs are terrible -->
|
||||
|
||||
### General solutions
|
||||
Want some general ideas to try that are not specific to a game? Here are some more commonly known issues and solutions to try.
|
||||
*Note: For some of these issues, multiple solutions are given one after the other. Before moving from one solution to the next, **undo the previous solution**. Stacking multiple fixes on top of each other is usually unnecessary and likely to introduce new issues.*
|
||||
|
|
@ -78,8 +81,6 @@ Navigate to the GSdx Advanced Settings and Hacks:
|
|||
`Config > Video (GS) > Plugin Settings > Advanced Settings and Hacks`
|
||||
Try checking Disable Safe Features.
|
||||
|
||||
<div class="page"/> <!-- Because PDFs are terrible -->
|
||||
|
||||
##### VU
|
||||
Navigate to the VU settings:
|
||||
`Config > Emulation Settings > VUs`
|
||||
|
|
|
|||
|
|
@ -0,0 +1,51 @@
|
|||
---
|
||||
title: "PCSX2 - Debugger Documentation"
|
||||
date: "2020"
|
||||
footer-left: "[Document Source](https://github.com/PCSX2/pcsx2/blob/v1.6.0/pcsx2/Docs/Debugger.md)"
|
||||
urlcolor: "cyan"
|
||||
...
|
||||
|
||||
# Debugger Key Bindings
|
||||
|
||||
## Disassembly View:
|
||||
- `Ctrl+G` - goto
|
||||
- `Ctrl+E` - edit breakpoint
|
||||
- `Ctrl+D` - enable/disable breakpoint
|
||||
- `Ctrl+B` - add breakpoint
|
||||
- `Right Arrow` - follow branch/position memory view to accessed address
|
||||
- `Left Arrow` - go back one branch level/goto pc
|
||||
- `Up Arrow` - move cursor up one line
|
||||
- `Down Arrow` - move cursor down one line
|
||||
- `Page Up` - move visible area up one page
|
||||
- `Page Down` - move visible area down one page
|
||||
- `F10` - step over
|
||||
- `F11` - step into
|
||||
- `Tab` - toggle display symbols
|
||||
- `Left Click` - select line/toggle breakpoint if line is already highlighted
|
||||
- `Right Click` - open context menu
|
||||
|
||||
## Memory View:
|
||||
|
||||
- `Ctrl+G` - goto
|
||||
- `Ctrl+B` - add breakpoint
|
||||
- `Left Arrow` - move cursor back one byte/nibble
|
||||
- `Right Arrow` - move cursor ahead one byte/nibble
|
||||
- `Up Arrow` - move cursor up one line
|
||||
- `Down Arrow` - move cursor down one line
|
||||
- `Page Up` - move cursor up one page
|
||||
- `Page Down` - move cursor down one page
|
||||
- `0-9,A-F` - overwrite hex nibble
|
||||
- `any` - overwrite ansi byte
|
||||
- `Left Click` - select byte/nibble
|
||||
- `Right Click` - open context menu
|
||||
- `Ctrl+Mouse Wheel` - zoom memory view
|
||||
- `Esc` - return to previous goto address
|
||||
- `Ctrl+V` - paste a hex string into memory
|
||||
|
||||
## Breakpoint List:
|
||||
|
||||
- `Up Arrow` - select previous item
|
||||
- `Down Arrow` - select next item
|
||||
- `Delete` - remove selected breakpoint
|
||||
- `Enter/Return` - edit selected breakpoint
|
||||
- `Space` - toggle enable state of selected breakpoint
|
||||
|
|
@ -1,17 +1,11 @@
|
|||
# GameDB Documentation
|
||||
---
|
||||
title: "PCSX2 - GameDB Documentation"
|
||||
date: "2020"
|
||||
footer-left: "[Document Source](https://github.com/PCSX2/pcsx2/blob/v1.6.0/pcsx2/Docs/GameIndex.md)"
|
||||
urlcolor: "cyan"
|
||||
...
|
||||
|
||||
- [YAML Game Format](#yaml-game-format)
|
||||
- [A Note on Case Sensitivity](#a-note-on-case-sensitivity)
|
||||
- [Rounding Modes](#rounding-modes)
|
||||
- [Options](#options)
|
||||
- [Clamping Modes](#clamping-modes)
|
||||
- [Options](#options-1)
|
||||
- [Game Fixes](#game-fixes)
|
||||
- [Options](#options-2)
|
||||
- [SpeedHacks](#speedhacks)
|
||||
- [Options](#options-3)
|
||||
- [Memory Card Filter Override](#memory-card-filter-override)
|
||||
- [Patches](#patches)
|
||||
# GameDB Documentation
|
||||
|
||||
## YAML Game Format
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "PCSX2 - Frequently Asked Questions"
|
||||
date: "2020"
|
||||
footer-left: "[Document Source](https://github.com/PCSX2/pcsx2/blob/v1.6.0/pcsx2/Docs/PCSX2_FAQ.md)"
|
||||
urlcolor: "cyan"
|
||||
...
|
||||
|
||||
# PCSX2 - Frequently Asked Questions
|
||||
|
||||
## About the PCSX2 Project
|
||||
|
|
|
|||
|
|
@ -37,6 +37,8 @@ If you prefer Chocolatey or using the installer, consult pandoc's official docum
|
|||
|
||||
Run the following, this assumes you have access to bash, either by virtue of running on linux or through something like `git-bash` on Windows.
|
||||
|
||||
You'll likely want to update the tag for documentation source links in all markdown file's metadata block, this is not currently scripted at the time of writing.
|
||||
|
||||
```bash
|
||||
> ./gen-docs.sh
|
||||
```
|
||||
|
|
|
|||
Loading…
Reference in New Issue