About This File
This plugin adds a command line interface to LaunchBox/BigBox for launching games via Stream Deck or having platform and playlist shortcuts. Marquee(s)* and LEDBlinky get updated automatically. Launching games on a remote PC is also supported.
*All Marquees will be updated when using either LaunchBox or BigBox if you are using the ThirdScreen Plugin. If you're using the default BigBox marquee handling, then your single marquee will be updated when using BigBox only.
Installation:
- *** Before installing, if you are using the ThirdScreen plugin please make sure you are using the latest version. Version 3.0.1 or higher is compatible. ***
- Download CLI_Launcher.zip to your PC. Right click on the zip file and extract all files.
- Close LaunchBox/BigBox and copy the Plugins and ThirdParty folders to your LaunchBox directory.
Usage (simple game shortcuts):
- Right click on a game in LaunchBox and choose "CLI Launcher->Create Windows Shortcut".
- A dialogue will open to allow you to choose the name and location of the game shortcut. When ready, click "Save" to create the shortcut.
- To create windows shortcuts for a batch of games at once: Select multiple games, right-click and choose "CLI Launcher->Create Windows Shortcuts".
Usage (advanced shortcuts and Stream Deck):
Game Shortcuts (launch command): (works with both LaunchBox and BigBox)
Create an AHK script with the following line, and point your StreamDeck shortcut to that script:
Run, "<path_to_launchbox>\ThirdParty\CLI_Launcher\CLI_Launcher.exe" launch "<platform_name>" "<game_name>"
For example, to launch Street Fighter Alpha 2 from the Arcade platform:
Run, "C:\Users\Administrator\LaunchBox\ThirdParty\CLI_Launcher\CLI_Launcher.exe" launch "arcade" "Street Fighter Alpha 2"
New in v7.0.0 (launch_by_id command): To launch a game using its game id instead of platform name/game title you can use the launch_by_id command. For example:
Run, "C:\Users\Administrator\LaunchBox\ThirdParty\CLI_Launcher\CLI_Launcher.exe" launch_by_id "1e48ac15-55e2-47f7-a33e-486451a16def"
New in v7.0.3 (launch_by_db_id command): To launch a game using its database id instead of platform name/game title you can use the launch_by_db_id command. For example:
Run, "C:\Users\Administrator\LaunchBox\ThirdParty\CLI_Launcher\CLI_Launcher.exe" launch_by_db_id "2532"
Platform Shortcuts (platform command): (added in v2.0.0 - only works with BigBox)
Create an AHK script with the following line, and point your StreamDeck shortcut to that script:
Run, "<path_to_launchbox>\ThirdParty\CLI_Launcher\CLI_Launcher.exe" platform "<platform_name>"
For example, to navigate to the Arcade platform in BigBox:
Run, "C:\Users\Administrator\LaunchBox\ThirdParty\CLI_Launcher\CLI_Launcher.exe" platform "arcade"
Playlist Shortcuts (playlist command): (added in v2.0.0 - only works with BigBox)
Create an AHK script with the following line, and point your StreamDeck shortcut to that script:
Run, "<path_to_launchbox>\ThirdParty\CLI_Launcher\CLI_Launcher.exe" playlist "<playlist_name>"
For example, to navigate to the favorites playlist in BigBox:
Run, "C:\Users\Administrator\LaunchBox\ThirdParty\CLI_Launcher\CLI_Launcher.exe" playlist "favorites"
Remote commands:
To run a command on a different PC that has the plugin installed and is running LaunchBox or BigBox just add "remote_ip=<ip_of_remote_pc>". For example, to launch a game on a different PC with IP 192.168.168.238:
Run, "CLI_Launcher.exe" launch "arcade" "Street Fighter Alpha 2" "remote_ip=192.168.168.238"
FAQs:
Q. What if neither LaunchBox nor BigBox are open when the script runs?
A. The command will just get ignored if LaunchBox or BigBox is not open.
Q. What if a game is already open when the script runs?
A. The command will just get ignored if a game is already open.
Q. Why not just launch the emulator and/or game directly from the script?
A. Using CLI Launcher is much simpler and leverages all the work you've already done in setting up LaunchBox to properly launch the game. Also, if you were to run the emulator and/or game directly from the script, your Marquee(s) and LEDBlinky would not get updated for the game.
Q. If I want to use remote commands, which port do I need to ensure is open?
A. If you are having trouble with remote commands, ensure port 0xb0b0 is open in Windows Firewall on the remote PC.
Q. Why would anyone want to launch a game on a remote PC?
A. Dunno... but you can now.
Q. Are AutoHotKey scripts really necessary?
A. No, that's just the way I do it. You could also just point the Stream Deck shortcut directly to CLI_Launcher.exe and pass in the correct arguments.
Edited by superrob3000
Updated instructions
What's New in Version 3.0.0 See changelog
Released
Fixed an issue where platform and playlist shortcut commands were not being ignored when a game is open.