Difference between revisions of "RocketLauncher Command Line Parameters"

From RocketLauncher Wiki
Jump to: navigation, search
(Current)
m (grammar update)
 
Line 62: Line 62:
 
====-o====
 
====-o====
 
:Forces mouse to be restored on exit even if Hide_Cursor is set to an option that keeps it hidden.
 
:Forces mouse to be restored on exit even if Hide_Cursor is set to an option that keeps it hidden.
:This is useful If you use multiple front ends with RocketLauncher, and some you may want mouse hidden, while others you may need the mouse visible.
+
:This is useful If you use multiple front ends with RocketLauncher, and some of you may want the mouse hidden, while others may need the mouse visible.
:Example: ''-0 1''<br>
+
:Example: ''-o 1''<br>
  
 
==Verifying CLI Was Sent Correctly==
 
==Verifying CLI Was Sent Correctly==
 
You can validate your Front End is sending the correct parameters by opening the RocketLauncher.log in RocketLauncherUI and looking for this line (quotes are automatically removed):
 
You can validate your Front End is sending the correct parameters by opening the RocketLauncher.log in RocketLauncherUI and looking for this line (quotes are automatically removed):
 
  Main - Raw CLI received: "-s Nintendo Entertainment System -r Adventure Island (USA) -f D:\Hyperspin\HyperSpin.exe -p HyperSpin"
 
  Main - Raw CLI received: "-s Nintendo Entertainment System -r Adventure Island (USA) -f D:\Hyperspin\HyperSpin.exe -p HyperSpin"

Latest revision as of 21:23, 6 September 2019

RocketLauncher v1.0 supports these command line parameters which allows you to pass much more info to it for greater control over what HyperLaunch can do.

Legacy

The legacy CLI still works, but is only suggested for Hyperspin users who place their Hyperspin folder in C:\Hyperspin or similar, like D:\Hyperspin.

The legacy CLI works like this
RocketLauncher.exe "<SYSTEM_NAME>" "<ROM_NAME>"
Example: RocketLauncher.exe "Nintendo Entertainment System" "Adventure Island (USA)"
This legacy method will only work if Hyperspin is installed in one of these 2 folders, relative to where RocketLauncher is installed
  • ..\HyperSpin.exe (1 folder up, like this C:\Hyperspin\RocketLauncher)
  • ..\HyperSpin\HyperSpin.exe (1 folder up, then HyperSpin in its own folder, like C:\HyperSpin and C:\RocketLauncher)
All other structures of paths are not supported and will not work w/o having Hyperspin send the -f CLI argument
  • Note that when spaces are used, the parameter must be wrapped in quotes.

Current

For all other Front Ends or scenarios, the new CLI parameters are as follows:

  • Note that when spaces are used, the parameter must be wrapped in quotes.

-s "<SYSTEM_NAME>"

This refers to the system you are launching.
Example: -s "Nintendo Entertainment System"

-r "<ROM_NAME>"

This refers to the game or application you are launching. Also known as DB_NAME, as in name from your Front End's database.
If a full path to the rom was supplied by your Front End instead of just the name:
  • Some checks will be skipped, slightly speeding up launch time
  • 7z support will be turned off automatically
Example: -r "Adventure Island (USA)"

-m <HL_MODE>

This tells RocketLauncher you want to launch one of its features directly and not the game itself. You do not need to wrap this in quotes.
Supported Modes:
  • pause = Boot directly into HyperPause
  • mg = Boot directly into MultiGame
  • fade = Boot directly into Fade (Non-7z)
  • fade7z = Boot directly into Fade (7z)
Example: -s "Nintendo Entertainment System" -r "Adventure Island (USA)" -m hp

-f "<FRONT_END_PATH>"

This tells RocketLauncher what Front End called it. This is critical for RocketLauncher to know what to restore on exit. The full path and executable must be supplied. Setting this will overwrite the General Settings -> RocketLauncher -> Default Frontend Path setting in RocketLauncherUI. If you use multiple frontends with RocketLauncher, make sure each of them send this parameter. If you only use one, you can just use the default frontend setting and don't need to send -f.
Example: -f "C:\RetroFE\RetroFE.exe"

-p "<PLUGIN_NAME>"

This tells RocketLauncher what Plugin to use for the Front End that called it. Without a proper plugin, RocketLauncher cannot read the Front End's database or know where to find Front End Media.
Value refers to the file name found in RocketLauncher\Plugins. If your plugin is named RetroFE.plugin, then use RetroFE.
Example: -p "RetroFE"

-e "<FORCE_EMU_NAME>"

Allows you to force the use of the specified emulator above anything you may have set in RocketLauncherUI.
You must also force a module with the -d parameter.
You must also force a full path to the rom you want to launch with the -r parameter.
Emulator name can be a defined emulator in RocketLauncherUI, or one not defined but a full path to the exe must be supplied as well.
Example: -e "C:\Emulators\Nestopia\Nestopia.exe"

-d "<FORCE_MODULE_NAME>"

Allows you to force the use of the specified module above anything you may have set in RocketLauncherUI.
You must also force an emulator with the -e parameter.
Module name can be a defined module in RocketLauncherUI, or one not defined but a full path to the module must be supplied as well.
If you do not supply an extension, ".ahk" will be added on for you automatically.
Example: -d "D:\RocketLauncher\Modules\Nestopia\Nestopia.ahk"

-o

Forces mouse to be restored on exit even if Hide_Cursor is set to an option that keeps it hidden.
This is useful If you use multiple front ends with RocketLauncher, and some of you may want the mouse hidden, while others may need the mouse visible.
Example: -o 1

Verifying CLI Was Sent Correctly

You can validate your Front End is sending the correct parameters by opening the RocketLauncher.log in RocketLauncherUI and looking for this line (quotes are automatically removed):

Main - Raw CLI received: "-s Nintendo Entertainment System -r Adventure Island (USA) -f D:\Hyperspin\HyperSpin.exe -p HyperSpin"