Update options and quickstart documentation

Renamed quickstart images and added more options pages

docs/development/index.md

@@ -4,17 +4,17 @@ So, you want to contribute to Ainex's development?
 Here are the steps you'll need to take to get started:
 
 - Have a computer capable of running Ainex, and install the required system components:
-    - See [System Requirements](/faq/quickstart/system_requirements)
+    - See [System Requirements](../faq/quickstart/system_requirements.md)
 - Learn the language<br/>
     - An often overlooked aspect to newcomers is having an understanding of the language the project is written in.<br/>
     - Ainex uses [C++ 17](https://en.wikipedia.org/wiki/C%2B%2B17) for development.
       If you don't know this language, you may [learn the basics on YouTube](https://www.youtube.com/watch?v=-c83JEsu350),
       but it may take a while to get a full grasp of it.<br/>
     - In addition, to submit your contributions, you'll need to know how to use [Git](https://www.git-scm.com/book/en/v2/Getting-Started-What-is-Git%3F).
       - Here is a [crash course](https://www.youtube.com/watch?v=SWYqp7iY_Tc) on Git to help you out.
-- Learn to [build Ainex from source](building)<br/>
+- Learn to [build Ainex from source](building.md)<br/>
   This step should give you all you need to start developing Ainex with Visual Studio on Windows or Codelite on Linux.
-- Follow the [style guide](style_guide)<br/>
+- Follow the [style guide](style_guide.md)<br/>
   Run `xb format` before creating a pull request.
 
 When you're ready, fork Ainex on GitHub, and push your changes. Then create a pull request on GitHub.
@@ -31,7 +31,7 @@ When you're ready, fork Ainex on GitHub, and push your changes. Then create a pu
 4. Review your selection. Make sure you have selected the correct branch.
 
 5. Click `Create Pull Request` to confirm your selection:
-![Location of the "Create Pull Request" button](images/create_pull_request.png)
+![Location of the "Create Pull Request" button](images/create_pull_request.png "")
 
-6. Write a title and description for your pull request. When you're done, press `Submit Pull Request`
-![Demonstration of pull request submission](images/submit_your_pull_request.png)
+6. Write a title and description for your pull request. When you're done, press `Create Pull Request`.
+![Demonstration of pull request submission](images/submit_your_pull_request.png "The 'Create Pull Request' button")

docs/faq/index.md

@@ -2,25 +2,25 @@
 
 ## How do I use Ainex?
 
-Refer to the [Quickstart page](quickstart).
+Refer to the [Quickstart page](quickstart/index.md).
 
 ## What are Ainex's system requirements?
 
-See the [Quickstart page](quickstart/system_requirements)
+See the [Quickstart page](quickstart/system_requirements.md)
 
 ## How do I fix the VCRUNTIME error?
 
-Refer to the [Quickstart page](quickstart).
+Refer to the [Quickstart page](quickstart/index.md).
 
 ## Why do I get an error saying "Your CPU does not support AVX"?
 
 Your CPU doesn't meet the minimum requirements.
 
-See the [Quickstart page](quickstart/system_requirements)
+See the [Quickstart page](quickstart/system_requirements.md)
 
 ## How do I dump games?
 
-See the guide in [Quickstart](quickstart/dumping).
+See the guide in [Quickstart](quickstart/dumping.md).
 
 ---
 
@@ -30,7 +30,7 @@ Upgrade your PC or wait for optimizations.
 
 ## Does Ainex support OpenGL/Direct3D11?
 
-No. (see the [system requirements](https://ainex-project.github.io/wiki/faq/quickstart/system_requirements/))
+No. (see the [system requirements](quickstart/system_requirements.md))
 
 ## Why is the audio delayed?
 

docs/faq/options/apu/ffmpeg_verbose.md

@@ -0,0 +1,7 @@
+<!--- This file is a snippet --->
+Makes FFMPEG output verbose logging.
+
+| **ffmpeg_verbose**                     | **boolean** |
+|:---------------------------------------|:-----------:|
+| Disable verbose logging. (**default**) |    false    |
+| Enable verbose logging.                |    true     |

docs/faq/options/apu/index.md

@@ -0,0 +1,9 @@
+<!--- This file is a snippet --->
+The system used to output audio to the speakers.
+
+| **apu**                            | **string** |
+|:-----------------------------------|:----------:|
+| The first available. (**default**) |    any     |
+| No audio                           |    nop     |
+| SDL2                               |    sdl     |
+| XAudio2                            |  xaudio2   |

docs/faq/options/apu/mute.md

@@ -0,0 +1,7 @@
+<!--- This file is a snippet --->
+Mutes all audio output.
+
+| **mute**                        | **boolean** |
+|:--------------------------------|:-----------:|
+| Audio is enabled. (**default**) |    false    |
+| Audio is disabled.              |    true     |

docs/faq/options/content/license_mask.md

@@ -1,6 +1,8 @@
 <!--- This file is a snippet --->
+Set the license mask for activated content.
 
-|**license_mask**                           |  **#**  |
-|:------------------------------------------|:-------:|
-| Deactivated/trial/demo mode (*default*)   |    0    |
-| Activated/full mode                       | -1 or 1 |
+| **license_mask**                                   |       **#**       |
+|:---------------------------------------------------|:-----------------:|
+| No licenses enabled (Demo/Trial mode. **default**) |         0         |
+| XBLA activated mode (First license enabled)        |         1         |
+| Full mode (All licenses enabled)                   | -1<br/>0xFFFFFFFF |

docs/faq/options/cpu/break_on_unimplemented_instructions.md

@@ -1,8 +1,9 @@
 <!--- This file is a snippet --->
+Break to the host debugger if an unimplemented PowerPC instruction is encountered (or crash if no debugger is attached).
 
-|**break_on_unimplemented_instructions**|**bool**|
-|:--------------------------------------|:------:|
-| On (*default*)                        | true   |
-| Off (hack, [needed for certain games])| false  |
+| **break_on_unimplemented_instructions** | **bool** |
+|:----------------------------------------|:--------:|
+| On (**default**)                        |   true   |
+| Off (hack, [needed for certain games])  |  false   |
 
-[needed for certain games]:(https://github.com/ainex-project/game-compatibility/issues?q=is%3Aopen+is%3Aissue+label%3Acpu-unimplemented-instruction)
+[needed for certain games]:https://github.com/ainex-project/game-compatibility/issues?q=is%3Aopen+is%3Aissue+label%3Acpu-unimplemented-instruction

docs/faq/options/cpu/clock_no_scaling.md

@@ -0,0 +1,9 @@
+<!--- This file is a snippet --->
+Disable real-time clock scaling code.<br/>
+Time management and locking is bypassed.
+Guest system time is directly pulled from the host.
+
+| **clock_no_scaling**                                                    | **bool** |
+|:------------------------------------------------------------------------|:--------:|
+| Guest time is scaled proportionally to the running speed. (**default**) |  false   |
+| System time is pulled from directly the host.                           |   true   |

docs/faq/options/cpu/clock_source_raw.md

@@ -0,0 +1,9 @@
+<!--- This file is a snippet --->
+Use the `RDTSC` instruction as the time source.
+
+**Host CPU must support invariant TSC.**
+
+| **clock_source_raw**                                      | **bool** |
+|:----------------------------------------------------------|:--------:|
+| Gets the guest time using the system clock. (**default**) |  false   |
+| Gets the guest time using the `RDTSC` instruction.        |   true   |

docs/faq/options/cpu/index.md

@@ -0,0 +1,10 @@
+<!--- This file is a snippet --->
+The CPU backend to be used for emulation.
+
+| **cpu**                            | **string** |
+|:-----------------------------------|:----------:|
+| The first available. (**default**) |    any     |
+| x86_64 architecture                |    x64     |
+
+In all reality, the emulator can only be compiled for one CPU architecture at a time.
+This option is completely useless.

docs/faq/options/d3d12/d3d12_adapter.md

@@ -0,0 +1,7 @@
+<!--- This file is a snippet --->
+Index of the DXGI adapter to use. Enter any positive number to use a specific physical adapter.
+
+| **d3d12_adapter**                   | **#** |
+|:------------------------------------|:-----:|
+| WARP software rendering.            |  -2   |
+| Any physical adapter. (**default**) |  -1   |

docs/faq/options/d3d12/d3d12_readback_resolve.md

@@ -1,8 +1,9 @@
 <!--- This file is a snippet --->
-!!! info "This is needed for certain games:"
-    * [Titles that might require this option](https://github.com/ainex-project/game-compatibility/issues?q=is%3Aissue+is%3Aopen+label%3Agpu-readback)
+This is needed for [certain games][link]
 
-|**d3d12_readback_resolve**  |**bool** |
-|:---------------------------|:-------:|
-| Off (*default*)            |  false  |
-| On                         |  true   |
+[link]:https://github.com/ainex-project/game-compatibility/issues?q=is%3Aissue+is%3Aopen+label%3Agpu-readback
+
+| **d3d12_readback_resolve** | **bool** |
+|:---------------------------|:--------:|
+| Off (**default**)          |  false   |
+| On                         |   true   |

docs/faq/options/gpu/draw_resolution_scale_x.md

@@ -1,12 +1,12 @@
 <!--- This file is a snippet --->
 Horizontal Scale
 
-|**draw_resolution_scale_x**|**#**|
-|:--------------------------|:---:|
-| 1x (1280x, *default*)     |  1  |
-| 2x (2560x)                |  2  |
-| 3x (3840x)                |  3  |
-| 4x (5120x)                |  4  |
-| 5x (6400x)                |  5  |
-| 6x (7680x)                |  6  |
-| 7x (8960x)                |  7  |
+| **draw_resolution_scale_x** | **#** |
+|:----------------------------|:-----:|
+| 1x (1280x, **default**)     |   1   |
+| 2x (2560x)                  |   2   |
+| 3x (3840x)                  |   3   |
+| 4x (5120x)                  |   4   |
+| 5x (6400x)                  |   5   |
+| 6x (7680x)                  |   6   |
+| 7x (8960x)                  |   7   |

docs/faq/options/gpu/draw_resolution_scale_y.md

@@ -1,12 +1,12 @@
 <!--- This file is a snippet --->
 Vertical Scale:
 
-|**draw_resolution_scale_y**|**#**|
-|:--------------------------|:---:|
-| 1x (x720, *default*)      |  1  |
-| 2x (x1440)                |  2  |
-| 3x (x2160)                |  3  |
-| 4x (x2880)                |  4  |
-| 5x (x3600)                |  5  |
-| 6x (x4320)                |  6  |
-| 7x (x5040)                |  7  |
+| **draw_resolution_scale_y** | **#** |
+|:----------------------------|:-----:|
+| 1x (x720, **default**)      |   1   |
+| 2x (x1440)                  |   2   |
+| 3x (x2160)                  |   3   |
+| 4x (x2880)                  |   4   |
+| 5x (x3600)                  |   5   |
+| 6x (x4320)                  |   6   |
+| 7x (x5040)                  |   7   |

docs/faq/options/gpu/gpu.md

@@ -1,8 +1,8 @@
 <!--- This file is a snippet --->
 
-|**gpu**                              |**string**|
-|:------------------------------------|:--------:|
-| Any backend (*default, recommended*)|  any     |
-| Direct3D 12                         |  d3d12   |
-| Vulkan                              |  vulkan  |
-| Null (blank/nothing)                |  null    |
+| **gpu**                                  | **string** |
+|:-----------------------------------------|:----------:|
+| Any backend (**default**, *recommended*) |    any     |
+| Direct3D 12                              |  d3d12     |
+| Vulkan                                   |   vulkan   |
+| Null (blank/nothing)                     |    null    |

docs/faq/options/index.md

@@ -23,17 +23,37 @@
 Each setting has a table explaining the different options.<br/>
 Expand a section by clicking it to see the table.
 
+Each table follows this pattern.
+
 | **setting_name** | **value type** |
 |:-----------------|:--------------:|
 | description      |     value      |
 
 ## APU
 
+??? info "APU"
+    --8<-- "docs/faq/options/apu/index.md"
+
+??? info "FFMPEG Verbose"
+    --8<-- "docs/faq/options/apu/ffmpeg_verbose.md"
+
+??? info "Mute"
+    --8<-- "docs/faq/options/apu/mute.md"
+
 ## CPU
 
 ??? info "Break on Unimplemented Instructions"
     --8<-- "docs/faq/options/cpu/break_on_unimplemented_instructions.md"
 
+??? info "Clock: No scaling"
+    --8<-- "docs/faq/options/cpu/clock_no_scaling.md"
+
+??? info "Clock Source: Raw"
+    --8<-- "docs/faq/options/cpu/clock_source_raw.md"
+
+??? info "CPU"
+    --8<-- "docs/faq/options/cpu/index.md"
+
 ## Config
 
 ## Content
@@ -43,6 +63,9 @@ Expand a section by clicking it to see the table.
 
 ## D3D12
 
+??? info "DXGI Adapter"
+    --8<-- "docs/faq/options/d3d12/d3d12_adapter.md"
+
 ??? info "CPU Readback After Render Target Resolving"
     --8<-- "docs/faq/options/d3d12/d3d12_readback_resolve.md"
 

docs/faq/quickstart/download.md

@@ -5,4 +5,4 @@
 **Ainex** is sometimes detected as a virus. Ignore this, as it is a false positive
 
 !!! success "Next section..."
-    - [How to Dump Games](dumping)
+    - [How to Dump Games](dumping.md)