Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
ardiscript:running_and_debugging_local_scripts [2018/07/25 22:22]
optrix created
ardiscript:running_and_debugging_local_scripts [2018/07/25 22:46] (current)
optrix
Line 9: Line 9:
 It's located in your Documents folder. You should find a folder named **Optrix/​ARDI/​**<​database-name>​**Scripts** (for example, if your database is called “Headquarters”,​ it would be under **Optrix/​ARDI/​Headquarters/​Scripts**) It's located in your Documents folder. You should find a folder named **Optrix/​ARDI/​**<​database-name>​**Scripts** (for example, if your database is called “Headquarters”,​ it would be under **Optrix/​ARDI/​Headquarters/​Scripts**)
  
-Create your script ​XML file in this folder.+Create your script file in this folder. You can use the extension '​xml'​ or '​script'​ (calling your file '​script'​ will save you an extra step later, when you publish).
  
-This is also the folder ​where you should place any media files your script ​needs. For exampleyou might want to include ​voiceover filePlace it in the folder with your script.+We also suggest creating a folder ​with the same name as your script ​(without the file extension), to hold your media. 
 + 
 +So if you were making ​script called **Introduction** on a server called **Headquarters**,​ you'd create... 
 + 
 +**Optrix/​ARDI/​Headquarters/​Scripts/​Introduction.xml** (your script ​file) 
 + 
 +**Optrix/​ARDI/​Headquarters/​Scripts/​Introduction** (your media folder)
  
 See [[supported script media formats]] to know what type of files to use. See [[supported script media formats]] to know what type of files to use.
Line 27: Line 33:
  
 Please contact Optrix if you would like a copy of the application. ​ Please contact Optrix if you would like a copy of the application. ​
 +
 +===Referencing Media===
 +
 +If you want to use a media file in your script, remember to //include the script name in the path// so that the system can find your media files.
 +
 +So if you wanted to include a voiceover file - //​hello.ogg//​ - in your script, you'd place the file in **Optrix/​ARDI/​Headquarters/​Scripts/​Introduction/​hello.ogg** and you'd call it in your script with...
 +
 +<​code>​
 +<​voiceover name="​Introduction/​hello.ogg"/>​
 +</​code>​
  
 ===Deploying=== ===Deploying===
Line 32: Line 48:
 Once you've polished your script and have it ready for your audience, you can deploy it to your server. Once you've polished your script and have it ready for your audience, you can deploy it to your server.
  
 +See the [[ardiscript:​deploying_scripts_to_your_server]] article.