Merge pull request #6 from Darkhost1999/WSL

Markdownlint + WSL

README.md

@@ -7,13 +7,19 @@
 We recommend using Ruby Version Manager (RVM) to [Install Ruby](https://rvm.io/rvm/install)
 
 - Clone and set up wiki:
-```
+
+```sh
+
 git clone https://github.com/RPCSX/wiki
 cd wiki
+
 ```
+
 Note: Do not run Bundler as root. Installing your bundle as root will break this application for all
 non-root users on your machine.
-```
+
+```sh
+
 gem install bundler
 bundle install
 ```
@@ -23,9 +29,11 @@ bundle install
 - Run Jekyll Server:
 
 Note: Hot reloading is unsupported, refresh the page to see changes.
-```
+
+```sh
 bundle exec jekyll serve
 ```
+
 ### Before Pushing Changes
 
 Run `rubocop` on your local files.

faq.md

@@ -6,23 +6,19 @@ permalink: /faq/
 description: Frequently Asked Questions about RPCSX.
 ---
 
-## What is RPCSX?
+## Q: What is RPCSX?
 
 **A:** RPCSX is an experimental emulator for PS4 games (and later, PS5 games). Development is ongoing.
 
-## Can I play Bloodborne?
+## Q: Can I play Bloodborne?
 
 **A:** Not yet.
 
-## Can I run RPCSX on Windows?
+## Q: Can I run RPCSX on Windows?
 
-**A:** No, currently the project is Linux-only. However, we may support Windows in the future due to popular demand.
+**A:** Yes, But only through WSL at this time. [learn more](/wiki/installation/#method-2-wsl)
 
-### What about the Windows Subsystem for Linux (WSL)?
-
-**A:** Testers have gotten WSL working and we are awaiting instructions for others to use WSL as well. Coming soon. Please be patient.
-
-## What is the current state of the project?
+## Q: What is the current state of the project?
 
 **A:** The emulator can run test samples and play in-game on [We Are Doomed](https://store.playstation.com/en-us/product/UP2195-CUSA01783_00-WEAREDOOMED00000).
 A compatibility table is in progress and will be available when RPCSX can run commercial games.

index.md

@@ -6,7 +6,7 @@ layout: libdoc/page
 permalink: /
 ---
 
-Welcome to the RPCSX Wiki!
+# Welcome to the RPCSX Wiki
 
 Before you begin, please:
 
@@ -16,4 +16,4 @@ Follow the [Installation Guide](/wiki/installation/) to set up the emulator
 
 Learn how to [Run RPCSX](https://rpcsx.github.io/wiki/run/) to play games and apps
 
-Discover more about our project on the [About Page](https://rpcsx.github.io/wiki/about/)
+Discover more about our project on the [About Page](https://rpcsx.github.io/wiki/about/)

install-guide.md

@@ -10,8 +10,10 @@ description: >-
 - TOC
 {:toc}
 
-## Update!
+## Update
+
 Third party dependencies have been merged into the source tree as submodules! If you previously installed RPCSX when you needed `spirv-cross`, `gslang`, or `xbyak`, you should run:
+
 ```sh
 git pull
 git submodule update --recursive --remote
@@ -23,9 +25,10 @@ We provide two installation methods:
 
 ### Method 1: Linux
 
-#### Install dependencies.
+#### Install dependencies
 
-  - **.deb-based (Ubuntu etc.)** Note: git is only needed for Ubuntu 22.04
+- **.deb-based (Ubuntu etc.)**
+  Note: git is only needed for Ubuntu 22.04
 
 ```sh
 sudo apt install build-essential cmake libunwind-dev libglfw3-dev libvulkan-dev vulkan-validationlayers-dev libsox-dev git libasound2-dev nasm g++-14
@@ -33,7 +36,7 @@ sudo apt install build-essential cmake libunwind-dev libglfw3-dev libvulkan-dev
 
 go to [Continued Install.](/wiki/installation/#continued-install)
 
-  - **.rpm-based (Fedora etc.)**
+- **.rpm-based (Fedora etc.)**
 
 ```sh
 sudo dnf install cmake libunwind-devel glfw-devel vulkan-devel vulkan-validation-layers-devel gcc-c++ gcc sox-devel alsa-lib-devel nasm
@@ -41,8 +44,8 @@ sudo dnf install cmake libunwind-devel glfw-devel vulkan-devel vulkan-validation
 
 go to [Continued Install.](/wiki/installation/#continued-install)
 
-  - **Arch**
-    - vulkan-devel is a group, and you should install **all**!
+- **Arch**
+  vulkan-devel is a group, and you should install **all**!
 
 ```sh
 sudo pacman -S --needed libunwind glfw-x11 vulkan-devel sox git cmake alsa-lib nasm
@@ -51,20 +54,118 @@ sudo pacman -S --needed libunwind glfw-x11 vulkan-devel sox git cmake alsa-lib n
 go to [Continued Install.](/wiki/installation/#continued-install)
 
 #### Continued Install
-2. Clone the repo.
 
-```sh
-git clone --recursive https://github.com/RPCSX/rpcsx && cd rpcsx
-git submodule update --init --recursive
-```
+1. Clone the repo.
 
-3. Compile the emulator.
+    ```sh
+    git clone --recursive https://github.com/RPCSX/rpcsx && cd rpcsx
+    git submodule update --init --recursive
+    ```
 
-```sh
-cmake -B build && cmake --build build -j$(nproc)
-```
+2. Compile the emulator.
+
+    ```sh
+    cmake -B build && cmake --build build -j$(nproc)
+    ```
 
 ### Method 2: WSL
-**TODO (Coming Soon)**
+
+**Install WSL**
+  Run Windows Powershell as Administrator:
+
+```sh
+wsl --install
+```
+
+Reboot your machine
+
+**Install Ubuntu:**
+  Run Windows Powershell
+
+```sh
+wsl --install -d Ubuntu
+```
+
+Setup user credentials
+
+**Configure Ubuntu and build RPCSX:**
+  Add the PPA repository that has the packages we need
+
+```sh
+sudo add-apt-repository ppa:oibaf/graphics-drivers
+sudo apt upgrade
+```
+
+Install Ubuntu package dependencies
+
+```sh
+sudo apt install build-essential cmake libunwind-dev libglfw3-dev libvulkan-dev libsox-dev git libasound2-dev nasm g++-14
+```
+
+Install WSL specific package dependencies
+
+```sh
+sudo apt install pkgconf libasound2-plugins vainfo mesa-va-drivers
+```
+
+Add pcm.default pulse to the bottom of the .asoundrc file to configure audio
+
+```sh
+echo "pcm.default pulse" > ~/.asoundrc
+```
+
+Add ctl.default pulse to the bottom of the .asoundrc file to configure audio
+
+```sh
+echo "ctl.default pulse" >> ~/.asoundrc
+```
+
+Clone both Vulkan ExtensionLayer and RPCSX Git repositories
+
+```sh
+git clone --depth 1 https://github.com/KhronosGroup/Vulkan-ExtensionLayer.git
+git clone --depth 1 --recursive https://github.com/RPCSX/rpcsx.git
+```
+
+Change directory and compile Vulkan ExtensionLayer
+
+```sh
+cd Vulkan-ExtensionLayer
+cmake -B build -D UPDATE_DEPS=ON -DCMAKE_BUILD_TYPE=Release
+cmake --build build -j$(nproc)
+sudo cmake --build build --target install -j$(nproc)
+```
+
+Change directory back from Vulkan ExtensionLayer and to RPCSX then compile
+
+```sh
+cd ../rpcsx
+cmake -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_FLAGS_INIT="-march=native" -DCMAKE_CXX_COMPILER=g++-14
+cmake --build build -j$(nproc)
+sudo cp build/bin/rpcsx /bin
+```
+
+Tell Ubuntu to set the VK_LAYER_PATH Environment variable
+
+```sh
+echo 'export VK_LAYER_PATH=/usr/local/share/vulkan/explicit_layer.d/:$VK_LAYER_PATH' >> ~/.profile
+```
+
+Tell Ubuntu to set the VK_INSTANCE_LAYERS Environment variable
+
+```sh
+echo 'export VK_INSTANCE_LAYERS=VK_LAYER_KHRONOS_shader_object' >> ~/.profile
+```
+
+Initalize and shutdown the Linux machine
+
+```sh
+sudo init 0
+```
+
+Wait a few minutes to let Linux shutdown.
+  This will not turn off your PC only the virtual Ubuntu distro.
+
 #### ArchWSL
+
 **TODO (under development)**

running.md

@@ -15,21 +15,23 @@ description: >-
 You will need a decrypted dump of the PlayStation 4 console firmware, **OBTAINED LAWFULLY, FROM YOUR OWN PS4 CONSOLE**.
 
 Compatible versions:
+
 - 5.05
 - 9.0
 - 11.0
 
 ## Help
+
 - See the Commands of `rpcsx` (`-h` argument)
 - Join the [Discord](https://discord.com/invite/WEGamDwZnE).
 
-## Booting games:
+## Booting games
 
 ```sh
 ./rpcsx --mount /path/to/firmware/md0/ /  --mount /path/to/game/app0 /app0 /app0/eboot.bin [optional args, without brackets]
 ```
 
-## Booting the firmware:
+## Booting the firmware
 
 ```sh
 ./rpcsx --system --mount /path/to/firmware/md0/ / /mini-syscore.elf
@@ -38,5 +40,6 @@ Compatible versions:
 - Use optional argument `--safemode` for booting in safe mode.
 
 ## Global optional args
+
 - Log a segfault: `--trace`
 - Log to a text file: add `&> log.txt` at the end of the whole command before pressing enter