phpZipScript Configuration file reference
Output Related

Back to manual index
Back to index

Content:
PFCompleteModel
PFIncompleteModel
ProgressBarLength
ProgressFilledChar
ProgressBlankChar
TagsModes
TagsOwner
TagsOwnerRights
TagsGroupRights
TagsWorldRights
MessageFileName
MessageFilesOwner
MessageFilesRights
CreateMissingFiles
MissingFilesSuffix
MissingFilesRights
MissingFilesOwner
ExtractedFilesRights
ModelSpaceChar
CompleteModel
IncompleteModel
ParentIncompleteModel
NoFileIDModel
BadFileIDModel
DeleteBadFileID
CreateMessageFile
PFCompleteModel
This option allows you add a sentence at the end of the progress file when a release is complete (to the last uploader in other words).
If you don't want it to be displayed set it to false.

Note: For available variables cf. CompleteModel.
eg:
PFCompleteModel=[%P] - %N files,WINNER: %w (%g)
PFIncompleteModel
This option allows you add a sentence at the end of the progress file (cf. ProgressFile). If you don't want it to be displayed set it to false.

Note: For available variables cf. CompleteModel.
eg:
PFIncompleteModel=[%P] (%p%%) : %n/%N files
ProgressBarLength
Sets the size of the progress bar in incomplete tag in chars.
eg:
ProgressBarLength = 30
ProgressFilledChar
Set here the character to use as filled chars in the progress bar.
If not set the script will use a default char ('#').
eg:
ProgressFilledChar = #
ProgressBlankChar
Set here the character to use as blank chars in the progress bar.
If not set the script will use a default char ('=').
eg:
ProgressBlankChar = =
TagsModes
Allows you to specify which tags must be created, and how to create them (0-byte file or folder)

This option is made of several digits each one corresponding to a specific tag: there are three possible values for each tag: If this option is left blank or set to false then no tags will be created.
examples:
TagsOwner
The racer the tags should belong to.

Possible values :
eg:
TagsOwner=2
TagsOwner=script,script
TagsOwnerRights
Allows you to specify the rights that should be applied to the tags owner (set with TagsOwner).

This option is made of several digits each one corresponding to a specific tag.

The rights are set according using raiden rights system, ie: the sum of digits sets which rights are given. if you set a digit to 0 then no access rights will be given for the the corresponding file.
examples:
TagsGroupRights
Allows you to specify the rights that should be applied to the tags owner group (set with TagsOwner).

cf. TagsOwnerRights.
eg:
TagsGroupRights=44444
TagsWorldRights
Allows you to specify the rights that should be applied to the ppl no belonging to the owner group (set with TagsOwner).

cf. TagsOwnerRights.
eg:
TagsWorldRights=44444
MessageFileName
Allows you to specify the name of the message files (default : .message).

eg:
MessageFileName=.message
MessageFileName=.mysitemsg
MessageFilesOwner
Allows you to specify the owner of the message files (.message).

Possible values :
eg:
MessageFilesOwner=2
MessageFilesOwner=phpZipScript,script
MessageFilesRights
Allows you to specify the rights for the message files (.message).
eg:
MessageFilesRights=544
CreateMissingFiles
Tells the script wether it should create missing files tags or not.
A missing tag is a 0byte file created for a file that wasn't uploaded for a release. The name of that tag is the missing file name + a suffix defined in the MissingFilesSuffix option.

Default value is true.
eg:
CreateMissingFiles=true
CreateMissingFiles=false
MissingFilesSuffix
Allows you to specify the suffix the script should append to missing files names to create missing files tags.

Default value is -missing.
eg:
MissingFilesSuffix=-missing
MissingFilesSuffix=.missing
MissingFilesOwner
Allows you to specify the owner for the missing files tags.

cf. MessageFilesOwner for more info.
eg:
MissingFilesOwner=1
MissingFilesOwner=phpZipScript,script
MissingFilesRights
Allows you to specify the owner for the missing files tags.

cf. MessageFilesRights for more info.
eg:
MissingFilesRights=544
MissingFilesRights=700
ExtractedFilesRights
Allows you to specify the rights for the auto-extracted files (ie: nfos, file_id.diz)
eg:
ExtractedFilesRights=544
ModelSpaceChar
This allows you to set a character to replace spaces character in models It can be useful when using the %T(tagline) variable in models.

To leave spaces unchanged just set the value to off/false or leave it blank.
eg:
ModelSpaceChar=_
CompleteModel
This option allows you to define how the complete folders/files tags will look like.

Warning: Do not use one of these characters : \ / * : ? " < > |

Available variables :
eg:
CompleteModel=-COMPLETE-[%s].[-%w(%g)-].[%vKBps]-
IncompleteModel
This option allows you to define how the incomplete folders/files tags will look like.
This tag is the one that will be placed in the release directory.

Warning: Do not use one of these characters : \ / * : ? " < > |

For the available variables cf. CompleteModel.

!!!!! WARNING !!!!!!!:
the IncompleteModel MUST include the word 'incomplete' (case doesn't matter), otherwise the tags won't be created.
eg:
IncompleteModel=-[--incomplete--].[%P].[%p%%-done]-
ParentIncompleteModel
This option allows you to define how the incomplete folders/files tags will look like.
This tag is the one that will be placed in the release parent directory.

Warning: Do not use one of these characters : \ / * : ? " < > |

For the available variables cf. CompleteModel.

!!!!! WARNING !!!!!!!:
the IncompleteModel MUST include the word 'incomplete' (case doesn't matter) AND the %r(release name) variable, otherwise the tags won't be created.
eg:
ParentIncompleteModel=-[--incomplete--].[%r].[--%n-of-%N-completed--]-
NoFileIDModel
This option allows you to define how the no file_id.diz folders/files tags will look like.

Warning: Do not use one of these characters : \ / * : ? " < > |

No variables available
eg:
NoFileIDModel=-[--no-file_id.diz--].[unknown%]-
BadFileIDModel
This option allows you to define how the bad file_id.diz folders/files tags will look like.

Warning: Do not use one of these characters : \ / * : ? " < > |

No variables available
eg:
BadFileIDModel=-[--file_id.diz-is-bad--].[unknown%]-
DeleteBadFileID
If you set this option to true then the script will delete file_id.diz files it cannot understand.

Note:This doesnt apply on Rom Paths monitored.
eg:
DeleteBadFileID=true
CreateMessageFile
This option allows you to tell the script wether it should or not create a .message file in the release folder.
This file can be used to diplay extended race info when someone enters the release directory (cf. readme.txt).
eg:
CreateMessageFile=true