Skip to content

Commit 9230983

Browse files
committed
README: Fiddle with Future section a bit
Also fix documented path to path database, derp.
1 parent 10755ac commit 9230983

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,16 +89,19 @@ If a game uses large files and in-place binary patching for updates, it might be
8989

9090
## Future
9191

92-
These may or may not happen, but have been on my mind.
92+
In the fairly-concrete TODO:
9393

94-
* Double-check the default exclusions list. Should be able to do something with the compresstimation code to verify them.
95-
* Examine [overlapped IO], see if we can get more information and control out of the compression process (per-file progress and cancellation).
94+
* Hook up an interface to the saved paths database (count, option to clear it).
9695
* Recompression, for changing compression modes without manually decompressing/recompressing.
97-
* Scheduled task or a background service to periodically recompress selected directories.
98-
* Write bindings to Microsoft's [Compression API], add benchmarks for the various compression modes to help users decide which is most appropriate for their system.
99-
* Less rubbish installer. Why does this involve so much XML oh god.
96+
* Installer. Why does this involve so much XML oh god.
10097
* Sign the binaries/installer. If I give away my code I get a free one, right?
98+
* Double-check the default exclusions list. Should be able to do something with the compresstimation code to verify them.
10199

100+
More tentative:
101+
102+
* Scheduled task or a background service to periodically recompress selected directories.
103+
* Write bindings to Microsoft's [Compression API], add benchmarks for the various compression modes to help users decide which is most appropriate for their system.
104+
* Examine [overlapped IO], see if we can get more information and control out of the compression process (per-file progress and cancellation).
102105

103106
## Alternatives
104107

@@ -117,7 +120,7 @@ Under the hood it uses [`DeviceIoControl`] with [`FSCTL_SET_EXTERNAL_BACKING`] a
117120

118121
Compresstimation uses a simple linear sampling algorithm, passing blocks through LZ4 level 1 as a compressibility check and averaging across the entire file. The code is [available on Github][compresstimator].
119122

120-
The incompressible-files database is simply an append-only list of SipHash128 path hashes. It should be safe to share between multiple instances if you want to compress different drives at the same time. It lives in your `%APPDIR%` Roaming folder under `Freaky\Compactor`.
123+
The incompressible-files database is simply an append-only list of SipHash128 path hashes. It should be safe to share between multiple instances if you want to compress different drives at the same time. It lives in `%APPDATA%\Local\Freaky\Compactor`.
121124

122125

123126
## Author

0 commit comments

Comments
 (0)