Skip to content

Lua scripts for a memory watcher for games in the Metroid Prime Series

License

Notifications You must be signed in to change notification settings

mrwhiskersunderscore/Prime-RAM-Watch-CT

Repository files navigation

Supported Dolphin Versions

Dolphin Emulator

All official or dev builds of Dolphin Emulator should work now :)

I recommend 4.0-4222 or 5.0-10833+

Games Supported

Metroid Prime 1 NTSC (0-00), Metroid Prime 2: Echoes NTSC (0-00), Metroid Prime 3: Corruption NTSC (0A-0)

*support for the Prime Trilogy Disc, Wii de Asobu, Prime 1 JP, Prime 1 Korean (0-30), Prime 1 PAL, Echoes PAL, and Dark Echoes, and PAL Corruption is planned in that order.

*Practice mod is not supported (though partially works) and Menu mod is not supported at all. You probably shouldn't be TAS'ing on these anyways.

ram-watch-cheat-engine

RAM watch display examples, using Lua scripts in Cheat Engine.

Basic use of Cheat Engine lets you display RAM values in real time while a game is running, but with scripting you can get a much more customized display.

What you'll need

* The Lua files in this repository. Download the ZIP, and extract it somewhere on your computer.

* Cheat Engine https://www.cheatengine.org/downloads.php
  These scripts have mainly been tested with Cheat Engine 6.8.3 (64-bit version). 

* A code editor that supports Lua syntax highlighting. I personally use ZeroBrane Studio.
  You can find ZeroBrane Studio here https://studio.zerobrane.com/
  More simple text editors like Notepad or Notepad++ also work.

First Usage

Go into Cheat Engine Settings and navigate to Scan Settings

From here, uncheck the first two boxes for MEM_PRIVATE and MEM_IMAGE.

Finally check the third box to force Cheat Engine to only scan MEM_MAPPED. Dolphin emulator uses mapped memory for its emulated memory so it's important that we only scan that.

(Note: this will mean that we are only scanning mapped memory from here on out so you'll have to change your settings back if you use cheat engine in other applications)

How to use

Run Cheat Engine. In the Cheat Engine window, click File -> Open Process, then scroll to your dolphin window and select it and click open. Alternatively you can click the computer shaped icon in the top left and select dolphin from there. Next, in the Cheat Engine window, click File -> Load and select PrimeList.CT and select yes when prompted. Make sure that Cheat Engine is both hooked, and that dolphin is running a game before attempting to load PrimeList.

Performance note

Running one of these scripts alongside your game may cause the game to run slower. Generally, it seems to get worse if you've clicked Execute Script many times while testing, and in this case closing and re-opening Cheat Engine may make it better. (But I could be wrong.)

Closing the window causes an "Error:Access violation" which has yet to be resolved. If you close the window by mistake you will likely need to close and re-open Cheat Engine to fix the issue.

Acknowledgments

Masterjun, for writing the RAM watch script (2013/08/26) that this project was based on: http://pastebin.com/vUCmhwMQ

Tales, for helping answer some questions I had. Some of Tale's other Sonic scripts are what the prime scripts is heavily based off of.

About

Lua scripts for a memory watcher for games in the Metroid Prime Series

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages