System Console - openantz/antz GitHub Wiki
ANTz accepts command line arguments to set attributes and load files on startup.
C:\data\code\antz-xr_2020-07-28>antz ? ANTz v0.221.1
| ANTz Console Help... DON'T PANIC! |
|---|
| ? or 'help' or '/?' to show (this) help menu |
| -f file(path) to load ex: -f antz0001.csv |
| -u URL Browser record_id path ex: "http://.../query.php" |
| -p UDP ports Tx followed by Rx ex: -p 9000 8000 |
| -o OSC IP & ports: -o 192.168.0.11 9000 192.168.0.11 8000 |
| -n any mapItem as CSV: 'imagesPath,item,element,type,value' |
| -v display app version |
| ------------------------------------------------------------ |
| multiple flags ex: antz -f antz0001.csv -o 0 9000 0 8000 |
| '-f' to load file antz0001.csv |
| '-o' with IP = 0 will autoset IP by listening to Rx port |
| '-f' File name to load, can include file path. |
| ex: antz -f antz0001.csv |
| On startup will load file antz0001.csv |
| Can also specify multiple file types and relative paths. |
| *future support for directory trees and . wildcards. |
| ex: antz -f map00001.jpg -f "../usr/csv/." |
| ------------------------------------------------------------ |
| '-u' URL used for Browser Query to view by record_id |
| ex: antz -u "http://openantz.com/docs/id.html?id=" |
| URL points to a web service page generated per record_id |
| Launches default browser with record_id of active node. |
| '-p' Ports to use for networking such as OSC over UDP |
| ex: antz -p 9000 8000 |
| Setup a bi-directional OSC connection with Tx port = 9000 |
| Autodetects Tx and Rx IP by listeing on Rx port = 8000 |
| *future support planned for additional protocols. |
| ------------------------------------------------------------ |
| '-o' OSC connection TxRx with both IP's and ports. |
| uses 4 parameters: TxIP TxPort RxIP RxPort |
| ex: antz -o 192.168.0.11 9000 192.168.0.11 8000 |
| Can manually specify both pairs of TxRx IP and ports, or |
| set IP = 0 to autodetect IP(s) by listening on Rx port. |
| ex: antz -o 0 9000 0 8000 |
| '-n' Any mapItem & value, formatted as CSV row in quotes. |
| uses 5 parameters: imagesPath item element type value |
| ex: antz -n np_gl 1 fullscreen i 0 |
| Causes app to startup in a window, fullscreen = 0 for OFF |
| Note that certain parameters need double quotes! |
| ex: antz -n np_gl 1 clear_rgba ffff "0,0.4,0,1.0" |
| Sets the background clear buffer color to a forest green. |
| also see: |
| antzglobals.csv for mapping global startup values. |
| antzosc.csv for mapping data and commands to OSC Schema. |
END HELP