About This File
:
MEmu := "RetroArch"
MEmuV := "v05-11-2015 Nightly"
MURL := ["http://themaister.net/retroarch.html"]
MAuthor := ["djvj","zerojay"]
MVersion := "2.4.2"
MCRC := ""
iCRC := ""
MID := ""
MSystem := ["NEC SuperGrafx"]
;----------------------------------------------------------------------------
; Notes:
; If the emu doesn't load and you get no error, usually this means the LibRetro DLL is not working!
; Devs stated they will never add support for mounted images (like via DT)
; Fullscreen is controlled via the module setting in RocketLauncherUI
; This module uses the CLI version of RetroArch (retroarch.exe), not the GUI (retroarch-phoenix.exe).
; The emu may make a mouse cursor appear momentarily during launch, MouseMove and hide_cursor seem to have no effect
; Enable 7z support for archived roms
; Available CLI options: https://github.com/PyroFilmsFX/iOS/blob/master/docs/retroarch.1
;
; LibRetro DLLs:
; LibRetro DLLs come with the emu, but here is another source for them: http://forum.themaister.net/
; Whatever cores you decide to use, make sure they are extracted anywhere in your Emu_Path\cores folder. The module will find and load the default core unless you choose a custom one for each system.
; You can find supported cores that Retroarch supports simply by downloading them from the "retroarch-phoenix.exe" or by visiting here: https://github.com/libretro/libretro.github.com/wiki/Supported-cores
; Some good discussion on cores and filters: http://forum.themaister.net/viewtopic.php?id=270
;
; SRM files:
; srm are stored in a "srm" dir in the emu folder. Each system ran through retroarch gets its own folder inside srm
;
; Save states:
; Save states are stored in a "save" dir in the emu folder. Each system ran through retroarch gets its own folder inside save
;
; Config files:
; By default, the module looks for config files in a folder called config in the RetroArch folder. Example: C:\emus\RetroArch\config. You can change this folder to anything you like by changing the module's ConfigFolder setting in RocketLauncherUI.
; RetroArch's global config file is called "retroarch.cfg". RetroArch will use a system cfg file named to match your System Name (example: Nintendo Entertainment System.cfg).
; RetroArch will also load core config files named after the core name. Example: nestopia_libretro.cfg
; This allows different settings globally, for each system, and for each core. If you want all systems to use the same retroarch.cfg, do not have any system or core cfg files, only have the retroarch.cfg.
; If a core config exists, it takes precedence over the global config. And if a system config exists, it takes precedence over the core config.
;
; MultiGame:
; MultiGame support is currently only available for the Mednafen PSX core. Retroarch uses the same method as Mednafen to load multi-disc games. This method involves m3u playlists which are commonly used for music. The m3u files needed to load multi-disc games are generated for you by the module when you launch a multi-disc game and are saved to your corresponding rom directory. Due to m3u limitations, your multi-disc roms/images cannot be archived -- they must be unzipped. All single disc games can remain archived and you can still enable 7z under system settings. If you do not wish to use MultiGame support you can archive your roms/images and m3u generation will be skipped on launch.
; The m3u files generated by the module contain a list of paths to all roms/images in the multi-disc set. Retroarch automatically loads the first path in the m3u so the first path will always be the disc you are loading. For example, Final Fantasy VII has 3 discs and if you load Disc 2 first, the order of the paths in the m3u will be disc 2, disc 3, disc 1. If you load Disc 3 first, the order will be disc 3, disc 1, disc 2. The module anticipates this and will load the correct disk, selected from the Pause/MultiDisk menus. However if you choose to manually use Retroarch's UI or disk swap keys to change discs, you will need to keep this in mind.
; In order for RocketLauncher's MultiGame UI to swap discs, you must define Eject_Toggle_Key, Next_Disk_Key, and Previous_Disk_Key under global settings for the emulator in RocketLauncher. Because AHK and Retroarch use different naming conventions for some keyboard keys, it is best to use a letter, a number, or F1-F12.
;
; MAME:
; MAME BIOS roms should be placed in the system\mame folder
;
; System Specific Notes:
; Microsoft MSX/MSX2: Launch an MSX game and in the core options, set the console to be an MSX2 and it will play both just fine.
; Nintendo Famicom Disk System - Requires disksys.rom be placed in the folder you define as system_directory in the RetroArch's cfg.
; Sega CD - Requires "bios_CD_E.bin", "bios_CD_J.bin", "bios_CD_U.bin" all be placed in the folder you define as system_directory in the RetroArch's cfg.
; Super Nintendo Entertainment System - requires split all 10 dsp# & st### roms all be placed in the folder you define as system_directory in the RetroArch's cfg. Many games, like Super Mario Kart require these.
; NEC TurboGrafx-CD (using pce fast core) - Requires "syscard3.pce" be placed in the folder you define as system_directory in the RetroArch's cfg.
; NEC TurboGrafx-CD (using MAME core)
; - You'll need to update a couple mame specific options in the Retroarch core options file to get it to boot from the cli. These should probably be updated automagically by the module. Turning softlists off, but might not need to.
; mame_boot_from_cli = "enabled"
; mame_softlists_enable = "disabled"
; mame_softlists_auto_media = "disabled"
; - Requires hash folder from MAME/MESS/UME, either from the source or release package. Save this in the system_directory you've defined for RetroArch. Something like \RetroArch\system\mame\hash\
; - Requires the CD bios file(s) saved in the mame bios folder you've defined. Usually \RetroArch\system\mame\bios\
; For PC Engine-CD you'll need the file "[cd] cd-rom system (japan) (v2.1).pce" zipped as cdsys.zip and saved in a pce subfolder in your bios path, so \RetroArch\system\mame\bios\pce\cdsys.zip
; For PC Engine SuperGrafx-CD you'll need the file "[cd] super cd-rom system (japan) (v3.0).pce" zipped as scdsys.zip and saved in a pce subfolder in your bios path, so \RetroArch\system\mame\bios\pce\scdsys.zip
; For TurboGrafx-CD you'll need the file "[cd] turbografx cd system card (usa) (v2.0).pce" zipped as cdsys.zip and saved in a tg16 subfolder in your bios path, so \RetroArch\system\mame\bios\tg16\cdsys.zip
; For TurboDuo you'll need the file "[cd] turbografx cd super system card (usa) (v3.0).pce" zipped as scdsys.zip and saved in a tg16 subfolder in your bios path, so \RetroArch\system\mame\bios\tg16\scdsys.zip
; Nintendo Super Game Boy - Set the Module setting in RocketLauncherUI SuperGameBoy to true to enable a system or only a rom to use SGB mode. This is not needed if your systemName is set to the official name of "Nintendo Super Game Boy". Requires "sgb.boot.rom" and "Super Game Boy (World).sfc" to be placed in the folder you define as system_directory in the RetroArch's cfg. This is needed if you want to use Super game boy mode and color palettes. Also requires using the latest bsnes core. Not all games support SGB mode.
; MAME: The nag screen patch has been removed from the MAME core as of some point in March. We will be investigating our options for this. For MAME-based systems, make sure to set 7z use to false as MAME needs zip files.
; Sony PSP/PlayStation Minis: To avoid the dialog box complaining about ppge_atlas.zim, download it from https://github.com/libretro/libretro-ppsspp/blob/master/assets/ppge_atlas.zim and place it in your Retroarch/system/PPSSPP/ directory.
;----------------------------------------------------------------------------
StartModule()
BezelGUI()
FadeInStart()
primaryExe := new Emulator(emuPath . "\" . executable) ; instantiate emulator executable object
emuPrimaryWindow := new Window(new WindowTitle("RetroArch","RetroArch")) ; instantiate primary emulator window object
emuConsoleWindow := new Window(new WindowTitle(,"ConsoleWindowClass")) ; instantiate emulator console window object
; Here we define all supported systems for this module. This object controls how the module reacts to different systems. RetroArch can play a lot of systems, but needs to know what system you want to run, so this module has to adapt.
; 1 - Official System Name in RocketLauncher
; 2 - Short name used only for easy referencing within module
; 3 - Default core
; 4 - The system ID MAME core recognizes
RLLog.Debug("Module - Started building the " . MEmu . " object")
mTypeVar:="
( LTrim
NEC SuperGrafx|LibRetro_SGFX|mednafen_supergrafx_libretro|sgx,cart
)"
mType := Object()
Loop, Parse, mTypeVar, `n, `r
{
obj := {}
Loop, Parse, A_LoopField, |
{
If (A_Index = 1)
obj.System := A_LoopField
Else If (A_Index = 2)
obj.ID := A_LoopField
Else If (A_Index = 3)
obj.Core := A_LoopField
Else { ; 4
StringSplit, tmp, A_LoopField, `,
obj.MAMEID := tmp1
obj.MAMEMedia := tmp2
}
}
mType.Insert(obj["System"], obj)
}
RLLog.Debug("Module - Finished building the " . MEmu . " object")
; For easier use throughout the module
retroSystem := mType[systemName].System
retroID := mType[systemName].ID
retroCore := mType[systemName].Core
retroMAMEID := mType[systemName].MAMEID
retroMAMEMedia := mType[systemName].MAMEMedia
RLLog.Info("Module - Using these system variables:")
RLLog.Info("Module - retroSystem: " . retroSystem)
RLLog.Info("Module - retroID: " . retroID)
RLLog.Info("Module - retroCore: " . retroCore)
RLLog.Info("Module - retroMAMEID: " . retroMAMEID)
RLLog.Info("Module - retroMAMEMedia: " . retroMAMEMedia)
If !retroSystem
ScriptError("Your systemName is: " . systemName . "`nIt is not one of the known supported systems for this " . MEmu . " module: " . moduleName)
If !retroCore
ScriptError("Your Core ID is: " . retroID . "`nCould not find a default core to use. Please update the module with a default core.")
Fullscreen := moduleIni.Read("Settings", "Fullscreen","true",,1)
configFolder := moduleIni.Read("Settings", "ConfigFolder",emuPath . "\config",,1)
mameRomPath := moduleIni.Read("MAME", "BIOS_Roms_Folder",,,1)
mameHideNag := If moduleIni.Read("MAME", "Hide_Nag_Screen","false",,1) = "true" ? "enabled" : "disabled"
mameHideInfo := If moduleIni.Read("MAME", "Hide_Info_Screen","false",,1) = "true" ? "enabled" : "disabled"
mameHideWarn := If moduleIni.Read("MAME", "Hide_Warning_Screen","false",,1) = "true" ? "enabled" : "disabled"
hideConsole := moduleIni.Read("Settings", "HideConsole","true",,1)
ejectToggleKey := moduleIni.Read("Settings", "Eject_Toggle_Key",,,1)
nextDiskKey := moduleIni.Read("Settings", "Next_Disk_Key",,,1)
prevDiskKey := moduleIni.Read("Settings", "Previous_Disk_Key",,,1)
core := moduleIni.Read(romName . "|" . systemName, "LibRetro_Core",retroCore,,1)
superGB := moduleIni.Read(romName . "|" . systemName, "SuperGameBoy","false",,1)
enableNetworkPlay := moduleIni.Read(romName . "|Network", "Enable_Network_Play","false",,1)
overlay := moduleIni.Read(romName . "|" . systemName, "Overlay",,,1)
videoShader := moduleIni.Read(romName . "|" . systemName, "VideoShader",,,1)
aspectRatioIndex := moduleIni.Read(romName . "|" . systemName, "AspectRatioIndex",,,1)
customViewportWidth := moduleIni.Read(romName . "|" . systemName, "CustomViewportWidth",,,1)
customViewportHeight := moduleIni.Read(romName . "|" . systemName, "CustomViewportHeight",,,1)
customViewportX := moduleIni.Read(romName . "|" . systemName, "CustomViewportX",,,1)
customViewportY := moduleIni.Read(romName . "|" . systemName, "CustomViewportY",,,1)
stretchToFillBezel := moduleIni.Read(romName . "|" . systemName, "StretchToFillBezel","false",,1)
rotation := moduleIni.Read(romName . "|" . systemName, "Rotation",0,,1)
cropOverscan := moduleIni.Read(romName . "|" . systemName, "CropOverscan",,,1)
threadedVideo := moduleIni.Read(romName . "|" . systemName, "ThreadedVideo",,,1)
vSync := moduleIni.Read(romName . "|" . systemName, "VSync",,,1)
integerScale := moduleIni.Read(romName . "|" . systemName, "IntegerScale",,,1)
configurationPerCore := moduleIni.Read(romName . "|" . systemName, "ConfigurationPerCore","false",,1)
If (StringUtils.Contains(core, "^(mame|mess|ume)") && !retroMAMEID) {
retroMAMEID := "mame" ; set all systems that use a mame core to the default mame ID so any system name is supported
RLLog.Warning("Module - Setting MAMEID to default ""mame"" for """ . retroSystem . """")
}
configFolder := RLObject.getFullPathFromRelative(rlPath,configFolder)
mameRomPath := If mameRomPath ? RLObject.getFullPathFromRelative(rlPath,mameRomPath) : romPath
overlay := RLObject.getFullPathFromRelative(rlPath,overlay)
videoShader := RLObject.getFullPathFromRelative(rlPath,videoShader)
rotateBezel := false
configFolder := new Folder(configFolder)
If (retroID = "LibRetro_SGB" || superGB = "true") ; if system or rom is set to use Super Game Boy
{ superGB := "true" ; setting this just in case it's false and the system is Nintendo Super Game Boy
sgbRomPath := CheckFile(emuPath . "\system\Super Game Boy (World).sfc","Could not find the rom required for Super Game Boy support. Make sure the rom ""Super Game Boy (World).sfc"" is located in: " . emuPath . "\system")
CheckFile(emuPath . "\system\sgb.boot.rom","Could not find the bios required for Super Game Boy support. Make sure the bios ""sgb.boot.rom"" is located in: " . emuPath . "\system")
retroID := "LibRetro_SGB" ; switching to Super Game Boy mode
retroSystem := "Nintendo Super Game Boy"
}
; Find the dll for this system
libDll := CheckFile(emuPath . "\cores\" . core . ".dll", "Your " . retroID . " dll is set to " . core . " but could not locate this file:`n" . emuPath . "\cores\" . core . ".dll")
; Find the cfg file to use
If !configFolder.Exist()
ScriptError("You need to make sure ""ConfigFolder"" is pointing to your RetroArch config folder. By default it is looking here: """ . configFolder.FilePath . """")
globalRetroCfg := emuPath . "\retroarch.cfg"
systemRetroCfg := configFolder.FilePath . "\" . retroSystem . ".cfg"
coreRetroCfg := configFolder.FilePath . "\" . core . ".dll.cfg"
RLLog.Info("Module - Global cfg should be: " . globalRetroCfg)
RLLog.Info("Module - System cfg should be: " . systemRetroCfg)
RLLog.Info("Module - Core cfg should be: " . coreRetroCfg)
foundCfg := ""
systemRetroCfg := new File(systemRetroCfg)
coreRetroCfg := new File(coreRetroCfg)
globalRetroCfg := new File(globalRetroCfg)
If systemRetroCfg.Exist() { ; check for system cfg first
retroCFGFile := systemRetroCfg
foundCfg := 1
RLLog.Info("Module - Found a System cfg!")
} Else If coreRetroCfg.Exist() { ; 2nd option is a core config
retroCFGFile := coreRetroCfg
foundCfg := 1
RLLog.Info("Module - Found a Core cfg!")
} Else If globalRetroCfg.Exist() { ; 3rd is global cfg
retroCFGFile := globalRetroCfg
foundCfg := 1
RLLog.Info("Module - Found a Global cfg!")
}
If foundCfg {
RLLog.Info("Module - " . MEmu . " is using " . retroCFGFile.FileFullPath . " as its config file.")
retroCFG := LoadProperties(retroCFGFile.FileFullPath)
} Else
RLLog.Warning("Module - Could not find a cfg file to update settings. RetroArch will make one for you.")
If StringUtils.Contains(rotation,"1|3") ; use vertical bezel if RA rotation is set to 90 or 270 degrees
rotateBezel := true
If StringUtils.Contains(retroID, "LibRetro_NFDS|LibRetro_SCD|LibRetro_TGCD|LibRetro_PCECD|LibRetro_PCFX") { ; these systems require the retroarch settings to be read
retroSysDir := ReadProperty(retroCFG,"system_directory") ; read value
retroSysDir := ConvertRetroCFGKey(retroSysDir) ; remove dbl quotes
retroSysDirLeft := StringUtils.Left(retroSysDir, 2)
If (retroSysDirLeft = ":\") { ; if retroarch is set to use a default folder
retroSysDir := StringUtils.TrimLeft(retroSysDir, 1)
RLLog.Info("Module - RetroArch is using a relative system path: """ . retroSysDir . """")
retroSysDir := emuPath . retroSysDir
}
If !retroSysDir
ScriptError("RetroArch requires you to set your system_directory and place bios rom(s) in there for """ . retroSystem . """ to function. Please do this first by running ""retroarch-phoenix.exe"" manually.")
checkForSlash := StringUtils.Right(retroSysDir, 1)
If (checkForSlash = "\") ; check if a backslash is the last character. If it is, remove it, as this is non-standard method to define folders
retroSysDir := StringUtils.TrimRight(retroSysDir, 1)
}
If (StringUtils.Contains(core, "^(mame|mess|ume)")) || (StringUtils.Contains(retroID, "LibRetro_N64|LibRetro_NES|LibRetro_LYNX|LibRetro_PSX")) || (StringUtils.Contains(retroID, "LibRetro_NES") && (StringUtils.Contains(core, "nestopia_libretro"))) { ; these systems will use an ini to store game specific settings
RLLog.Info("Module - Reading / creating system ini for specific settings.")
If !StringUtils.Contains(core, "^(mame|mess|ume)") {
If !SystemModuleIni.Exist()
SystemModuleIni.Append ; create a new blank ini file if one does not exist
}
If (configurationPerCore = "true") {
coreOptionsCFGFile := new File(configFolder.FilePath . "\retroarch-core-options.cfg")
coreOptionsCFGFile.CheckFile("Could not find retroarch-core-options.cfg in retroarch directory: """ . configFolder.FilePath . """")
} Else {
coreOptionsCFGFile := new File(emuPath . "\retroarch-core-options.cfg")
coreOptionsCFGFile.CheckFile("Could not find retroarch-core-options.cfg in retroarch directory: """ . emuPath . """")
}
coreOptionsCFG := LoadProperties(coreOptionsCFGFile.FileFullPath)
If StringUtils.Contains(core, "^(mame|mess|ume)") { ; Set some MAME/MESS/UME core options.
tmpCore := If StringUtils.Contains(core, "mame") ? "mame" : "mess"
WriteProperty(coreOptionsCFG, tmpCore . "_read_config", """enabled""", 1)
WriteProperty(coreOptionsCFG, tmpCore . "_boot_from_cli", """enabled""", 1) ; This needs to be enabled in order to run games with RLauncher
WriteProperty(coreOptionsCFG, tmpCore . "_hide_nagscreen", "" . mameHideNag . "", 1)
WriteProperty(coreOptionsCFG, tmpCore . "_hide_infoscreen", "" . mameHideInfo . "", 1)
WriteProperty(coreOptionsCFG, tmpCore . "_hide_warnings", "" . mameHideWarn . "", 1)
} Else If StringUtils.Contains(retroID, "LibRetro_N64") { ; Nintendo 64
mupenGfx := moduleIni.Read(romName . "|" . systemName, "Mupen_Gfx_Plugin", "auto",,1)
mupenRsp := moduleIni.Read(romName . "|" . systemName, "Mupen_RSP_Plugin", "auto",,1)
mupenCpu := moduleIni.Read(romName . "|" . systemName, "Mupen_CPU_Core", "dynamic_recompiler",,1)
mupenPak1 := moduleIni.Read(romName . "|" . systemName, "Mupen_Pak_1", "memory",,1)
mupenPak2 := moduleIni.Read(romName . "|" . systemName, "Mupen_Pak_2", "memory",,1)
mupenPak3 := moduleIni.Read(romName . "|" . systemName, "Mupen_Pak_3", "memory",,1)
mupenPak4 := moduleIni.Read(romName . "|" . systemName, "Mupen_Pak_4", "memory",,1)
mupenGfxAccur := moduleIni.Read(romName . "|" . systemName, "Mupen_Gfx_Accuracy", "high",,1)
mupenExpMem := moduleIni.Read(romName . "|" . systemName, "Mupen_Disable_Exp_Memory", "no",,1)
mupenTexturFilt := moduleIni.Read(romName . "|" . systemName, "Mupen_Texture_Filtering", "nearest",,1)
mupenViRefresh := moduleIni.Read(romName . "|" . systemName, "Mupen_VI_Refresh", "2200",,1)
mupenFramerate := moduleIni.Read(romName . "|" . systemName, "Mupen_Framerate", "fullspeed",,1)
mupenResolution := moduleIni.Read(romName . "|" . systemName, "Mupen_Resolution", "640x480",,1)
mupenPolyOffstFctr := moduleIni.Read(romName . "|" . systemName, "Mupen_Polygon_Offset_Factor", "-3.0",,1)
mupenPolyOffstUnts := moduleIni.Read(romName . "|" . systemName, "Mupen_Polygon_Offset_Units", "-3.0",,1)
mupenViOverlay := moduleIni.Read(romName . "|" . systemName, "Mupen_VI_Overlay", "disabled",,1)
mupenAnalogDzone := moduleIni.Read(romName . "|" . systemName, "Mupen_Analog_Deadzone", "15",,1)
WriteProperty(coreOptionsCFG, "mupen64-gfxplugin", mupenGfx, 1)
WriteProperty(coreOptionsCFG, "mupen64-rspplugin", mupenRsp, 1)
WriteProperty(coreOptionsCFG, "mupen64-cpucore", mupenCpu, 1)
WriteProperty(coreOptionsCFG, "mupen64-pak1", mupenPak1, 1)
WriteProperty(coreOptionsCFG, "mupen64-pak2", mupenPak2, 1)
WriteProperty(coreOptionsCFG, "mupen64-pak3", mupenPak3, 1)
WriteProperty(coreOptionsCFG, "mupen64-pak4", mupenPak4, 1)
WriteProperty(coreOptionsCFG, "mupen64-gfxplugin-accuracy", mupenGfxAccur, 1)
WriteProperty(coreOptionsCFG, "mupen64-disableexpmem", mupenExpMem, 1)
WriteProperty(coreOptionsCFG, "mupen64-filtering", mupenTexturFilt, 1)
WriteProperty(coreOptionsCFG, "mupen64-virefresh", mupenViRefresh, 1)
WriteProperty(coreOptionsCFG, "mupen64-framerate", mupenFramerate, 1)
WriteProperty(coreOptionsCFG, "mupen64-screensize", mupenResolution, 1)
WriteProperty(coreOptionsCFG, "mupen64-polyoffset-factor", mupenPolyOffstFctr, 1)
WriteProperty(coreOptionsCFG, "mupen64-polyoffset-units", mupenPolyOffstUnts, 1)
WriteProperty(coreOptionsCFG, "mupen64-angrylion-vioverlay", mupenViOverlay, 1)
WriteProperty(coreOptionsCFG, "mupen64-astick-deadzone", mupenAnalogDzone, 1)
} Else If StringUtils.Contains(retroID, "LibRetro_NES") { ; these systems will use an ini to store game specific settings
If StringUtils.Contains(core, "nestopia_libretro") { ; Nestopia
nestopiaBlargg := moduleIni.Read(romName . "|Nestopia", "Nestopia_Blargg_NTSC_Filter", "disabled",,1)
nestopiaPalette := moduleIni.Read(romName . "|Nestopia", "Nestopia_Palette", "canonical",,1)
nestopiaNoSprteLimit := moduleIni.Read(romName . "|Nestopia", "Nestopia_Remove_Sprites_Limit", "disabled",,1)
WriteProperty(coreOptionsCFG, "nestopia_blargg_ntsc_filter", nestopiaBlargg, 1)
WriteProperty(coreOptionsCFG, "nestopia_palette", nestopiaPalette, 1)
WriteProperty(coreOptionsCFG, "nestopia_nospritelimit", nestopiaNoSprteLimit, 1)
}
} Else If StringUtils.Contains(retroID, "LibRetro_LYNX") { ; Atari Lynx
If StringUtils.Contains(core, "handy_libretro") { ; Handy
handyRotate := moduleIni.Read(romName . "|" . systemName, "Handy_Rotation", "None",,1)
If StringUtils.Contains(handyRotate, "240") or StringUtils.Contains(handyRotate, "90")
rotateBezel := true
WriteProperty(coreOptionsCFG, "handy_rot", handyRotate, 1)
}
} Else If StringUtils.Contains(retroID, "LibRetro_PSX") { ; Sony PlayStation
psxCdImageCache := moduleIni.Read(romName . "|" . systemName, "PSX_CD_Image_Cache", """enabled""",,1)
psxMemcardHandling := moduleIni.Read(romName . "|" . systemName, "PSX_Memcard_Handling", """libretro""",,1)
psxDualshockAnalogToggle := moduleIni.Read(romName . "|" . systemName, "PSX_Dualshock_Analog_Toggle", """enabled""",,1)
WriteProperty(coreOptionsCFG, "beetle_psx_cdimagecache", psxCdImageCache, 1)
WriteProperty(coreOptionsCFG, "beetle_psx_use_mednafen_memcard0_method", psxMemcardHandling, 1)
WriteProperty(coreOptionsCFG, "beetle_psx_analog_toggle", psxDualshockAnalogToggle, 1)
}
SaveProperties(coreOptionsCFGFile.FileFullPath, coreOptionsCFG)
}
hideEmuObj := Object(emuConsoleWindow,0,emuPrimaryWindow,1)
7z(romPath, romName, romExtension, sevenZExtractPath)
mgM3UFile := new File(romPath . "\" . romTable[1,4] . ".m3u")
mgRomExtensions := "cue|iso|ccd"
mgValidExtension := false
Loop, Parse, mgRomExtensions, |
If (romExtension = "." . A_LoopField)
mgValidExtension := true
If (StringUtils.Contains(retroID, "LibRetro_PSX") && romTable.MaxIndex() && mgValidExtension) { ; See if MultiGame table is populated
m3uRomIndex := Object()
mgType := romTable[1,6] . " "
mgMaxIndex := romTable.MaxIndex()
mgRomIndex := 0
If mgM3UFile.Exist()
mgM3UFile.Delete()
Loop % mgMaxIndex
{
If (romTable[A_Index, 3] = romName) {
tempType := romTable[A_Index, 5]
mgRomIndex := StringUtils.TrimLeft(tempType, StringUtils.StringLength(mgType))
RLLog.Info("Found rom index in rom set in romTable: " . mgRomIndex)
Break
}
}
If (mgRomIndex > 0) {
tempRomIndex := mgRomIndex
Loop % mgMaxIndex
{
mgTypeIndex := mgType . tempRomIndex
m3uRomIndex.Insert(tempRomIndex)
Loop % mgMaxIndex
{
If (romTable[A_Index, 5] = mgTypeIndex) {
tempRomPath := romTable[A_Index, 1]
mgM3UFile.Append(tempRomPath . "`n")
RLLog.Info("Module - Appending rom path to m3u: " . tempRomPath)
Break
}
}
If (tempRomIndex < mgMaxIndex)
tempRomIndex++
Else
tempRomIndex := 1
}
}
}
; MAME/MESS/UME core options
MAMEParam1 := ""
MAMEParam2 := ""
MAMEParam3 := ""
If StringUtils.Contains(core, "^(mame|mess|ume)") { ; if a MAME/MESS/UME core is used
If !retroMAMEID
ScriptError("Your systemName is: " . systemName . "`nIt is not one of the known supported systems for the MAME/MESS/UME LibRetro core")
Else
RLLog.Info("Module - MAME/MESS/UME mode using a known ident: " . retroMAMEID)
If !mameRomPath
ScriptError("Please set the RetroArch module setting ""BIOS_Roms_Folder"" to the folder that contains your MAME/MESS/UME BIOS roms to use with RetroArch.")
If (retroMAMEID = "mame") { ; want this for arcade mame only
RLLog.Info("Module - Retroarch MAME/MESS/UME Arcade mode enabled")
fullRomPath := " """ . romPath . "\" . romName . romExtension . """"
} Else {
RLLog.Info("Module - Retroarch MAME/MESS/UME Console/PC mode enabled")
MAMEParam1 := ""
MAMEParam2 := " -rompath \""" . mameRomPath . "\"""
; If we already have a media type, then use it.
If (StringUtils.Contains(retroMAMEID, "tg16|pce") && retroMAMEMedia = "cart") {
;MAMEParam3 := " -cart \" . """" . romPath . "\" . romName . romExtension . "\" . """"
MAMEParam3 := " -cart \""" . romPath . "\" . romName . romExtension . "\"""""
; TODO: This needs a better way to handle the cdrom bios files, in my opinion. As it is, there's no clean way to pick between the v2.00 or v3.00 bios.
; Defaulting to the TurboDuo cdrom bios since it will play 2.00 or 3.00 games.
} Else If (StringUtils.Contains(retroMAMEID, "tg16|pce") && retroMAMEMedia = "cdrom") {
;MAMEParam3 := " -cart cdsys -cdrm \" . """" . romPath . "\" . romName . romExtension . "\" . """"
MAMEParam3 := " -cart scdsys -cdrm \""" . romPath . "\" . romName . romExtension . "\"""""
} Else {
; Build a key/value object containing the different MAMEParam3 choices
MAMEP3 := Object("alice32","cass1","gp32","memc","cpc464","cass","spectrum","cass","dragon64","cass","cdimono1","cdrom","bk0010","cass","neocd","cdrom","neocdz","cdrom","saturn","cdrm","saturnjp","cdrm","svi328n","cass","pecom64","cass","psu","cdrm","svmu","quik","gamecom","cart1","mbeeic","quik1")
MAMEParam3 := MAMEP3[retroMAMEID] ; search object for the retroMAMEID pair
MAMEParam3 := " -" . (If MAMEParam3 ? MAMEParam3 : "cart") . " \" . """" . romPath . "\" . romName . romExtension . "\" . """"
}
If (retroMAMEID = "mbeeic") ; Applied Technology MicroBee
{ microbeeModel := IniReadCheck(MAMESysINI, romName, "MicroBee_Model","mbeeic",,1)
If microbeeModel not in mbee,mbeeic,mbeepc,mbeepc85,mbee56
ScriptError("This is not a known MicroBee model value: " . microbeeModel)
Else If (microbeeModel != "mbeeic")
retroMAMEID := microbeeModel
If romExtension in .mwb,.com,.bee
mediaDeviceType := "quik1"
Else If romExtension in .wav,.tap
mediaDeviceType := "cass"
Else If romExtension in .rom
mediaDeviceType := "cart"
Else If romExtension in .dsk
mediaDeviceType := "flop1"
Else ; .bin format
mediaDeviceType := "quik2"
MAMEParam3 := " -" . mediaDeviceType . " \" . """" . romPath . "\" . romName . romExtension . "\" . """"
}
fullRomPath := MAMEParam1 . MAMEParam2 . MAMEParam3
}
} Else If (superGB = "true") {
RLLog.Info("Module - Retroarch Super Game Boy mode enabled")
fullRomPath := " """ . sgbRomPath . """ --subsystem sgb """ . romPath . "\" . romName . romExtension . """"
} Else {
RLLog.Info("Module - Retroarch standard mode enabled")
fullRomPath := " """ . romPath . "\" . romName . romExtension . """"
}
If (retroID = "LibRetro_NFDS") ; Nintendo Famicom Disk System
{ disksysRom := new File(retroSysDir . "\disksys.rom")
If !disksysRom.Exist()
ScriptError("RetroArch requires ""disksys.rom"" for " . retroSystem . " but could not find it in your system_directory: """ . retroSysDir . """")
} Else If (retroID = "LibRetro_SCD") ; Sega CD
{ If !StringUtils.Contains(romExtension, "\.bin|\.cue|\.iso")
ScriptError("RetroArch only supports Sega CD games in bin|cue|iso format. It does not support:`n" . romExtension)
biosCDEBin := new File(retroSysDir . "\bios_CD_E.bin")
biosCDUBin := new File(retroSysDir . "\bios_CD_U.bin")
biosCDJBin := new File(retroSysDir . "\bios_CD_J.bin")
If !biosCDEBin.Exist()
ScriptError("RetroArch requires ""bios_CD_E.bin"" for " . retroSystem . " but could not find it in your system_directory: """ . retroSysDir . """")
If !biosCDUBin.Exist()
ScriptError("RetroArch requires ""bios_CD_U.bin"" for " . retroSystem . " but could not find it in your system_directory: """ . retroSysDir . """")
If !biosCDJBin.Exist()
ScriptError("RetroArch requires ""bios_CD_J.bin"" for " . retroSystem . " but could not find it in your system_directory: """ . retroSysDir . """")
} Else If StringUtils.Contains(retroID,"LibRetro_PCECD|LibRetro_TGCD") ; NEC PC Engine-CD and NEC TurboGrafx-CD
{ If !StringUtils.Contains(romExtension,"\.chd")
ScriptError("RetroArch only supports " . retroSystem . " games in chd format. It does not support:`n" . romExtension)
sysCard3Pce := new File(retroSysDir . "\syscard3.pce")
If !sysCard3Pce.Exist()
ScriptError("RetroArch requires ""syscard3.pce"" for " . retroSystem . " but could not find it in your system_directory: """ . retroSysDir . """")
} Else If (retroID = "LibRetro_PCFX")
{ If !StringUtils.Contains(romExtension,"\.chd")
ScriptError("RetroArch only supports " . retroSystem . " games in chd format. It does not support:`n" . romExtension)
pcfxBios := new File(retroSysDir . "\pcfx.bios")
If !pcfxBios.Exist()
ScriptError("RetroArch requires ""pcfx.bin"" for " . retroSystem . " but could not find it in your system_directory: """ . retroSysDir . """")
} Else If (retroID = "LibRetro_SCUMM")
{
scummFile := new File(romPath . "\" . romName . ".scummvm")
If !scummFile.Exist()
scummFile.Append("""" . romName . """")
}
networkSession := ""
If (enableNetworkPlay = "true") {
RLLog.Info("Module - Network Multi-Player is an available option for " . dbName)
netplayNickname := moduleIni.Read("Network", "NetPlay_Nickname","Player",,1)
getWANIP := moduleIni.Read("Network", "Get_WAN_IP","false",,1)
If (getWANIP = "true")
myPublicIP := GetPublicIP()
RLLog.Warning("Module - CAREFUL WHEN POSTING THIS LOG PUBLICLY AS IT CONTAINS YOUR IP ON THE NEXT LINE")
defaultServerIP := moduleIni.Read("Network", "Default_Server_IP", myPublicIP,,1)
defaultServerPort := moduleIni.Read("Network", "Default_Server_Port",,,1)
lastIP := moduleIni.Read("Network", "Last_IP", defaultServerIP,,1) ; does not need to be on the ISD
lastPort := moduleIni.Read("Network", "Last_Port", defaultServerPort,,1) ; does not need to be on the ISD
mpMenuStatus := MultiPlayerMenu(lastIP,lastPort,networkType,,0)
If (mpMenuStatus = -1) { ; if user exited menu early
RLLog.Warning("Module - Cancelled MultiPlayer Menu. Exiting module.")
ExitModule()
}
If networkSession {
RLLog.Info("Module - Using a Network for " . dbName)
moduleIni.Write(networkPort, "GlobalModuleIni", "Network", "Last_Port")
; msgbox lastIP: %lastIP%`nlastPort: %lastPort%`nnetworkIP: %networkIP%`nnetworkPort: %networkPort%
If (networkType = "client") {
moduleIni.Write(networkIP, "GlobalModuleIni", "Network", "Last_IP") ; Save last used IP and Port for quicker launching next time
netCommand := " -C " . networkIP . " --port " . networkPort . " --nick """ . netplayNickname . """" ; -C = connect as client
} Else { ; server
netCommand := " -H --port " . networkPort . " --nick """ . netplayNickname . """" ; -H = host as server
}
RLLog.Warning("Module - CAREFUL WHEN POSTING THIS LOG PUBLICLY AS IT CONTAINS YOUR IP ON THE NEXT LINE")
RLLog.Info("Module - Starting a network session using the IP """ . networkIP . """ and PORT """ . networkPort . """")
} Else
RLLog.Info("Module - User chose Single Player mode for this session")
}
BezelStart(,,(If rotateBezel ? 1:""))
If foundCfg {
If (stretchToFillBezel = "true" and bezelEnabled = "true" and bezelPath)
{
customViewportWidth := bezelScreenWidth
customViewportHeight := bezelScreenHeight
customViewportX := 0
customViewportY := 0
aspectRatioIndex := 22
RLLog.Info("Stretching viewport to fit bezel")
}
raCfgHasChanges := ""
WriteRetroProperty("input_overlay", overlay)
WriteRetroProperty("video_shader", videoShader)
WriteRetroProperty("aspect_ratio_index", aspectRatioIndex)
WriteRetroProperty("custom_viewport_width", customViewportWidth)
WriteRetroProperty("custom_viewport_height", customViewportHeight)
WriteRetroProperty("custom_viewport_x", customViewportX)
WriteRetroProperty("custom_viewport_y", customViewportY)
WriteRetroProperty("video_rotation", rotation)
WriteRetroProperty("video_crop_overscan", cropOverscan)
WriteRetroProperty("video_threaded", threadedVideo)
WriteRetroProperty("video_vsync", vSync)
WriteRetroProperty("video_scale_integer", integerScale)
WriteRetroProperty("input_disk_eject_toggle", ejectToggleKey)
WriteRetroProperty("input_disk_next", nextDiskKey)
WriteRetroProperty("input_disk_prev", prevDiskKey)
If StringUtils.Contains(retroID, "LibRetro_PSX") {
Loop, 8 ; Loop 8 times for 8 controllers
{ p%A_Index%ControllerType := moduleIni.Read(romName . "|" . systemName, "P" . A_Index . "_Controller_Type", 517,,1)
WriteRetroProperty("input_libretro_device_p" . A_Index, p%A_Index%ControllerType)
}
}
If raCfgHasChanges {
RLLog.Info("Module - Saving changed settings to: """ . retroCFGFile.FileFullPath . """")
SaveProperties(retroCFGFile.FileFullPath, retroCFG)
}
}
fullscreen := If fullscreen = "true" ? " -f" : ""
srmPath := new Folder(emuPath . "\srm\" . retroSystem) ; path for this system's srm files
saveStatePath := new Folder(emuPath . "\save\" . retroSystem) ; path for this system's save state files
retroCFGFileCLI := If foundCfg ? " -c """ . retroCFGFile.FileFullPath . """" : ""
If !srmPath.Exist("folder")
srmPath.CreateDir() ; creating srm dir if it doesn't exist
If !saveStatePath.Exist("folder")
saveStatePath.CreateDir() ; creating save dir if it doesn't exist
HideAppStart(hideEmuObj,hideEmu)
If (StringUtils.Contains(core, "^(mame|mess|ume)") && (retroMAMEID != "mame")) { ; if a MAME/MESS/UME core is used
primaryExe.Run(" """ . (retroMAMEID ? retroMAMEID : "") . fullRomPath . """ " . fullscreen . retroCFGFileCLI . " -L """ . libDll . """ -s """ . srmPath.FilePath . "\" . romName . ".srm"" -S """ . saveStatePath.FilePath . "\" . romName . ".state""" . netCommand, "Hide")
} Else If (retroID = "LibRetro_SCUMM") {
primaryExe.Run(" """ . scummFile . """" . fullscreen . retroCFGFileCLI . " -L """ . libDll . """ -s """ . srmPath.FilePath . "\" . romName . ".srm"" -S """ . saveStatePath.FilePath . "\" . romName . ".state""" . netCommand, "Hide")
} Else If (retroID = "LibRetro_SGB" || If superGB = "true") { ; For some reason, the order of our command line matters in this particular case.
primaryExe.Run(fullscreen . retroCFGFileCLI . " -L """ . libDll . """ -s """ . srmPath.FilePath . "\" . romName . ".srm"" -S """ . saveStatePath.FilePath . "\" . romName . ".state""" . fullRomPath . netCommand, "Hide")
} Else If mgM3UFile.Exist() {
primaryExe.Run(" """ . mgM3UFile.FileFullPath . """" . fullscreen . retroCFGFileCLI . " -L """ . libDll . """ -s """ . srmPath.FilePath . "\" . romName . ".srm"" -S """ . saveStatePath.FilePath . "\" . romName . ".state""" . netCommand, "Hide")
} Else {
primaryExe.Run(" " . fullRomPath . fullscreen . retroCFGFileCLI . " -L """ . libDll . """ -s """ . srmPath.FilePath . "\" . romName . ".srm"" -S """ . saveStatePath.FilePath . "\" . romName . ".state""" . netCommand, "Hide")
}
mpMenuStatus := ""
If networkSession {
canceledServerWait := false
multiplayerMenuExit := false
TimerUtils.SetTimer("NetworkConnectedCheck", 500)
If (networkType = "server") {
RLLog.Info("Module - Waiting for a client to connect to your server")
mpMenuStatus := MultiPlayerMenu(,,,,,,,,"You are the server. Please wait for your client to connect.")
} Else { ; client
RLLog.Info("Module - Trying to contact the server to establish a connection.")
mpMenuStatus := MultiPlayerMenu(,,,,,,,,"Attempting to connect to the server...")
}
If (mpMenuStatus = -1) { ; if user exited menu early before a client connected
RLLog.Warning("Module - Cancelled waiting for the " . If (networkType = "server") ? "client to connect" : "server to respond" . ". Exiting module.")
If primaryExe.Process("Exist")
primaryExe.Process("Close") ; must close process as the exe is waiting for a client to connect and no window was drawn yet
ExitModule()
} Else { ; blank response from MultiPlayerMenu, exited properly
RLLog.Info("Module - " . If (networkType = "server") ? "Client has connected" : "Connected to the server")
emuPrimaryWindow.Wait()
emuPrimaryWindow.WaitActive()
}
TimerUtils.SetTimer("NetworkConnectedCheck", "Off")
} Else { ; single player
emuPrimaryWindow.Wait()
emuPrimaryWindow.WaitActive()
}
If (hideConsole = "true")
emuConsoleWindow.Set("Transparent", "On") ; makes the console window transparent so you don't see it on exit
BezelDraw()
HideAppEnd(hideEmuObj,hideEmu)
FadeInExit()
primaryExe.Process("WaitClose")
7zCleanUp()
BezelExit()
FadeOutExit()
ExitModule()
; Writes new properties into the retroCFG if defined by user
WriteRetroProperty(key,value="") {
If (value != "") {
Global retroCFG,raCfgHasChanges
WriteProperty(retroCFG, key, value,1,1)
raCfgHasChanges := 1
}
}
; Used to convert between RetroArch keys and usable data
ConvertRetroCFGKey(txt,direction="read"){
Global emuPath,RLLog
If (direction = "read")
{ newtxt := StringUtils.TrimLeft(txt,1,0) ; removes the " from the left of the txt
newtxt := StringUtils.TrimRight(newtxt,1,0) ; removes the " from the right of the txt
relativeCheck := StringUtils.SubStr(newtxt,1,1,0)
If StringUtils.Contains(relativeCheck,":",0) { ; if the path contains a ":" then it is a relative path
RLLog.Debug("ConvertRetroCFGKey - " . newtxt . " is a relative path")
newtxt := StringUtils.TrimLeft(newtxt,1,0) ; removes the : from the left of the txt
newtxt := AbsoluteFromRelative(emuPath, "." . newtxt) ; convert relative to absolute
}
If StringUtils.Contains(newtxt,"/",0)
newtxt := StringUtils.Replace(newtxt,"/","\",1,,0) ; replaces all forward slashes with backslashes
} Else If (direction = "write")
{ newtxt := """" . txt . """" ; wraps the txt with ""
If StringUtils.Contains(newtxt,"\\",0)
newtxt := StringUtils.Replace(newtxt,"\","/",1,,0) ; replaces all backslashes with forward slashes
} Else
ScriptError("Not a valid use of ConvertRetroCFGKey. Only ""read"" or ""write"" are supported.")
RLLog.Debug("ConvertRetroCFGKey - Converted " . txt . " to " . newtxt)
Return newtxt
}
MultiGame:
KeyUtils.SetKeyDelay(100)
emuPrimaryWindow.Activate()
KeyUtils.Send("{" . ejectToggleKey . " down}{" . ejectToggleKey . " up}") ; eject disc in Retroarch
If (!mgLastRomIndex) {
mgLastRomIndex := mgRomIndex
}
selectedRomIndex := 0
selectedRomIndex := StringUtils.TrimLeft(selectedRomNum, StringUtils.StringLength(mgType,0))
Loop % mgMaxIndex
{
If (m3uRomIndex[A_index] = mgLastRomIndex) {
tempLastRomIndex := A_index
RLLog.Debug("Module - Last index: " . tempLastRomIndex)
}
If (m3uRomIndex[A_index] = selectedRomIndex) {
tempSelectedRomIndex := A_index
RLLog.Debug("Module - Selected index: " . tempSelectedRomIndex)
}
}
mgNewIndex := tempLastRomIndex - tempSelectedRomIndex
If (mgNewIndex < 0) {
mgNewIndex := mgNewIndex * -1
Loop % mgNewIndex
{
RLLog.Debug("Module - Sending the next disk key: " . nextDiskKey)
KeyUtils.Send("{" . nextDiskKey . " down}{" . nextDiskKey . " up}")
}
} Else If (mgNewIndex > 0) {
Loop % mgNewIndex
{
RLLog.Debug("Module - Sending the previous disk key: " . mgNewIndex)
KeyUtils.Send("{" . prevDiskKey . " down}{" . prevDiskKey . " up}")
}
}
KeyUtils.Send("{" . ejectToggleKey . " down}{" . ejectToggleKey . " up}") ; close disc in Retroarch
mgLastRomIndex := selectedRomIndex
Return
NetworkConnectedCheck:
If clientConnected
multiplayerMenuExit := true
Else If emuPrimaryWindow.Exist() {
RLLog.Info("Module - RetroArch session started, closing the MultiPlayer menu")
multiplayerMenuExit := true
}
Return
CloseProcess:
FadeOutStart()
emuPrimaryWindow.Close()
Return
