Skip to content

Commit 90c0478

Browse files
committed
Update VersionFileWriter and associated documentation/examples
1 parent 40d27d7 commit 90c0478

File tree

3 files changed

+14
-0
lines changed

3 files changed

+14
-0
lines changed

AdditionalFiles/VersionFileWriter/VersionConfig.ini

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ RecursiveDirectorySearch=yes
2222
IncludeOnlyChangedFiles=no
2323
; If set, original versions of archived files will also be copied to copied files directory.
2424
CopyArchivedOriginalFiles=no
25+
; If set, any directories (including all files and subdirectories in them, regardless of any other settings) and files flagged as hidden or system protected will be excluded. This also defaults to true.
26+
ExcludeHiddenAndSystemFiles=yes
27+
; If set, the mod version string is treated as .NET timestamp/datetime format string with current local time applied on it.
28+
ApplyTimestampOnVersion=no
29+
; If set, no files will be copied whatsoever, only version file(s) are generated. Setting this also disables archived files feature regardless of other settings.
30+
NoCopyMode=no
2531

2632
; Files & directories to include in version file.
2733
[Include]
@@ -34,6 +40,11 @@ Test\
3440
[ExcludeFiles]
3541
Test\test2.file
3642

43+
; Directories to be excluded from included files list
44+
; If you include entire directory trees f.ex map editors, this is useful to exclude things like autosave or log directories.
45+
[ExcludeDirectories]
46+
Test\TestDir
47+
3748
; Files (not directories) to be included as archives.
3849
[ArchiveFiles]
3950
test.file
2.5 KB
Binary file not shown.

Docs/Updater.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ These are set under `[Options]` in `VersionConfig.ini`.
5050
- `RecursiveDirectorySearch`: If set, will go through every subdirectory recursively for directories given in `[Include]`.
5151
- `IncludeOnlyChangedFiles`: If set, version file writer will always create two version files - one with everything included (`version_base`) and the proper, actual version file with only changed files (`version`). Note that `version_base` should be kept around as it is used to compare which files have been changed next time version file writer is ran.
5252
- `CopyArchivedOriginalFiles`: If set, original versions of archived files will also be copied to copied files directory.
53+
- `ExcludeHiddenAndSystemFiles`: If set, any directories (including all files and subdirectories in them, regardless of any other settings) and files flagged as hidden or system protected will be excluded. This also defaults to `true`.
54+
- `ApplyTimestampOnVersion`: If set, the mod version string is treated as [.NET timestamp/datetime format string](https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings) with current local time applied on it.
55+
- `NoCopyMode`: If set, no files will be copied whatsoever, only version file(s) are generated. Setting this also disables archived files feature regardless of other settings.
5356

5457
#### Updater Version & Manual Download URL
5558
Setting `[UpdaterVersion]` in `VersionConfig.ini` writes this information to the `version` file and allows developers to control which versions are allowed to download files from the version info through the client. Mismatching updater versions between local and server version files will suggest users to download update manually through updater status message. Absent or malformed updater version (both local & server) is equivalent to `N/A` and updater will bypass the mismatch check entirely if server updater version is set to this or absent.

0 commit comments

Comments
 (0)