It is important to maintain some structure in the use of directories when you install HomeSeer. Users want to know consistently where to go to find files. Here are the directory naming and usage standards to follow when creating your install.txt file. All paths in the following table are relative to the root HomeSeer directory.
(appname) refers to a form of your application's title suitable for use as a directory name. For example, a plug-in titled "Lutron HomeWorks" might use "HomeWorks" for (appname).
|
Type |
Directory |
Notes |
|
Documentation |
\Docs |
Not help files, but readme files and other documents. |
|
Configuration Settings |
\Config or \Config\(appname) if there are a lot of files for this location. |
Do not use HomeSeer's SETTINGS.INI file. |
|
Windows Electronic Help Files |
\Help |
e.g. CHM files. Should not be used with HomeSeer 2.x any longer. |
|
HTML Help Files |
\HTML\Help\(appname) |
HTML generators such as Robohelp produce Webhelp packages with many files -- do not clutter up the shared help directory -- create your own for your application. |
|
HTML |
\HTML or \HTML\(appname) |
|
|
HTML Includes |
\HTML\Includes\(appname) |
|
|
HTML Images |
\HTML\Images\(appname) |
|
|
Scripts |
\Scripts |
|
|
Script Includes or other script files. |
\Scripts\(appname) or \Scripts\Includes\(appname) |
|
|
Data Files and/or Database Files |
\DATA\(appname) |
The users just LOVE it when they can backup their data easily and know which directory to back up! |
|
Binaries (executables) |
\BIN\(appname) |
|
|
Temporary Files during install OR used by your application |
\Temp or \Temp\(appname)
|
Remember to clean up any mess (files) when you are done. |
Note: There should not be any files in the HomeSeer root directory other than your main plug-in executable. If you feel your application needs an exemption from this standard, please let us know and we will be happy to explain why you are wrong. ;-)