Project File

What is a Project File

A Project File, named PSCAT.Proj, is a text file that contains attributes to enhance the experience of using the PowerShell Compact-Archive Tool. While optional, this feature offers several functionalities, such as specifying an output filename for compiled builds, setting a project name, and defining a project webpage. To use a Project File, only one variable is required: Project_Name_String. All other variables are optional. If the Project_Name_String is not found within the PSCAT.Proj file, it will be ignored, causing PSCAT to completely bypass the Project File.

If you prefer not to use a Project File, the PowerShell Compact-Archive Tool can automatically guess the project name by using the root directory's name instead.

Benefits

When the PSCAT.Proj file is detected and readable, the following options are available:

1. Specify the project name displayed within the PSCAT program.
2. Specify a custom output filename for compiled builds (useful if the output filename differs from the project name).
3. Access the project’s webpage directly from the Main Menu.

Without using a PSCAT.Proj file:

1. The project name will default to the parent directory’s name.
2. The output filename will default to the parent directory’s name.

Where to Place Project File

When saving the PSCAT.Proj text file, save it in the parent directory containing the project's source files. Upon loading a project, PSCAT will automatically read the file and gather any available information.

Project File Template

You can use the provided 'PSCAT.Proj' template file and customize it to suit your project's needs.

The variables available are the following:

1. LINE53 : Project_Name_String
2. LINE75 : Project_Website_String
3. LINE89 : Project_BuildName_String

Project File Variables

Variable	Required	Description
Project_Name_String	Yes	The name of the project that will be shown within PSCAT.
Project_Website_String	No	When populated, the webpage link will be available in the Main Menu.
Project_BuildName_String	No	When populated, the Output Filename will match this string. If not provided, then Project_Name_String will be used instead.