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

Compiling Project

Jump to bottom
Nicholas Gautier edited this page Jan 22, 2025 · 20 revisions

Compiling Project Screen - Click to Enlarge

Compiling Projects

When a project has been loaded, the option to compile it will appear in the Main Menu. With the project loaded, you are specifying to the PowerShell Compact-Archive Tool with the exact location of the project's source files that will be compacted into a PK3 archive file. Please ensure that the files structure, within the project's source files, matches exactly what (G)ZDoom expects; otherwise, the (G)ZDoom game engine will not be able to correctly interpret the project's assets.

Accessing the Compile Project option from the Main Menu

Compiling Process

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

  1. Ensure that all of the resources are available.
  2. Copy the project’s source files into a newly created temporary folder.
  3. Remove the unnecessary files that were duplicated into the temporary folder.
    1. Directories that will be deleted:
      1. .git
      2. .svn
    2. Files that will be deleted:
      1. .gitattributes
      2. .gitignore
      3. *.md
      4. Thumb.dbs
      5. desktop.ini
      6. PSCAT.Proj
  4. Generate the compressed PK3 file from the project's source files that were stored in the temporary folder.
  5. Delete the temporary directory.
  6. Finished

NOTE: The main location of where the project's source files are stored will never be altered by the PowerShell Compact-Archive Tool. Any changes that had been made by this tool will only affect within the temporary folder - where the project's files were copied.

Location of Compiled Builds

Compiled builds that were generated by this tool will be stored within the PowerShell Compact-Archive Tool folder from My Documents.

For example:
C:\Users\Admin\Documents\PowerShell Compact-Archive Tool\TGRDM3\TGRDM3.pk3

In general form:
%UserProfile%\Documents\PowerShell Compact-Archive Tool\TGRDM3\TGRDM3.pk3

Showing Output Path using PowerShell Get-ChildItem

Compiled Build Names

When a compiled build is stored in the user's My Documents folder, it will be given a unique name to prevent conflicts. If the PowerShell Compact-Archive Tool detects that a file with the same name already exists, a date and time stamp will be appended to the filename. The format for the filename with the stamp is as follows: day-month-year_24hr-min-sec. For example: TGRDM3_18-Jan-2025_23-35-40, where TGRDM3 is the project name, followed by the timestamp.

Showing Compiled Builds of TGRDM3 using Windows File Explorer

Do note that this project is no longer in evolution nor maintained development cycle anymore. Thus, meaning, no new features or bug fixes will be submitted into this project anymore.

Clone this wiki locally