Skip to content

Commit 2f80ea5

Browse files
committed
Update information regarding file extraction
1 parent d75dd6d commit 2f80ea5

1 file changed

Lines changed: 27 additions & 23 deletions

File tree

README.md

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Discord Cache Dump
2+
23
<img src="banner.png" alt="Banner with logo">
34
<br>
45
<p align="center">
@@ -20,25 +21,26 @@ Discord Cache Dump is a tool that gathers the cache of all known Electron Discor
2021

2122
## Features
2223

23-
- Detection of known Discord build types (can do multiple in a single run)
24-
- Discloses count of amount of files it is unable to gather at the time for that particular build
25-
- Supports Windows, GNU/Linux, and macOS
26-
- Checks storage available where the program is being ran before copying
27-
- Dumps are timestamped along with the cache being in their own build type directories
28-
- Select specific build type with the `--build` (or `-b`) flag (i.e. `./dcd --build stable`)
29-
- Non-interactive mode by using the `--noninteractive` (or `-n`) flag (i.e. `./dcd --noninteractive`)
24+
- Detection of known Discord build types (can do multiple in a single run)
25+
- Discloses count of amount of files it is unable to gather at the time for that particular build
26+
- Supports Windows, GNU/Linux, and macOS
27+
- Checks storage available where the program is being ran before copying
28+
- Dumps are timestamped along with the cache being in their own build type directories
29+
- Select specific build type with the `--build` (or `-b`) flag (i.e. `./dcd --build stable`)
30+
- Non-interactive mode by using the `--noninteractive` (or `-n`) flag (i.e. `./dcd --noninteractive`)
3031

3132
## Known limitations
3233

33-
- The files that a Discord client process is utilising at the time cannot be copied over as it involves opening
34-
- It is advised to kill the parent process of the client(s) you wish to copy files from that contains strings of *potentially sensitive* data
35-
- Due to how cache is stored in later GNU/Linux builds, this program includes a file extraction function
36-
- .MOV files cannot be completely extracted
37-
- Some .GZ (gzip) files containing mentions of .JS cannot be completely extracted
38-
- Some cache files containing request and response data cannot be completely extracted
39-
- Cache files that cannot be handled at all will not have their contents altered as they are being copied over
34+
- The files that a Discord client process is utilising at the time cannot be copied over as it involves opening
35+
- It is advised to kill the parent process of the client(s) you wish to copy files from that contains strings of _potentially sensitive_ data
36+
- Due to how cache is stored in GNU/Linux and macOS builds, this tool includes a file extraction function
37+
- .MOV files cannot be completely extracted
38+
- Some .GZ (gzip) files containing mentions of .JS cannot be completely extracted
39+
- Some cache files containing request and response data cannot be completely extracted
40+
- Cache files that cannot be handled at all will not have their contents altered as they are being copied over
4041

4142
## Always opened files
43+
4244
The following files are known to be used constantly by Discord and so cannot be copied while that Discord client is running.
4345

4446
| File | Contents |
@@ -53,10 +55,10 @@ The following files are known to be used constantly by Discord and so cannot be
5355

5456
In order to compile the tool, there are a few things required to get it set up.
5557

56-
- Go (compiling)
57-
- [h2non/filetype](https://github.com/h2non/filetype) (recognition of file types and extensions): `go get github.com/h2non/filetype`
58-
- [ricochet2200/go-disk-usage](https://github.com/ricochet2200/go-disk-usage) (disk information): `go get github.com/ricochet2200/go-disk-usage/du`
59-
- [jessevdk/go-flags](https://github.com/jessevdk/go-flags) (flag handling): `go get github.com/jessevdk/go-flags`
58+
- Go (compiling)
59+
- [h2non/filetype](https://github.com/h2non/filetype) (recognition of file types and extensions): `go get github.com/h2non/filetype`
60+
- [ricochet2200/go-disk-usage](https://github.com/ricochet2200/go-disk-usage) (disk information): `go get github.com/ricochet2200/go-disk-usage/du`
61+
- [jessevdk/go-flags](https://github.com/jessevdk/go-flags) (flag handling): `go get github.com/jessevdk/go-flags`
6062

6163
## Usage
6264

@@ -67,15 +69,17 @@ In order to compile the tool, there are a few things required to get it set up.
6769
| macOS | `./dcd_darwin` (run `chmod +x ./dcd_darwin` initially) |
6870

6971
## Credits
72+
7073
| User | Contribution |
7174
| ------------------------------------------- | ----------------------------------------------------------------------------------- |
7275
| [uintdev](https://github.com/uintdev) | Research &amp; analysis, development, Windows, GNU/Linux and macOS platform testing |
7376
| [NotZoeyDev](https://github.com/NotZoeyDev) | macOS platform testing |
7477
| [utf-4096](https://github.com/utf-4096) | GNU/Linux platform testing |
7578

7679
## Tested
77-
- Windows 10
78-
- Ubuntu (GNU/Linux)
79-
- Kali Linux (GNU/Linux)
80-
- Solus (GNU/Linux)
81-
- macOS
80+
81+
- Windows 10
82+
- Ubuntu (GNU/Linux)
83+
- Kali Linux (GNU/Linux)
84+
- Solus (GNU/Linux)
85+
- macOS

0 commit comments

Comments
 (0)