VFX Main Page
 
VFX Themes
 
VFX PIL Scripts
 
Development
 
Join the Team
 
 
 
 
 
 
 
 

VFX Development

This section outlines the current requirements of the VFX library and usage within VFX-enabled PIL scripts.


The Team

Jellowe
OzMan
Pachunka

Sections

The VFX Library
VFX Library Distribution


The VFX Library

The VFX library is a PIL script named " [VFX] " containing the theme patterns declared as constants.


Here is a sample library: 



const
	vfx1 = ' 12. · ° .12';
	vfx2 = ' 12· ° . ·12';
	vfxheader = ' 12· ° . '; {Truncated}
	vfxerr1 = ' 4. · ° .4';
	vfxerr2 = ' 4· ° . ·4';
	vfxerrheader = ' 4.  '; {Truncated}

	vfxver = '0.1';


At this time, only six variables are implemented. They are:
  • vfxheader - A "header" for script output
  • vfx1 - Primary theme "tag", used in the same manner as Pirch's "/display" tags
  • vfx2 - A secondary theme "tag"
  • vfxerrheader - An "error" type header for script error output
  • vfxerr1 - Primary error "tag"
  • vfxerr2 - Secondary error "tag"
The " vfxver " variable should reflect the version of VFX, not the version of the individual script or library.

The library file should be added to aliases and "included" into VFX-enabled PIL scripts via Pirch's $i directive ( {$i [vfx]} ). The VFX variables can then be used by the PIL script.

Back to Top


 

VFX Library Distribution

The VFX Library should be distributed as a zip file or self-extractor. This is a guideline, not a rule, but WinZip is one of the most commonly used compression utilities, and to ensure compatibility with the current Theme Changer, it is best advised to use it.

The "theme" package should unzip into its own folder within the "VFX" folder within the users' main Pirch folder (i.e. "c:\pirch98\vfx\MyTheme\").

A "readme.txt" file is not required but is generally a good idea, as it can be used to provide the user with version information, contact information, and release notes.

Back to Top