Difference between revisions of "Broadcast System"
Jump to navigation
Jump to search
RocketLauncher support third party communication through a built in message broadcast system. You can for example build an third party app to pause a game or control any RocketLauncher command from a smartphone. You also can receive RocketLauncher messages that describes its state, if it started, paused, exit,...
| Line 26: | Line 26: | ||
*<span style="color: orange;">'''RocketLauncher Message: Resuming Game.'''</span> (sent when you resume a game) | *<span style="color: orange;">'''RocketLauncher Message: Resuming Game.'''</span> (sent when you resume a game) | ||
*<span style="color: orange;">'''RocketLauncher Message System is Available.'''</span> (sent as a answer to a ping request) | *<span style="color: orange;">'''RocketLauncher Message System is Available.'''</span> (sent as a answer to a ping request) | ||
| + | *<span style="color: orange;">'''RocketLauncher Message. Current System: SystemName'''</span> (sent as a answer to a Which system? request) | ||
| + | *<span style="color: orange;">'''RocketLauncher Message. Current Game: GameName'''</span> (sent as a answer to a Which game? request) | ||
==Valid messages received by RocketLauncher== | ==Valid messages received by RocketLauncher== | ||
| − | |||
*<span style="color: orange;">'''command|RLPause'''</span> (simulate pause key press) | *<span style="color: orange;">'''command|RLPause'''</span> (simulate pause key press) | ||
*<span style="color: orange;">'''command|RLSelect'''</span> (simulate select key press) (currently only available on pause) | *<span style="color: orange;">'''command|RLSelect'''</span> (simulate select key press) (currently only available on pause) | ||
| Line 36: | Line 37: | ||
*<span style="color: orange;">'''command|RLDown'''</span> (simulate select Down key press) (currently only available on pause) | *<span style="color: orange;">'''command|RLDown'''</span> (simulate select Down key press) (currently only available on pause) | ||
*<span style="color: orange;">'''command|RLExit'''</span> (simulate select Exit RocketLauncher key press) | *<span style="color: orange;">'''command|RLExit'''</span> (simulate select Exit RocketLauncher key press) | ||
| + | *<span style="color: orange;">'''ping'''</span> (message to test the reachability of RocketLauncher. Once received, RocketLauncher will send back the message "RocketLauncher Message System is Available." to all windows configured to receive broadcasted messages on RocketLauncherUI) | ||
| + | *<span style="color: orange;">'''Which system?'''</span> (message to ask RocketLauncher to send which is the current system. Once received, RocketLauncher will send back the message "RocketLauncher Message. Current System: SystemName", where SystemName is the name of the current system, to all windows configured to receive broadcasted messages on RocketLauncherUI) | ||
| + | *<span style="color: orange;">'''Which game?'''</span> (message to ask RocketLauncher to send which is the current game. Once received, RocketLauncher will send back the message "RocketLauncher Message. Current System: gameName", where GameName is the name of the current game, to all windows configured to receive broadcasted messages on RocketLauncherUI) | ||
=Code example= | =Code example= | ||
Revision as of 11:15, 7 July 2015
Contents
Instructions
Setting your program to receive RocketLauncher messages
- You just need to set on RocketLauncher the window name of your program so RocketLauncher is able to send its messages to your app.
- Open RocketLauncherUI
- On the left pane choose global
- Select the General Settings tab
- On the RocketLauncher sub tab, go to the Broadcast section
- Fill the broadcast window title field with the window title name of your program.
Sending messages to RocketLauncher from your external program
- You just need to send one of the bellow listed valid messages to the window named: RocketLauncherMessageReceiver
Valid Messages
Messages sent by RocketLauncher
- RocketLauncher Message: Welcome! :) (sent when RocketLauncher starts)
- RocketLauncher Message: Goodbye! :( (sent when you exit RocketLauncher)
- RocketLauncher Message: Game Paused. (sent when you pause a game)
- RocketLauncher Message: Resuming Game. (sent when you resume a game)
- RocketLauncher Message System is Available. (sent as a answer to a ping request)
- RocketLauncher Message. Current System: SystemName (sent as a answer to a Which system? request)
- RocketLauncher Message. Current Game: GameName (sent as a answer to a Which game? request)
Valid messages received by RocketLauncher
- command|RLPause (simulate pause key press)
- command|RLSelect (simulate select key press) (currently only available on pause)
- command|RLUp (simulate select Up key press) (currently only available on pause)
- command|RLLeft (simulate select Left key press) (currently only available on pause)
- command|RLRight (simulate select Right key press) (currently only available on pause)
- command|RLDown (simulate select Down key press) (currently only available on pause)
- command|RLExit (simulate select Exit RocketLauncher key press)
- ping (message to test the reachability of RocketLauncher. Once received, RocketLauncher will send back the message "RocketLauncher Message System is Available." to all windows configured to receive broadcasted messages on RocketLauncherUI)
- Which system? (message to ask RocketLauncher to send which is the current system. Once received, RocketLauncher will send back the message "RocketLauncher Message. Current System: SystemName", where SystemName is the name of the current system, to all windows configured to receive broadcasted messages on RocketLauncherUI)
- Which game? (message to ask RocketLauncher to send which is the current game. Once received, RocketLauncher will send back the message "RocketLauncher Message. Current System: gameName", where GameName is the name of the current game, to all windows configured to receive broadcasted messages on RocketLauncherUI)
Code example
- On the bellow link you can find a small AHK code able to handling the RocketLauncher communication and control commands to serve as example if you want to use this feature by your own.
- You just need to set, as explained in the beginning of this page, the Broadcast Window title on RocketLauncherUI to: RocketLauncherController.
