TScript:vfs Command

From Derivative
Jump to: navigation, search
vfs [-p path] [-b] [-l pattern] [-L pattern] [-x pattern] [-o] [-f folder] [-r pattern] [-a file]

This command accesses the Virtual File System, the internally embedded files of any component. Components with "embedded files" have a Virtual File System, or VFS.


-p path Specify the component. If none is given it uses the current component.
-l pattern List the files embedded in the component.
-b specifies to match by label, instead of path.
-L pattern List the files embedded in the component and all its children components recursively.
-b specifies to match by label, instead of path.
-r Remove the specified files from the component.
-b specifies to match by label, instead of path.
-a file Add a disk file to the component.
-x pattern Export the embedded files.
-o forces files to be overwritten, else they are renamed.
-f specifies a new folder, else the original path is used.
-b specifies to match by label, instead of path.
The new path to the file is returned.


Add image.jpg to /project1:

vfs -p /project1 -a image.jpg	

List /project1's embedded files:

vfs -p /project1 -l *

List /project1's embedded files and all its children:

vfs -p /project1 -L *		

Export all JPG images in project1 to C:\images:

cc /project1
vfs -x *.jpg -f C:\images

Delete all files whose label matches the pattern.

vfs -r house* -b

Usage in Operator File Parameters[edit]

In File parameters of operators like the Movie File In TOP and Audio File In CHOP, the vfs: syntax in parameters allows for specifying either the internal label, or the internal full path. The two formats are:




If the virtual file is in the same component as the operator with the File parameter:


Lets you embed files inside a .tox or .toe file. Operators like the Movie File In TOP that read regular files can also read the embedded VFS files using a vfs: syntax.

Exporting is the connection of CHOP channels to parameters of operators. The output of each exporting CHOP is one or more channels, active only while the CHOP Viewer is on. The current value of a channel can be exported to a parameter of any operator, overriding that parameter's value. See Parameter.

An Operator Family that creates, composites and modifies images, and reads/writes images and movies to/from files and the network. TOPs run on the graphics card's GPU.

An Operator Family which operate on Channels (a series of numbers) which are used for animation, audio, mathematics, simulation, logic, UI construction, and many other applications.