read - mechpaul/NXPatcher GitHub Wiki
Read
usefastpatchtype
default value: 0
This value determines how many copies of the currently patched file (ex. Mob.wz, Npc.wz) is stored in memory. Keep in mind for the purposes of calculating memory allocation that an unpacked version of the patch file (ex. "00085to00090.patch", "00100to00102.patch") is always stored in memory for the purposes of faster execution speed.
If set to 0:
-- While calculating the checksum of a rebuilt file, it is read in chunks from the hard drive.
-- While rebuilding the file, random accesses requested by the patch file are read from the hard drive
-- Uses fewer resources at the expense of slower execution (zero copies of the file is held in memory)
If set to 1:
-- The entire file is read into memory before calculating the checksum or performing any file rebuilding
-- The checksum is calculated while the file is in memory
-- The file is rebuilt from memory to the hard drive
-- Faster execution at the expense of higher resources (one copy of the entire file is held in memory)
If set to 2:
-- The entire file is read into memory before calculating the checksum or performing any file rebuilding
-- The checksum is calculated while the file is in memory
-- The entire file is rebuilt entirely inside memory
-- Very fast execution at the expense of a lot of resources (two copies of the entire file are held in memory at once)
outputfolder
Default value: Patcher
This is the default folder which NXPatcher outputs all of the patch files. This can be an absolute or a relative reference. Never include a trailing slash. This folder is created automatically and does not have to exist prior to running NXPatcher.
ifbackup
Default value: 0
If set to 0:
No backing up of current files to {read:backupdir} is performed.
If set to 1:
After the patch file is fully done with the patching procedure, NXPatcher creates a list of all of the new files being created with the new patch. It then takes all of the files in the current maplestory directory and moves them to wherever {read:backupdir} is. The backup procedure always occurs before {read:ifautoapply} happens.
backupdir
Default value: v{nxpatcher:version}
This is the directory in which all of the backup files are stored. This can be an absolute or a relative reference. Never include a trailing slash. This folder is created automatically and does not have to exist prior to running NXPatcher. The location of {read:backupdir} must be on the same volume as {read:outputfolder} or else the files will not be moved.
ifdeltxt
Default value: 1
If set to 0:
The file {read:deltxt} is not created.
If set to 1:
During the patching procedure, the patch file will request that certain files will be deleted. For the sake of not corrupting perfectly good Maplestory files, these files are never deleted. Instead, a listing of all files requested by the patch file for deletion are placed in {read:deltxt} which is located in the {read:outputfolder} directory.
deltxt
Default value: delfiles.txt
This file contains all of the files requested for deletion by the patch file. It is always located in the {read:outputfolder} directory.
ifautoapply
Default value: 0
If set to 0:
The patch files are not automatically applied. They remain in the {read:outputfolder} directory.
If set to 1:
After the backup procedure is performed (see {read:ifbackup}), NXPatcher creates a list of files in the {read:outputfolder} directory and moves all of the files to the current working directory. The empty folders found in {read:outputfolder} are then deleted. Your maplestory directory and {read:outputfolder} must be on the same volume for this to work properly.