Skip to content
This repository was archived by the owner on Feb 1, 2025. It is now read-only.

Compiling Project

Nicholas Gautier edited this page Jan 19, 2025 · 20 revisions

PSCAT Compile Screen - Click to Enlarge

Compiling Projects

When a project had been loaded, from the Main Menu, the option to compile that project will become available. With the project loaded, you are essentially instructing PSCAT the exact location as to what files are to be compacted into a PK3 archive data file. Please be sure that the file structure matches exactly with what ZDoom is expecting, otherwise the game engine will not be able to decipher the project’s assets correctly.

Main Menu Screen - Focusing on the Compiling Option

Compiling Process

The PowerShell Compact-Archive Tool will perform the following procedure when compiling a project:

  1. Assure that all resources are available, such as the output directory had been created.
  2. Copy the project’s source files into a temporary directory.
  3. Remove unnecessary files from the project’s source files stored in the temporary directory.
    1. Directories to be deleted, if exists within the temporary directory:
      1. .git
      2. .svn
    2. Files to be deleted, if exists within the temporary directory:
      1. .gitattributes
      2. .gitignore
      3. *.md
      4. Thumb.dbs
      5. desktop.ini
      6. PSCAT.Proj
  4. Build a compressed PK3 archive file using the files stored in the temporary directory.
  5. Delete the temporary directory.
  6. Finished

The main location where the project’s source files are stored are never touched by the PowerShell Compact-Archive Tool; any changes made to the files will be done so only within the temporary directory.

Toast Notifications

You will now receive Windows Toast Notifications regarding the status of a compiled build. By using BurntToast, the PowerShell Compact-Archive Tool can alert you when the project had been compiled successfully or if an issue had occurred. These notifications will be available within the Windows Notification Bar, making it easier to notify you through the Windows environment instead of only being visible within the terminal.

Illustrating Windows 10 Toast Notification using BurnToast

Clone this wiki locally