Difference between revisions of "LavishScript:Scripts"

From Lavish Software Wiki
Jump to navigation Jump to search
Line 1: Line 1:
== Introduction ==
+
== Overview ==
 +
Scripts are decision-making programs.  They can perform a task and stop immediately, or they can continue performing their task indefinitely.
  
== Usage ==
+
== Installing existing scripts ==
 +
=== Downloaded Scripts ===
 +
Downloaded scripts should simply be placed in the application's "Scripts" folder. 
 +
 
 +
=== Copy/Paste ===
 +
Scripts copied from message boards or other sources can be pasted into any text editor (example: Notepad), and saved in the application's "Scripts" folder.  Make sure to use the correct file extension as defined by the application (For example, Inner Space uses .iss, and Fury uses .fsc).  If using Notepad, you will need to pull down the box that says "Save as type" and change it to "All Files" -- this makes sure the file saves with the correct extension, instead of adding .txt to the end (which Windows may hide from you, depending on your settings!).
 +
 
 +
=== Configuring ===
 +
Information on configuring and using the script should be found along with the script download.  Well-designed scripts will generally opt to have one or more ".conf" files, and/or one or more ".xml" files for configuration, both of which can be edited with any text editor.
 +
 
 +
== Starting a Script ==
 +
Scripts are started using the [[Command:RunScript|RunScript command]] as follows
 +
* RunScript MyScript
 +
 
 +
== Stopping a Script ==
 +
Scripts are stopped using the [[Command:EndScript|EndScript command]] as follows
 +
* EndScript MyScript
  
 
== Development ==
 
== Development ==
 +
(see [[Script Development]])
  
== Examples ==
+
== See Also ==
 +
* [[LavishScript:Command Files|Command Files]]
 +
* [[LavishScript]]

Revision as of 03:26, 11 May 2005

Overview

Scripts are decision-making programs. They can perform a task and stop immediately, or they can continue performing their task indefinitely.

Installing existing scripts

Downloaded Scripts

Downloaded scripts should simply be placed in the application's "Scripts" folder.

Copy/Paste

Scripts copied from message boards or other sources can be pasted into any text editor (example: Notepad), and saved in the application's "Scripts" folder. Make sure to use the correct file extension as defined by the application (For example, Inner Space uses .iss, and Fury uses .fsc). If using Notepad, you will need to pull down the box that says "Save as type" and change it to "All Files" -- this makes sure the file saves with the correct extension, instead of adding .txt to the end (which Windows may hide from you, depending on your settings!).

Configuring

Information on configuring and using the script should be found along with the script download. Well-designed scripts will generally opt to have one or more ".conf" files, and/or one or more ".xml" files for configuration, both of which can be edited with any text editor.

Starting a Script

Scripts are started using the RunScript command as follows

  • RunScript MyScript

Stopping a Script

Scripts are stopped using the EndScript command as follows

  • EndScript MyScript

Development

(see Script Development)

See Also