Difference between revisions of "Broadcast System"

From RocketLauncher Wiki
Jump to navigation Jump to search
Line 29: Line 29:
 
==Valid messages received by RocketLauncher==
 
==Valid messages received by RocketLauncher==
 
*<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;">'''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;">'''command|Pause'''</span> (simulate pause key press)
+
*<span style="color: orange;">'''command|RLPause'''</span> (simulate pause key press)
*<span style="color: orange;">'''command|Select'''</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)
*<span style="color: orange;">'''command|Up'''</span> (simulate select Up key press) (currently only available on pause)
+
*<span style="color: orange;">'''command|RLUp'''</span> (simulate select Up key press) (currently only available on pause)
*<span style="color: orange;">'''command|Left'''</span> (simulate select Left key press) (currently only available on pause)
+
*<span style="color: orange;">'''command|RLLeft'''</span> (simulate select Left key press) (currently only available on pause)
*<span style="color: orange;">'''command|Right'''</span> (simulate select Right key press) (currently only available on pause)
+
*<span style="color: orange;">'''command|RLRight'''</span> (simulate select Right key press) (currently only available on pause)
*<span style="color: orange;">'''command|Down'''</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|Exit'''</span> (simulate select Exit RocketLauncher key press)  
+
*<span style="color: orange;">'''command|RLExit'''</span> (simulate select Exit RocketLauncher key press)  
  
 
=Code example=
 
=Code example=

Revision as of 10:22, 7 July 2015

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,...



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)

Valid messages received by RocketLauncher

  • 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)
  • 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)

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.

Broadcast App Code Example