Skip to content

Commit

Permalink
Added documentation for ReactOS
Browse files Browse the repository at this point in the history
  • Loading branch information
4d61726b committed Jun 23, 2024
1 parent 64d7596 commit 98d0aa3
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 3 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
* Support for the latest VMware Workstation Pro
* Support for the latest VirtualBox
* Support starting with Windows XP up to the latest Windows 11
* Support for ReactOS
* Support for the latest [WinDbg Preview](https://www.microsoft.com/en-us/p/windbg-preview/9pgjgd53tn86)
* Toolchain modernization. Builds with Visual Studio 2022
* Simplified build system. No additional libraries required
Expand Down
20 changes: 17 additions & 3 deletions VirtualKD-Redux/Docs/Tutorial.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# VirtualKD-Redux Tutorial

## Guest VM
## Guest VM (Windows)

![](TutorialGuest.gif)

1. Copy the target folder to the guest VM running inside VMware Workstation. If the Guest VM is running a 32-bit OS, copy "target32". Otherwise, if it's running a 64-bit OS, then copy "target64" instead.
1. Copy the target folder to the guest VM running inside VMware Workstation or VirtualBox. If the Guest VM is running a 32-bit OS, copy "target32". Otherwise, if it's running a 64-bit OS, then copy "target64" instead.

2. Run "vminstall.exe" in the guest VM. If using Windows 10, ensure that "Replace kdcom.dll" is checked. Once the installer is complete, allow the guest VM to restart.

Expand All @@ -14,6 +14,20 @@

:bulb: You can use virtual machine snapshots to avoid having to perform these steps every time. Once the final step is completed and the OS has successfully booted, make a snapshot that can later be restored. **It is important to note that if a newer version of VirtualKD-Redux is installed on the host, then the guest VM must also be updated and vice versa. It is strongly recommended to make a new snapshot after upgrading and rebooting the guest VM.**

## Guest VM (ReactOS)

This is only applicable if you are using ReactOS and not Windows in your guest VM.

1. Download and install the "MSVC Debug" version of ReactOS in your guest VM.

2. Copy the target folder to the guest VM running inside VMware Workstation or VirtualBox. If the Guest VM is running a 32-bit OS, copy "target32". Otherwise, if it's running a 64-bit OS, then copy "target64" instead.

3. Copy "kdcom.dll" from the target folder into the "system32" folder of your ReactOS installation. This should overwrite the existing "kdcom.dll" that was part of the ReactOS installation.

4. Reboot the guest VM.

5. At the boot manager prompt, select the "ReactOS (Debug)" entry.

## Host (VirtualBox ONLY)

If you are using VMware Workstation, skip to the "Final Steps" section.
Expand All @@ -28,7 +42,7 @@ The latest version of VirtualBox is hardened and requires kdclient to be signed

![](TutorialHost.gif)

1. If your host OS is a 64-bit machine run "vmmon64.exe". Otherwise, if it's running a 32-bit OS, instead run "vmmon32.exe".
1. Run "vmmon64.exe" on your host OS.

2. If this is your first time running VirtualKD-Redux, ensure that the "Debugger path" is properly set. This can be the path to "windbg.exe" installed on your system.

Expand Down

0 comments on commit 98d0aa3

Please sign in to comment.