|
| # _______MMS SCRIPT TEMPLATE_______ # # # #==================================================================== # Font Usage in this File: # # instructions written in Ariel # script commands in Courier New to be written verbatim # replace italicized text with your own #==================================================================== # Comments # # The '#' symbol denotes comments that you can put in your script to # organize it and make it more readable. They do not effect the way # your script will run. Statements preceded by the '#' symbol will # be printed out to the command prompt. # Setting Roots # # Rather than having to type in the entire address of each file, you # can set macros to represent common file addresses. Wherever the # macro name appears, it will be replaced with the directory with which it # is associated. This saves time, especially if you ever change the # folder that your images are in. Call macros by surrounding them with # '%' (e.g., %ImageRoot%).USAGE: setenv macroName \\server\directory EXAMPLE: setenv ImageRoot \\dwarfs-2\displaywall\displaywall\images setenv SoundRoot \\dwarfs-2\displaywall\displaywall\sounds # Preload # # If timing is important in your script, then the first thing you should # do is to preload all the images you wish to use. Preload moves the # images from its home directory to a buffer for much quicker loading. # The preloading syntax is similar to the syntax used to set roots. You # give the image a new name that will be used to call it later on. You do # not, however, have to use '%' around the name. There # are also variables to set the x- and y- position of the top, left # corner of your image. Set to '0 0' if no repositioning is needed. # It is unnecessary to preload sound files. We will use the macros we # created above: USAGE: preload imageName %macroName%\fileName.jpg x-axis y-axis EXAMPLE: preload firstimage %ImageRoot%\jerry01.jpg 0 0 # TIP: When preloading a long series of images, it helps to intersperse # comments between the files to keep track of progress. # Showing an Image # # Use the following command: USAGE: show imageName EXAMPLE: show firstimage # Dissolves # # To dissolve from the first image to the second image: USAGE: fade firstImage secondImage 1st% 2nd% time(ms) EXAMPLE: show mountain fade mountain ocean 100 0 1000 fade ocean black 100 0 2000 # Timing # # Timing allows you to determine exactly when a command is executed. There are # a few ways to do this: SLEEP/SLEEPM or ATTIME. # # sleep/sleepm: either command specifies how long you want the program to "sleep" # before executing the next command. USAGE: sleep time(ms) sleepm time(ms) EXAMPLE: sleep 1000 sleepm 1000 # attime: To use this command, you must first start a timer. Once the timer is # initialized, you can specify at what time (in milliseconds) you want a # the next command to execute. USAGE: reset-timer attime time(ms) command to be executed EXAMPLE: reset-timer attime 0000 show black attime 5000 fade black mountain 100 0 500 # Playing Sound # # Begin by creating a valid sound file. In addition to the file name, the command # takes in three required arguments. The first is the volume setting. Enter a # number between 0.0 (silence) and 1.0 (max volume). The second argument is the # length of the piece in seconds. If your sound is longer than you want it to play, # you can set the command to play only a certain number of seconds of the sound # before stopping. You MUST enter a number here, or the sound will not play. # The final argument is the name of the sound server, which will always be: # sound.cs.princeton.edu in the Display Wall room. USAGE: shell start playsound %macroName%\soundFile.wav volume duration(sec) server EXAMPLE: shell start playsound %SoundRoot%\wind.wav 0.25 180 sound.cs.princeton.edu # Saving Your File # # Save your file as a *.mms file. # Running Your Script # # From the onscreen GUI [Graphical User Interface] application window, choose MMS in the Tasks menu, find the .mms file to run and open the file Or from the ' \bin ' directory of either shrimpNT or dwarfs-2: USAGE: mmshell -s //server/directory/fileName.mms EXAMPLE: mmshell -s //dwarfs-2/displaywall/displaywall/bin/myScript.mms mmshell -s myScript.mms # TIP: The default root is \bin. # Sample Script # # Click to see a sample script. |
|
last edited 04/28/2008 |