How to record an INP using WolfMame

NOTE: This guide is a work in progress and is not yet finished.

This guide will explain how to record an INP file using WolfMame. Please note, that only WolfMame INP files will be accepted for the purposes of leaderboard verification. In order to qualify for a top position on our leaderboards you MUST be running on WolfMame.

You can find WolfMame here: http://replay.marpirc.net/

=========================================
Recording an INP File
=========================================

1. Once you have installed WolfMame, check the folder containing WolfMame's executable and look for the file "Record.bat":

Find Record.bat
https://i.imgur.com/4vnKG5m.png

2. Record.bat is a special way of running wolfmame, which will automatically boot straight into the game of choice and start recording an input file. However we need to specify both the Rom which we wish to run and the name of the INP file we wish to save. To do this, we will create a shortcut to Record.bat.

Right click on Record.bat and click on "Create Shortcut".

Create a Shortcut from Record.bat
https://i.imgur.com/BiCaRow.png

3. Now that we have a "record - shortcut" file, we will need to modify it's properties and add the Rom name and INP output filename to the command line.

Right click on "Record - Shortcut" and click on "Properties".

https://i.imgur.com/l001nZq.png

4. Look for the box marked "Target". This is where we will add our extra options.

Add the name of the ROM first, then the name of the INP file to be saved second. Any further options may be added after it, including -window to run in windowed mode if you wish.

For example, to run Mortal Kombat Rev 3.0 in Windowed mode it should say:

....\Record.bat mkla3 mkspeedrun -window

This will run, Mortal Kombat 1 Rev 3.0, save the Inputs to the file mkspeedrun.INP and also run the game in windowed mode.

https://i.imgur.com/43lQZuI.png

Once you have done this, double click on the shortcut to begin a run while recording an INP file.

**Note: If you see an error message stating that it couldn't find "NUL.ZIP" or "NUL.7z", do not be alarmed. This is perfectly normal and will not cause any negative effects to the recording process.**

https://i.imgur.com/IC2LYUP.png

4. It would be very annoying to have to quit and reload Mame for every single run. Thankfully, you can press Shift+F3 to automatically reset both the game and the recording.

Press Shift+F3 once to stop the recording.
Press Shift+F3 again to restart the game and restart the recording.

IMPORTANT:

- Pressing Shift+F3 will also overwrite your mkspeedrun.inp file, so if you completed a successful run that you wish to submit .. do NOT do this. Press ESC and quit WolfMame instead to save the INP and immediately backup the INP file before attempting another run (see next step).

- When running in this recording mode, the game will wipe any keybindings you have setup. You will have to set them again at the start of the first run. However, if you use Shift+F3 reset the game it will still remember them. You only have to do it once per session, not every run.

- Any and all Dip Switch settings of the game you are running are reset EVERY run, including the difficulty setting. However to qualify for our leaderboards you must show the difficulty at the start of every run anyway, so you must set it as such at the start of every run.

Stop Recording and Reset with Shift+F3
https://i.imgur.com/NgyMxle.png

5. Once you have completed a run that you wish to save, you have 2 options:

- Hit ESC to quit WolfMame. The game will have saved an INP called mkspeedrun.inp (or the name that you chose) in the INP folder in WolfMame.
OR
- Press F3 only ONCE without pressing Shift. It should show the same "recording ended" dialogue as when you reset, but the game will still be running. At this point, recording is stopped and the file is saved. You can alt-tab and copy the same saved INP called mkspeedrun.inp (or the name that you chose), from the INP folder in WolfMame. WolfMame will continue to run in the background. Once you have successfully backed up the INP, you can alt tab back to WolfMame and hit Shift+F3 to reset once again to begin creating a new INP file. The benefit of doing it this way is you will not have to re-configure your controls (you will still have to re-setup the difficulty and any other necessary DIP switch settings).

Find the INP file saved in the INP Folder
https://i.imgur.com/2HbFkSi.png
https://i.imgur.com/ldxabaK.png

6. It is important to rename this file to another before attempting another run, while you're at it .. also make a backup. This is the file you will need to submit to the moderators for verification of your run (along with any other evidence that is specified as necessary by the rules).

Rename INP
https://i.imgur.com/EUczQDq.png

=========================================
Playing back an INP File
=========================================

1. If you wish to play back the the INP file you have successfully saved. We will need to repeat a similar process as before with the file called "Playback.bat".

Find the file called Playback.bat

Playback
https://i.imgur.com/Y2PY968.png

2. Create a shortcut to it and modify it's properties.

3. Add the name of the Rom used when you recorded your run, the name of the INP file (located in the INP folder) and any additional options (such as -window).

Your run shall now play start to finish within WolfMame.

Mortal Kombat - Johnny Cage - Speedrun Guide

Mortal Kombat SNES Tutorial (Portuguese)

https://www.youtube.com/watch?v=L_FfGGKOUFM&t=50s

Credit to @HeatGaming

SMV creation guide (snes9x) Português [eng subtitles]

https://www.youtube.com/watch?v=rrExKeDUhk8

WolfMame for Mac

I have compiled and packaged my Wolfmame for mac.  It is version 0.220 for reference.

Firstly you will need SDL2 in order for it to run, it can be downloaded below.
https://www.libsdl.org/download-2.0.php

Here is the build
https://drive.google.com/open?id=1hdrh2foU19bgFQlMJrK1OfuyeSFFcf-4

I have left a readme in both the main folder as well as inside of the inprunshell folder, where you can find a sample shell script to being running and recording inp files. In order to run said script you need to open terminal and cd into the directory and type: "bash xmvsf.sh"  or whatever shell file name you've created. 

---
I cannot be certain this will run on your machine.

Also since I ran the build my self you will need to enable it's usage via security settings. 
Hope this helps more people get into speed running 

- Dusty

Name	Author
How to record an INP using WolfMame	Tenka 5 years ago
Mortal Kombat - Johnny Cage - Speedrun Guide	Tenka 4 years ago
Mortal Kombat SNES Tutorial (Portuguese)	Tenka 6 years ago
SMV creation guide (snes9x) Português [eng subtitles]	InnArik 5 years ago
WolfMame for Mac	Tenka 5 years ago