~~META:
creator       = Aikar
&description abstract = Lets you run external applications.
~~
~~NOCACHE~~
====== Run (1.2) ======


===== Plugin Information =====

^   Information  ^^
^   Developer:| [[:user/Aikar|Aikar]] |
^   Download:| [[http://windower.net/plugins/Run.dll | Run]]|
^   Download Count:| [dlcount]run[/dlcount] |
^   Support:| [[http://www.windower.net/forums/viewforum.php?f=22 | Click Here]] |
^   Release Date:| January 27th, 2008 |
^   Changelog:| [[:plugins:run:changelog | Click Here]] |

===== What is Run =====

[[Run]] will let you open other applications and files from within FFXI through commands. The idea behind this plugin is to open 3rd party programs all at once, and can be done in your init.txt so you can open all your applications every time FFXI opens.

[[Run]] supports the use of command line arguments to the applications you start and the ability to specify a starting directory, along with the option to start minimized, start hidden, or just plain kill the process instead of opening it (and the ability to kill it before opening it). 


===== Usage =====

[[Run]] can be loaded by opening your Windower console and typing //load run//. [[Run]] is autoload friendly, one can add the //load run// command to their **init.txt** file in the **scripts** folder where Windower resides. See the [[#Commands]] section for further usage details.

===== Commands =====

<code>run command file</code>


====-hide====

This will hide the apps window, if you do not need to see it. You will need to use the -killonly parameter or your task manager to close it if it does not give you a system tray menu.

====-min====
also: -minimize or -minimized

All three do the same thing, makes the application open in a minimized state, however FFXI's focus will still be lost. 

====-kill====

Kills the process before opening it. This is to help insure you do not accidentally open 2 applications if it is still open already. This option checks by full path. So if you have an app named test.exe opened from C:\MySecrets\test.exe, and you issue -kill on D:\windower\apps\test.exe, it will not kill your MySecrets version. It will only kill apps if its the same exact path as the one you are trying to open

====-killonly====

Same as above, except it does not open a new program, only kills it. This is the exact same thing as the windows 'pskill' program and unix's 'kill' command, except it still relies on pathname.

====-dir====

Will override the automatic directory finding code. This sets the working directory for the application launch.

This option should rarely ever need to be used. Example situation would be your exe is in a seperate path than the working directory needs to be in such as spawning a php script through php.exe but keeping working directory to where your php script is located.

Example: <code>.run -dir "D:\\Web\Scripts\" "D:\\Web\PHP\php.exe" -q D:\Web\Scripts\MyFile.php</code>

Without -dir, the plugin would of set working directory to D:\\Web\PHP since thats the application being spawned, with passing the command line arguments "-q D:\Web\Scripts\MyFile.php" to PHP.exe

Unless you are in a situation like this, you should not be using -dir.
====-runonce====
Will not run the application if it is already currently running.
===== Usage Rules =====

  * All parameters to the plugin MUST be before the actual file path to the file to open (-hide -min -kill -killonly -dir).
  * If your File path or -dir setting has spaces in it, you MUST enclose it in quotes " ".
    * Example:
    * INVALID: <code>.run C:\My Apps\My Super Program.exe</code>
    * VALID: <code>.run "C:\My Apps\My Super Program.exe"</code>
    * If you do not use quotes, it will try to open "C:\My".

  * Command line arguments do not have to be in quotes. All arguments past the file path is sent to the program.
    * Ie you can use: <code>.run "C:\Windows\notepad.exe" C:\Windower\scripts\init.txt</code>
    * This opens notepad.exe and passes it the parameter of a filepath to a file to open. General usage of this plugin will not need to pass parameters. It's meant for advanced users.
  * File paths CAN be relative. Relative paths will be based from your WINDOWER directory, NOT PlayOnline.
    * If you execute <code>.run apps/test.exe</code> it will launch D:\Windower\Apps\Test.exe if D:\windower is where your windower is installed.
  * Forward slashes are Ok. They will automatically be converted to backslashes. D://windower/apps/test.exe will work fine.
  * The order of using -hide -dir -kill -killonly and -min do not matter. As long as they are set before the file path. Ie putting -kill at the end of the command such as <code>.run Apps/ChatMon.exe -kill</code> will not work. It will pass -kill to chatmon as a parameter.