How to Install and Run Aldelaro5's Dolphin-memory-engine
Intro & Requirements
Aldelaro5's Dolphin-memory-engine is program that hooks to the Dolphin Emulation and allows the live view of the game's memory with features to run various data searches/scans. It supports both Mem80 and Mem90. It is a MUST have if you ever plan on creating your own ASM codes via Dolphin. Dolphin does come with it's own memory viewer, but it does not have live updates.
Requirements:
You will need to have a Developer Version of Dolphin already installed. 'Stable' versions will simply not work. Here is a guide on how to install Dolphin Dev Version - http://mkwii.com/showthread.php?tid=625
Installing & Running for Windows:
NOTE: For Windows 8 or later
Download the latest version (0.5.1) of Dolphin-memory-engine - https://github.com/aldelaro5/Dolphin-mem...indows.zip
Unzip the download. You will see an application called Dolphin-memory-engine.exe.
Dolphin-memory-engine is meant to run with Dolphin in Debugger Mode. Go to the directory where your Dolphin Emulator exe file (Dolphin.exe) is located. Using your mouse, do a Shift plus Right-Click inside the directory on an empty area. The windows command prompt will appear. In the command prompt, type "Dolphin.exe -d" (without the quotations, be sure the D in Dolphin is capitalized).
NOTE: Later versions of Dolphin (10xxx and beyond) don't require manual booting of the debugger mode. Launch Dolphin normally, click options, click the Interface tab. And select (checkmark) the 'Show Debugging UI' option.
Once Dolphin Debugger Mode has launched, launch your Dolphin-memory-engine.exe file. You should see something similar to this - http://mkwii.com/pics/screenshots/RAMViewer.png
At the top, the program should say it is hooked successfully. If not click the large Hook button. If it fails, restart both Dolphin & the Memory-engine, and try again. If the Memory-engine still fails to hook, scroll down to the Troubleshooting portion of the thread...
If the Memory-engine did get a successful hook, go ahead and launch your MKWii game. Then on Dolphin-memory-engine, click the "Open Memory Viewer" button. A new window will appear showing you the live view of MKWii's RAM. Congratz!
Installing & Running for Linux (Ubuntu or Debian only)
For Linux installation you will need to build the Memory-engine from source.
1. Update, upgrade, etc etc...
sudo apt-get update && sudo apt-get upgrade && sudo apt-get dist-upgrade && sudo apt-get autoremove && sudo apt-get autoclean
The above command will update and upgrade everything for your Linux OS plus delete/wipe any unneeded cache and/or dependencies
If you had to preform any upgrades, be sure to reboot your computer - sudo reboot
2. Install Dependencies
If you already have Dolphin-emulator installed on your Debian or Ubuntu system (via built from source code), then you already have all the dependencies, proceed to next step. If not, view the Dolphin install guide HERE and install all the dependencies from steps 2 & 3.
3. Download Master Github Package
Go to this link - https://github.com/aldelaro5/Dolphin-memory-engine
Click on the large button "Clone or download". Choose download, and download the zip file. The zip file - Dolphin-memory-engine-master.zip will be downloaded.
Unzip the file. There will be a master/root folder named - Dolphin-memory-engine-master. Move that master/root folder to a desired location (such as /home/yourusername).
4. Preparing and Executing the Build
Within the master/root folder, is a folder called Source. Using terminal, cd into the Source folder (ex: cd /home/yourusername/Dolphin-memory-engine-master/Source)
Run the following command...
mkdir build && cd build
Now run this command...
cmake ..
And finally run this...
make
The source code will now be built, takes just a few minutes. Once completed your terminal will be auto directed into /home/yourusername/Dolphin-memory-engine-master/Source/build
If not, just cd into that location.
5. Booting Dolphin-memory-engine
Before we boot Dolphin-memory-engine, you will need to launch Dolphin in Debugger Mode. This is simple to do. Open up another terminal, and run this command...
dolphin-emu -d
NOTE: Later versions of Dolphin (10xxx and beyond) don't require manual booting of the debugger mode. Launch Dolphin normally, click options, click the Interface tab. And select (checkmark) the 'Show Debugging UI' option.
Dolphin Debugger mode will now launch. Going back to your original terminal, run this command to boot the Memory-engine...
./Dolphin-memory-engine
You should see something similar to this - http://mkwii.com/pics/screenshots/RAMViewer.png
At the top, the program should say it is hooked successfully. If not click the large Hook button. If it fails, restart both Dolphin & the Memory-engine, and try again. If the Memory-engine still fails to hook, scroll down to the Troubleshooting portion of the thread...
If the Memory-engine did get a successful hook, go ahead and launch your MKWii game. Then on Dolphin-memory-engine, click the "Open Memory Viewer" button. A new window will appear showing you the live view of MKWii's RAM. Congratz!
Troubleshooting
If you can't get the program to hook or a certain range of addresses won't display, here are some tips:
Try using an older version of the memory engine - https://github.com/aldelaro5/Dolphin-mem...e/releases
(Each release comes with precompiled and source versions for both Windows and Linux)
If that doesn't work, you can try using an older version of Dolphin or try an old version of both the Memory Engine and Dolphin.
Here are some combinations that I or others have had success with..
Dolphin version 10886 w/ Memory Engine version 0.5.0
Dolphin version 10886 w/ Memory Engine version 0.4.0
Dolphin version 10413 w/ Memory Engine version 0.5.0
Dolphin version 10413 w/ Memory Engine version 0.4.0
Dolphin version 8490 w/ Memory Engine version 0.4.0
Dolphin version 8279 w/ Memory Engine version 0.4.0
Dolphin version 8029 w/ Memory Engine version 0.4.0
Note for Linux Users wanting older versions of Dolphin Dev: You will need an older source package of the Dolphin Dev. Unfortunately there is no github database of older Dev revisions. Aldelaro himself has his own fork of Dolphin on his github. Link - https://github.com/aldelaro5/dolphin
Before compiling the source, you need to remove your current version of Dolphin completely. Wherever you main Dolphin folder is, there is a build directory within. Open a terminal within that build directory. Run this command....
sudo cat install_manifest.txt | xargs -d '\n' rm
Command will take a minute or so. Dolphin is now uninstalled.
Download the dolphin package. Extract it. Open a terminal within the main dolphin-master folder. That folder should contain some directories such as Cmake, Data, Externals, etc along with some files. Run these commands...
mkdir Build
cd Build
cmake ..
If there are any errors displayed when the 'cmake ..' command is finished, the make files will not be created thus allowing you to not continue the compilation. Most likely it will say your Qt version is out of date. Ubuntu 18 and Debian 10 have the proper Qt version. If you are not on one of those Linux OS's with this error occurring, you need to install Ubuntu 18 or Debian 10 on your computer. Yes I know this sucks...
If no errors occurred, type in this command now.....
make
The source will now compile (will take 5 - 10 minutes). Once the compilation is completely finished, type in this command now....
sudo make install
You may be prompted to enter in your password. Once you enter that command in, the finishing touches to the compilation will be finished.
Launch Dolphin in Debug mode then launch the Memory-engine and see if you can hook it. If this version of Dolphin by Aldelaro5 doesn't work for allowing the Memory-engine to hook, there is another option. You can try Dolphin Linux Source package for v10413 (which is what I use), contact me via discord (Vega#8365) for more information.
Once you have the v10413 downloaded. Extract the download and follow the exact same steps I listed earlier for installing Aldelaro's version of Dolphin.
