diff --git a/.docs/Docker-usage-instructions.md b/.docs/Docker-usage-instructions.md new file mode 100644 index 0000000..ff22569 --- /dev/null +++ b/.docs/Docker-usage-instructions.md @@ -0,0 +1,108 @@ +# Docker usage instructions + +Docker distribution of DiscordChatExporter provides a way to run the app in a virtualized and isolated environment. Due to the nature of Docker, you also don't need to install any prerequisites otherwise required by DCE. + +Note that only the CLI flavor of DiscordChatExporter is available for use with Docker. + +### Pulling + +This will download the [Docker image from the registry](https://hub.docker.com/r/tyrrrz/discordchatexporter) to your computer. You can run this command again to update when a new version is released. + +``` +docker pull tyrrrz/discordchatexporter:stable +``` + +Note the `:stable` tag. DiscordChatExporter images are tagged according to the following patterns: + +- `stable`: Latest stable version release and maps to the latest GitHub release. This tag is updated with release of each new version. Recommended for personal use. +- `latest`: Built from the latest commit and maps to the latest CI build on GitHub. This tag is updated with each new commit to `master` branch. Not recommended for everyday use, but you can use it if you want to try out some features that haven't been officially released yet. +- `x.y.z` (e.g. `2.30.1`): Fixed version release and maps to the corresponding tag on GitHub. This tag is never updated once that version has been released. Recommended for use in various automation scenarios. + +You can see all available tags [here](https://hub.docker.com/r/tyrrrz/discordchatexporter/tags?page=1&ordering=name). + +### Usage + +To run the CLI in Docker and render help text: + +``` +docker run --rm tyrrrz/discordchatexporter:stable +``` + +To export a channel: + +``` +docker run --rm -v /path/on/machine:/out tyrrrz/discordchatexporter:stable export -t TOKEN -c CHANNELID +``` + +If you want colored output, real-time progress reporting, and some other stuff, pass `-it` (interactive) option: + +``` +docker run --rm -it -v /path/on/machine:/out tyrrrz/discordchatexporter:stable export -t TOKEN -c CHANNELID +``` + +Note the `-v /path/on/machine:/out` option, which instructs Docker to bind the `/out` directory inside the container to a path on your host machine. Replace `/path/on/machine` with the directory you want the files to be saved at. + +**If you are running SELinux, you will need to add the `:z` option after `/out`, e.g.:** + +``` +docker run --rm -v /path/on/machine:/out:z tyrrrz/discordchatexporter:stable export -t TOKEN -c CHANNELID +``` + +For more information, refer to the [Docker docs SELinux labels for bind mounts page](https://docs.docker.com/storage/bind-mounts/#configure-the-selinux-label). + +You can also use the current working directory as the output directory by specifying: + +* `-v $PWD:/out` in Mac/Linux +* `-v $pwd.Path:/out` in PowerShell + +For more information, please refer to the [Dockerfile](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/Dockerfile) and [Docker documentation](https://docs.docker.com/engine/reference/run/).
+To get your Token and Channel IDs, please refer to [this page](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md). + +### Environment variables + +DiscordChatExpoter CLI accepts environment variables as fallbacks for the `--token` and `--bot` options. + +- `DISCORD_TOKEN` to set the token +- `DISCORD_TOKEN_BOT` to set whether it's a bot token (`true` or `false`) + +You can use these variables either with the `--env` Docker option or with a combination of the `--env-file` Docker option and a `.env` file. +Please refer to the Docker documentation for more information: + +* [Docker run - Set environment variables](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file) + +### Permission issues with Linux hosts + +When bounding volumes between the container and the host, files mirrored from the Docker container will be owned by the Docker user (in most setups this is `root`). Please refer to this [issue comment](https://github.com/Tyrrrz/DiscordChatExporter/issues/800#issuecomment-1030471970) for instructions on how to override this behavior. + +### Build Docker images for arm on Raspberry Pi + +If you use the Docker image on arm (for example Raspberry Pi), you'd build the image as below. + +```bash +$ git clone https://github.com/Tyrrrz/DiscordChatExporter.git +$ cd DiscordChatExporter +$ docker build -f DiscordChatExporter.Cli.dockerfile -t tyrrrz/discordchatexporter:latest . +``` + +After a while, some images are built like below. + +```bash +$ docker image ls +REPOSITORY TAG IMAGE ID CREATED SIZE +tyrrrz/discordchatexporter latest 7c9ead725177 49 seconds ago 199MB + 57f9f49d05af About a minute ago 678MB +mcr.microsoft.com/dotnet/sdk 5.0 72af6071941e 4 days ago 641MB +mcr.microsoft.com/dotnet/runtime 3.1 6229bebd5a11 4 days ago 197MB +``` + +Among these, two images (`tyrrrz/discordchatexporter:latest` and `mcr.microsoft.com/dotnet/runtime:3.1`) are required, so you may delete the other two images. + +Now you can execute DiscordChatExporter: + +```bash +$ docker run --rm tyrrrz/discordchatexporter:latest +``` + +___ + +Special thanks to [@simnalamburt](https://github.com/simnalamburt) (dockerize) and [@Nimja](https://github.com/nimja) (better instructions) \ No newline at end of file diff --git a/.docs/GUI,-CLI-and-Formats-explained.md b/.docs/GUI,-CLI-and-Formats-explained.md new file mode 100644 index 0000000..24e22bc --- /dev/null +++ b/.docs/GUI,-CLI-and-Formats-explained.md @@ -0,0 +1,465 @@ +# GUI, CLI and Formats explained + +# Getting started + +Welcome to the getting started page! +Here you'll learn how to use every **DiscordChatExporter** (DCE for short) feature. +For other things you can do with DCE, check out the [Guides](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Readme.md#Guides) section. + +If you still have unanswered questions after reading this page or if you have encountered a problem, please visit our [FAQ & Troubleshooting](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md) section. + +The information presented on this page is valid for **all** platforms. + +**Index** +* [GUI or CLI?](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#gui-or-cli) +* [Using the GUI](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#using-the-gui) +* [Using the CLI](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#using-the-cli) + * [Command list](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#dcecli-commands) +* [File formats](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#file-formats) + * [HTML](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#html) + * [Plain Text](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#plain-text) + * [JSON](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#json) + * [CSV](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#csv) + + +# GUI or CLI? +![](https://i.imgur.com/j9OTxRB.png) +**DCE** has two different versions: +* **Graphical User Interface** (**GUI**) - it's the preferred version for newcomers as it is easy to use. +You can get it by [downloading](https://github.com/Tyrrrz/DiscordChatExporter/releases/latest) the `DiscordChatExporter.zip` file. +* **Command Line Interface** (**CLI**) - offers greater flexibility and more features for advanced users, such as export scheduling, ID lists, and more specific date ranges. +You can get it by [downloading](https://github.com/Tyrrrz/DiscordChatExporter/releases/latest) the `DiscordChatExporter.CLI.zip` file. + +If you're not comfortable with **Windows'** Command Line (cmd), please choose the GUI. +[**macOS**](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/macOS-usage-instructions.md), [**Linux**](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Linux-usage-instructions.md) and [**Docker**](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Linux-usage-instructions.md) users can only use the CLI version. + +**(Skip to [Using the CLI](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#using-the-cli) or [File Formats](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#file-formats))** +# Using the GUI +### Video tutorial + +[![Video tutorial](https://i.ytimg.com/vi/jjtu0VQXV7I/hqdefault.jpg)](https://youtube.com/watch?v=jjtu0VQXV7I) + +> Video by [NoIntro Tutorials](https://youtube.com/channel/UCFezKSxdNKJe77-hYiuXu3Q). + +### Guide +**1.** After extracting the `.zip`, open `DiscordChatExporter.exe` + +**2.** Please refer to the on-screen instructions to get your token, then paste your token in the upper text box and hit ENTER or click the arrow (→). +**NEVER SHARE YOUR TOKEN**. A token gives full access to an account, treat it like a password. + + + +**3.** DCE will display your Direct Messages and a sidebar with your server list. Select the channel you would like to export, then click the ![](https://i.imgur.com/dnTOlDa.png) button to continue. +> 💡 Tip: You can export multiple channels at once by holding `CTRL` or `SHIFT` while selecting. +> You can also double-click a channel to export it without clicking the ![](https://i.imgur.com/dnTOlDa.png) button. + + + + +**4.** In this screen you can customize the following: +* **Export format** - HTML (Dark), HTML (Light), TXT, CSV and JSON + +Click the menu button (☰) to see more options: + +* **Date range (after/before)** (Optional) - If set, only messages sent in the provided date range will be exported. Only one value (either after or before) is required if you want to use this option. + > Please note that the time defaults to **12:00 AM** (midnight/00:00). This means that if you choose to export between Sep 17th and Sep 18th, messages from Sep 18th won't be exported. +* **Filter** (Optional) - Special notation for filtering the messages that get included in the export. See [Message filters](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Message-filters.md) for more info. +* **Messages per partition** (Optional) - Split output into partitions, each limited to this number of messages (e.g. 100) or file size (e.g. 10mb). For example, a channel with 36 messages set to be partitioned every 10 messages will output 4 files. +* **Download assets** (Optional) - If this option is set, the export will include additional files such as user avatars, attached files, images, etc. +Only files that are referenced by the export are downloaded, which means that, for example, user avatars will not be downloaded when using the plain text (TXT) export format. +A folder containing the assets will be created along with the exported chat. They must be kept together. + +**5.** Click `EXPORT` to export. + + + +### Settings + +**Auto-updates** +Perform automatic updates on every launch. +Default: Enabled +> 💡 Tip: Keep this option enabled to receive the latest features and bug fixes! + +**Dark mode** +Use darker colors in the UI (User Interface). +Default: Disabled + +**Save token** +Persist last used token between sessions. +Default: Enabled + +**Reuse downloaded assets** +Reuse already downloaded assets to skip redundant requests. +Default: Disabled + +**Date format** +You can customize how dates are formatted in the exported files in the settings menu (). +* The default one is `17-Sep-19 11:34 PM` - `dd-MMM-yy hh:mm tt` +* To change it to `09-17-19 11:34 PM` use `MM-dd-yy hh:mm tt` +* To change it to `17/09/2019 23:34` use `dd/MM/yyyy HH:mm` +* To change it to `2019-09-17 23:34:05.6534` use `yyyy-MM-dd HH:mm:ss.ffff` +* To change it to UTC `2019-09-18 04:34:05Z` use `u` +* To display the time zone, add `K`. E.g. to change it to `17-Sep-19 11:34 PM (UTC-05:00)` use `dd-MMM-yy hh:mm tt (UTCK)` +* To change it to Unix time `1568694845` use `unix` +* To change it to Unix time in milliseconds `1568694845653` use `unixms` + +More info about .NET date formats [here](https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings). + + +**Parallel limit** +The number of channels can be exported at the same time. +Default: 1 + +> 💡 Tip: Try to keep this number low so that your account doesn't get flagged. + +**(Skip to [File Formats](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#file-formats))** + +# Using the CLI +> Make sure you have [.NET Core installed](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Install-.NET-Core-runtime.md) before attempting to run the commands below. +> **Docker** users, please refer to the [Docker usage instructions](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Linux-usage-instructions.md). + +**1.** After extracting the `.zip`, open Command Prompt, aka `cmd` (`Terminal` on **macOS** and **Linux**). + +**2.** Change the current directory to DCE's folder with `cd C:\path\to\directory`, then press ENTER to run the command. + +**Windows** users can quickly get the directory's path by clicking the address bar while inside the folder. +![](https://i.imgur.com/XncnhC2.gif) +**macOS** users can select the `.exe`, hit Command+I (⌘I), and copy what's after `Where:` to get the directory +![](https://camo.githubusercontent.com/3c51a904b0099c9f68a4797461d4a7914902fc04/68747470733a2f2f692e696d6775722e636f6d2f323975364e79782e706e67) +You can also drag and drop the folder on **every platform**. +![](https://i.imgur.com/sOpZQAb.gif) + +**3.** Now we're ready to run the commands. The examples on this page follow the Windows file path format, change the file paths according to your system. + +Let's do the following to list DCE's options: + +Type the following in Command Prompt (Terminal), then press ENTER to run it: +```powershell +dotnet DiscordChatExporter.Cli.dll +``` + +> **Docker** users, please refer to the [Docker usage instructions](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Linux-usage-instructions.md). + +## DCE.CLI commands + +| Command | Description | +| ------- | ----------- | +[export](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#export) | Exports a channel +[exportdm](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#exportdm) | Exports all direct message channels +[exportguild](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#exportguild) | Exports all channels within the specified server +[exportall](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#exportall) | Exports all accessible channels +[channels](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#channels) | Outputs the list of channels in the given server +[dm](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#dm) | Outputs the list of direct message channels +[guilds](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#guilds) | Outputs the list of accessible servers +[guide](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#guide) | Explains how to obtain token, guild, and channel ID + +To use the commands, you'll need a token. For the instructions on how to get a token, please refer to [this page](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md), or run `dotnet DiscordChatExporter.Cli.dll guide`. +To get help with a specific command, please run: +```powershell +dotnet DiscordChatExporter.Cli.dll command -h +``` + +## export + +||Option | Description +|--|------- | ------------- +|**\***|[-c](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#basic-usage) | [Channel ID(s)](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md#how-to-get-guild-id-or-guild-channel-id) +|**\***|[-t](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#basic-usage) | [Authorization token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md#how-to-get-user-token). Environment variable: `DISCORD_TOKEN` +||[-o](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#changing-the-output-filename) | Output file or directory path +||[-f](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#changing-the-format) | [Output file format](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#file-formats). Default: HtmlDark +||[--after](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#date-ranges)| Only include messages sent after this date +||[--before](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#date-ranges) | Only include messages sent before this date +||[-p](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#partitioning) | Split output into partitions, each limited to this number of messages (e.g. 100) or file size (e.g. 10mb) +||[--filter](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Message-filters.md) | Special notation for filtering the messages that get included in the export +||[--media](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#Downloading-assets) | Download assets referenced by the export (user avatars, attached files, embedded images, etc.). Default: false +||[--reuse-media](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#Reuse-assets) | Reuse previously downloaded assets to avoid redundant requests. Default: false. +||[--dateformat](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#date-formats) | Format used when writing dates. +||-h | Shows help text + +> Options with an asterisk (**\***) are required. The order of the options doesn't matter. + +With this command you can export Server Channels and Direct Messages. + +### Basic usage +You can quickly export with DCE's default settings by using just `-t token` and `-c channelid`. +```powershell +dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 +``` + +### Changing the format +You can change the export format to `HtmlDark`, `HtmlLight`, `PlainText` `Json` or `Csv` with `-f format`. The default format is `HtmlDark`. +```powershell +dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 -f Json +``` + +### Changing the output filename +You can change the filename by using `-o name.ext`. e.g. for the `HTML` format: +```powershell +dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 -o myserver.html +``` + +### Changing the output directory +You can change the export directory by using `-o` and providing a path that ends with a slash or does not have a file extension. +If any of the folders in the path have a space in its name, escape them with quotes ("). +```powershell +dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 -o "C:\Discord Exports" +``` + +### Changing the filename and output directory +You can change both the filename and export directory by using `-o directory\name.ext`. +Note that the filename must have an extension, otherwise it will be considered a directory name. +If any of the folders in the path have a space in its name, escape them with quotes ("). +```powershell +dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 -o "C:\Discord Exports\myserver.html" +``` + +### Generating the filename and output directory dynamically +You can use template tokens to generate the output file path based on the guild and channel metadata. + +```powershell +dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 -o "C:\Discord Exports\%G\%T\%C.html" +``` + +Assuming you are exporting a channel named `"my-channel"` in the `"Text channels"` category from a server called `"My server"`, you will get the following output file path: `C:\Discord Exports\My server\Text channels\my-channel.html` + +Here is the full list of supported template tokens: + +- `%g` - guild ID +- `%G` - guild name +- `%t` - category ID +- `%T` - category name +- `%c` - channel ID +- `%C` - channel name +- `%p` - channel position +- `%P` - category position +- `%a` - the "after" date +- `%b` - the "before" date +- `%%` - escapes `%` + +### Partitioning +You can use partitioning to split files after a given number of messages or file size. +For example, a channel with 36 messages set to be partitioned every 10 messages will output 4 files. +```powershell +dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 -p 10 +``` + +A 45mb channel set to be partitioned every 20mb will output 3 files. + +```powershell +dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 -p 20mb +``` + +### Downloading assets +If this option is set, the export will include additional files such as user avatars, attached files, images, etc. +Only files that are referenced by the export are downloaded, which means that, for example, user avatars will not be downloaded when using the plain text (TXT) export format. +A folder containing the assets will be created along with the exported chat. They must be kept together. + +```powershell +dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 --media +``` + +### Reuse assets +Previously downloaded assets can be reused to skip redundant downloads as long as the chat is always exported to the same folder. Using this option can speed up future exports. This option requires the `--media` option. + +```powershell +dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 --media --reuse-media +``` + + +### Date formats +This setting changes how dates are formatted in the exported files. +* The default one is `17-Sep-19 11:34 PM` - `dd-MMM-yy hh:mm tt` +* To change it to `09-17-19 11:34 PM` use `MM-dd-yy hh:mm tt` +* To change it to `17/09/2019 23:34` use `dd/MM/yyyy HH:mm` +* To change it to `2019-09-17 23:34:05.6534` use `yyyy-MM-dd HH:mm:ss.ffff` +* To change it to UTC `2019-09-18 04:34:05Z` use `u` +* To display the time zone, add `K`. E.g. to change it to `17-Sep-19 11:34 PM (UTC-05:00)` use `dd-MMM-yy hh:mm tt (UTCK)` +* To change it to Unix time `1568694845` use `unix` +* To change it to Unix time in milliseconds `1568694845653` use `unixms` + +More info about .NET date formats [here](https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings). + +```powershell +dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 --dateformat "yyyy-MM-dd HH:mm" +``` + +> Special thanks to [@andrewkolos](https://github.com/andrewkolos) for adding the Unix options + +### Date ranges +**Messages sent before a date** +Use `--before` to export messages sent before the provided date. E.g. messages sent before September 18th, 2019: +```powershell +dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 --before 2019-09-18 +``` +**Messages sent after a date** +Use `--after` to export messages sent after the provided date. E.g. messages sent after September 17th, 2019 11:34 PM: +```powershell +dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 --after "2019-09-17 23:34" +``` +**Messages sent in a date range** +Use `--before` and `--after` to export messages sent during the provided date range. E.g. messages sent between September 17th, 2019 11:34 PM and September 18th: +```powershell +dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 --after "2019-09-17 23:34" --before "2019-09-18" +``` + +You can try different formats like `17-SEP-2019 11:34 PM` or even refine your ranges down to milliseconds `17-SEP-2019 23:45:30.6170`! +Don't forget to quote (") the date if it has spaces! +More info about .NET date formats [here](https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings). + + +## exportdm +||Option | Description +|-|------- | ------------- +|**\***|[-t](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#basic-usage) | [Authorization token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md#how-to-get-user-token). Environment variable: `DISCORD_TOKEN` +||--parallel| Limits how many channels can be exported in parallel. Try to keep this number low so that your account doesn't get flagged. Default: 1 +||[-o](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#changing-the-output-filename) | Output file or directory path +||[-f](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#changing-the-format) | [Output file format](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#file-formats). Default: HtmlDark +||[--after](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#date-ranges)| Only include messages sent after this date +||[--before](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#date-ranges) | Only include messages sent before this date +||[-p](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#partitioning) | Split output into partitions, each limited to this number of messages (e.g. 100) or file size (e.g. 10mb) +||[--filter](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Message-filters.md) | Special notation for filtering the messages that get included in the export +||[--media](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#Downloading-assets) | Download assets referenced by the export (user avatars, attached files, embedded images, etc.). Default: false +||[--reuse-media](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#Reuse-assets) | Reuse previously downloaded assets to avoid redundant requests. Default: false. +||[--dateformat](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#date-formats) | Date format used in output +||-h | Shows help text + +> Options with an asterisk (**\***) are required. The order of the options doesn't matter. + +This command exports all your Direct Messages. + + +## exportguild +||Option | Description +|-|------- | ------------- +|**\***|-g | [Server ID](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md#how-to-get-guild-id-or-guild-channel-id) +|**\***|[-t](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#basic-usage) | [Authorization token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md#how-to-get-user-token). Environment variable: `DISCORD_TOKEN` +||--parallel| Limits how many channels can be exported in parallel. Try to keep this number low so that your account doesn't get flagged. Default: 1 +||[-o](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#changing-the-output-filename) | Output file or directory path +||[-f](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#changing-the-format) | [Output file format](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#file-formats). Default: HtmlDark +||[--after](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#date-ranges)| Only include messages sent after this date +||[--before](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#date-ranges) | Only include messages sent before this date +||[-p](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#partitioning) | Split output into partitions, each limited to this number of messages (e.g. 100) or file size (e.g. 10mb) +||[--filter](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Message-filters.md) | Special notation for filtering the messages that get included in the export +||[--media](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#Downloading-assets) | Download assets referenced by the export (user avatars, attached files, embedded images, etc.). Default: false +||[--reuse-media](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#Reuse-assets) | Reuse previously downloaded assets to avoid redundant requests. Default: false. +||[--dateformat](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#date-formats) | Date format used in output +||-h | Shows help text + +> Options with an asterisk (**\***) are required. The order of the options doesn't matter. + +This command exports all channels of a Server. + +## exportall + +||Option | Description +|-|------- | ------------- +|**\***|[-t](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#basic-usage) | [Authorization token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md#how-to-get-user-token). Environment variable: `DISCORD_TOKEN` +||--include-dm | Include direct message channels. Default: true +||--parallel| Limits how many channels can be exported in parallel. Try to keep this number low so that your account doesn't get flagged. Default: 1 +||[-o](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#changing-the-output-filename) | Output file or directory path +||[-f](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#changing-the-format) | [Output file format](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#file-formats). Default: HtmlDark +||[--after](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#date-ranges)| Only include messages sent after this date +||[--before](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#date-ranges) | Only include messages sent before this date +||[-p](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#partitioning) | Split output into partitions, each limited to this number of messages (e.g. 100) or file size (e.g. 10mb) +||[--filter](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Message-filters.md) | Special notation for filtering the messages that get included in the export +||[--media](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#Downloading-assets) | Download assets referenced by the export (user avatars, attached files, embedded images, etc.). Default: false +||[--reuse-media](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#Reuse-assets) | Reuse previously downloaded assets to avoid redundant requests. Default: false. +||[--dateformat](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#date-formats) | Date format used in output +||-h | Shows help text + +> Options with an asterisk (**\***) are required. The order of the options doesn't matter. + +This command exports all accessible channels, including server channels and DMs. + +To exclude DMs, add the `--include-dm false` option: + +```powershell +dotnet DiscordChatExporter.Cli.dll exportall -t "mfa.Ifrn" --include-dm false +``` + +## channels +||Option | Description +|-|------- | ------------- +|**\***|-g| [Server ID](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md#how-to-get-guild-id-or-guild-channel-id) +|**\***|[-t](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#basic-usage) | [Authorization token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md#how-to-get-user-token). Environment variable: `DISCORD_TOKEN` +||-h | Shows help text + +> Options with an asterisk (**\***) are required. The order of the options doesn't matter. + +This command outputs the server channels in the following format: +`Channel ID | Channel Name` +To save the output to a file, run the command below. If the file already exists, it will be overwritten. +```powershell +dotnet DiscordChatExporter.Cli.dll channels -t "mfa.Ifrn" -g 21814 > C:\path\to\output.txt +``` + +## dm +||Option | Description +|-|------- | ------------- +|**\***|[-t](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#basic-usage) | [Authorization token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md#how-to-get-user-token). Environment variable: `DISCORD_TOKEN` +||-h | Shows help text + +> Options with an asterisk (**\***) are required. The order of the options doesn't matter. + +This command outputs the list of Direct Messages. +To save the output to a file, run the command with `> C:\path\…` like the example below. If the file already exists, it will be overwritten. +```powershell +dotnet DiscordChatExporter.Cli.dll dm -t "mfa.Ifrn" > C:\path\to\output.txt +``` + + +## guilds +||Option | Description +|-|------- | ------------- +|**\***|[-t](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#basic-usage) | [Authorization token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md#how-to-get-user-token). Environment variable: `DISCORD_TOKEN` +||-h | Shows help text + +> Options with an asterisk (**\***) are required. The order of the options doesn't matter. + +This command outputs a list of your Server List. +To save the output to a file, run the command with `> C:\path\…` like the example below. If the file already exists, it will be overwritten. +```powershell +dotnet DiscordChatExporter.Cli.dll guilds -t "mfa.Ifrn" > C:\path\to\output.txt +``` + +## guide +This command explains [how to get your token, guild, and channel IDs](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md). + +# File formats + +## HTML + +![](https://i.imgur.com/S7lBTkV.png) +The HTML format replicates Discord's interface, making it the most user-friendly option. +It's the best format for attachment preview and sharing. +You can open `.html` files with a web browser, such as Google Chrome. +> Please note that if a picture is deleted, or if a user changes its avatar, the respective images will no longer be displayed. +Export using the "Download referenced assets" (`--media`) option to avoid this. + +## Plain Text + + + +The Plain Text format is the best option for archiving due to its small size. +You can open `.txt` files with a text editor, such as Notepad. + +## JSON + + + +The JSON format contains more technical information and is easily parsable. +You can open `.json` files with a text editor, such as Notepad. + +## CSV + +![](https://i.imgur.com/VEVUsKs.png) +![](https://i.imgur.com/1vPmQqQ.png) + +The CSV format allows for easy parsing of the chat log. Depending on your needs, the JSON format might be better. +You can open `.csv` files with a text editor, such as Notepad, or a spreadsheet app, like Microsoft Excel and Google Sheets. + +**([Back to top](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#getting-started))** + +# +Further reading: [.NET date formats](https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings) +Special thanks to [@Yudi](https://github.com/Yudi) \ No newline at end of file diff --git a/.docs/Install-.NET-Core-runtime.md b/.docs/Install-.NET-Core-runtime.md new file mode 100644 index 0000000..67f9f5a --- /dev/null +++ b/.docs/Install-.NET-Core-runtime.md @@ -0,0 +1,64 @@ +# Install .NET Core runtime + +**.NET v7.0 Runtime** is required by **DiscordChatExporter v2.37 and newer**. +If you are using GUI flavor of DiscordChatExporter, the runtime will be installed automatically (since v2.27.1). +If you are using the CLI from Docker, installing the runtime on the host machine is not needed. + +* Install + * [Windows and macOS](#windows-and-macos) + * [Linux](#linux) + * [Docker](#docker) +* [Verify installation](#Verify-installation-optional) + +## Windows and macOS + +**Download from the direct links:** + * [.NET v7.0 Runtime for **Windows x64**](https://dotnet.microsoft.com/download/dotnet/thank-you/runtime-desktop-7.0.1-windows-x64-installer) + * [.NET v7.0 Runtime for **Windows x86**](https://dotnet.microsoft.com/download/dotnet/thank-you/runtime-desktop-7.0.1-windows-x86-installer) + * [.NET v7.0 Runtime for **Macs with Apple silicon**](https://dotnet.microsoft.com/download/dotnet/thank-you/runtime-7.0.1-macos-arm64-installer) + * [.NET v7.0 Runtime for **Macs with an Intel processor**](https://dotnet.microsoft.com/download/dotnet/thank-you/runtime-7.0.1-macos-x64-installer) + + +> 💡 [How can I tell if my computer is running a 32-bit (x86) or a 64-bit (x64) version of Windows?](https://support.microsoft.com/help/15056/windows-32-64-bit-faq) +💡 [Is my Mac using an Intel processor or Apple silicon?](https://support.apple.com/HT211814) + +**Otherwise:** +[Check out the latest version in this page](https://dotnet.microsoft.com/download/dotnet/7.0). +Look for the download link in the '**.NET Runtime**' section, under **Installers**: + +[![](https://i.imgur.com/t3PB3NC.png)](https://dotnet.microsoft.com/download/dotnet/7.0) + +## Linux + +**You only need to install .NET Core Runtime v7.0** + +Check out the instructions for your distro: +* [Ubuntu](https://docs.microsoft.com/dotnet/core/install/linux-ubuntu#supported-distributions) +* [Debian](https://docs.microsoft.com/dotnet/core/install/linux-debian#supported-distributions) +* [Fedora](https://docs.microsoft.com/dotnet/core/install/linux-fedora#supported-distributions) + +For other distros, please check the _'Install on Linux'_ menu on the left of [this page](https://docs.microsoft.com/dotnet/core/install/linux). + +## Docker +Installing .NET Runtime is not needed. Please refer to the [Docker usage instructions](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Linux-usage-instructions.md) page for more information. + + + +## Verify installation (optional) + +You can check which version of **.NET Core** is installed by following these instructions: +#### Step 1 +**Windows:** Open Command Prompt (aka `cmd`) +**macOS and Linux:** Open `Terminal` +#### Step 2 +Run: `dotnet --info` +If **.NET Core Runtime** is correctly installed, the command will output the following: + +``` +... + +.NET runtimes installed: + Microsoft.NETCore.App 7.0.x [C:\path\to\dotnet\shared\Microsoft.NETCore.App] + Microsoft.WindowsDesktop.App 7.0.x [C:\path\to\dotnet\shared\Microsoft.WindowsDesktop.App] +... +``` \ No newline at end of file diff --git a/.docs/Linux-usage-instructions.md b/.docs/Linux-usage-instructions.md new file mode 100644 index 0000000..f5ca587 --- /dev/null +++ b/.docs/Linux-usage-instructions.md @@ -0,0 +1,16 @@ +# Linux usage instructions + +### Step 1: Install .NET Core Runtime +Please follow the [instructions provided here](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Install-.NET-Core-runtime.md). + +### Step 2: Downloading and using DiscordChatExporter.Cli +**1.** Download [DiscordChatExporter.CLI.zip](https://github.com/Tyrrrz/DiscordChatExporter/releases/latest) and extract it to a folder.
+**2.** Open Terminal.
+**3.** `cd` into the extracted folder. You can do this in Terminal by typing `cd`, then press the SPACE key, drag and drop the extracted folder into the Terminal window, and press the ENTER key.
+**4.** Replace `TOKEN` and `CHANNEL`, then execute this command to export: +``` +dotnet DiscordChatExporter.Cli.dll export -t TOKEN -c CHANNEL +``` +> 💡 Tip: [How to get Token and Channel IDs](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md). + +There's much more you can do with DCE.CLI! Read the [CLI explained](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#dcecli-commands-) page to get started. \ No newline at end of file diff --git a/.docs/Message-filters.md b/.docs/Message-filters.md new file mode 100644 index 0000000..d2af451 --- /dev/null +++ b/.docs/Message-filters.md @@ -0,0 +1,115 @@ +# Message filters + +You can use a special notation to filter messages that you want to have included in an export. The notation syntax is designed to mimic Discord's search query syntax, but with additional capabilities. + +To configure a filter, specify it in advanced export parameters when using the GUI or by passing the `--filter` option when using the CLI. + +## Examples + +- Filter by user + +``` +from:Tyrrrz +``` + +- Filter by user (with discriminator) + +``` +from:Tyrrrz#1234 +``` + +- Filter by message content (allowed values: `link`, `embed`, `file`, `video`, `image`, `sound`) + +``` +has:image +``` + +- Filter by mentioned user (same rules apply as with `from:` filter) + +``` +mentions:Tyrrrz#1234 +``` + +- Filter by contained text (has word "hello" and word "world" somewhere in the message text): + +``` +hello world +``` + +- Filter by contained text (has the string "hello world" somewhere in the message text): + +``` +"hello world" +``` + +- Combine multiple filters ('and'): + +``` +from:Tyrrrz has:image +``` + +- Same thing but with an explicit operator: + +``` +from:Tyrrrz & has:image +``` + +- Combine multiple filters ('or'): + +``` +from:Tyrrrz | from:"96-LB" +``` + +- Combine multiple filters using groups: + +``` +(from:Tyrrrz | from:"96-LB") has:image +``` + +- Negate a filter: + +``` +-from:Tyrrrz | -has:image +``` + +- Negate a grouped filter: + +``` +-(from:Tyrrrz has:image) +``` + +- Escape special characters (`-` is escaped below so it's not parsed as negation operator): + +``` +from:96\-LB +``` + +## CLI Caveat + +When using the CLI and the specified filter starts with a negation (for example `-from:Tyrrrz`), you need to quote the value and prepend it with a space (i.e. `" -from:Tyrrrz"`). This prevents the beginning of the input from being incorrectly treated as a value passed to the `-f|--format` option. + +In other words, this breaks: + +``` +DiscordChatExporter.Cli export [...] --filter "-from:Tyrrrz" +``` + +This works (note the space): + +``` +DiscordChatExporter.Cli export [...] --filter " -from:Tyrrrz" +``` + +Additionally, when using the CLI, it's recommended to use single quotes for contingent string of characters rather than double quotes (so it doesn't collide with the double quotes used as escaping mechanism in terminals). E.g.: + +This breaks: + +``` +DiscordChatExporter.Cli export [...] --filter "from:"Some name with spaces"" +``` + +This works: + +``` +DiscordChatExporter.Cli export [...] --filter "from:'Some name with spaces'" +``` \ No newline at end of file diff --git a/.docs/Obtaining-Token-and-Channel-IDs.md b/.docs/Obtaining-Token-and-Channel-IDs.md new file mode 100644 index 0000000..c68f816 --- /dev/null +++ b/.docs/Obtaining-Token-and-Channel-IDs.md @@ -0,0 +1,275 @@ +# Obtaining Token and Channel IDs + +# → DO NOT SHARE YOUR TOKEN ← +**Only scan QR codes taken directly from your browser.** + +A token gives full access to an account. +To reset a user token, change your account password. +To reset a bot token, click on "[Regenerate](#how-to-get-a-bot-token)". + +# +**Index** +* How to get a User Token + * [In Chrome](#in-chrome) + * [In Firefox](#in-firefox) + * Through the desktop app + * [By editing the settings file](#by-editing-the-settings-file) + * [Via settings menu (BetterDiscord only)](#via-settings-menu-betterdiscord-only) +* [How to get a Bot Token](#how-to-get-a-bot-token) +* [How to get Server IDs and Server Channel IDs](#how-to-get-a-server-id-or-a-server-channel-id) +* [How to get a Direct Message Channel ID](#how-to-get-a-direct-message-channel-id) + +# + +### How to get a User Token + +**Caution:** [Automating user accounts violates Discord's terms of service](https://support.discord.com/hc/en-us/articles/115002192352-Automated-user-accounts-self-bots-) and may result in account termination. Use at your own risk. + +#### Through your web browser + +Prerequisite step: Navigate to [discord.com](https://discord.com) and login. + +##### In Chrome + +###### Using the network monitor + +1. Press Ctrl+Shift+I (⌥+⌘+I on macOS). Chrome's [DevTools](https://developer.chrome.com/docs/devtools/overview) tools will display. + +
+
+ +2. Click the `Network` tab. The [network panel](https://developer.chrome.com/docs/devtools/overview/#network) will open + +
+
+ +3. Press F5. The page will reload, and the network log (the lower half of the network panel) will display several entries. + +
+
+ +4. Click the text box labelled `Filter` and type `library`. The entries will filter down to a single entry named `library`. + +
+
+ +5. Click the entry named `library`. A panel will open to the right and display details about the entry. Click the `Headers` tab if it isn't already active. + +
+
+ +6. Scroll through the contents of the `Headers` tab until you find an entry beginning with `authorization:`. + +
+
+ +7. Right-click the entry and click `copy value`. + +
+
+ +###### Using the storage inspector + +1. Press Ctrl+Shift+I (⌥+⌘+I on macOS). Chrome's [DevTools](https://developer.chrome.com/docs/devtools/overview/) will display. + +
+
+ +2. Press Ctrl+Shift+M (⌘+Shift+M). Chrome will enter [Device Mode](https://developer.chrome.com/docs/devtools/device-mode/), and the webpage will display as if on a mobile device. + +
+
+ +3. If necessary, click the `»` at the right end of the tab bar, and click `Application`. The [application panel](https://developer.chrome.com/docs/devtools/overview/#application) will display. + +
+
+ +4. In the menu to the right, under `Storage`, expand `Local Storage` if necessary, then click `https://discord.com`. The pane to the right will display a list of key-value pairs. + +
+
+ +5. In the text box marked `Filter`, type `token`. The entries will filter down to those containing the string `token`. + +
+
+ +6. Click the `token` entry. (Note: if the token doesn't display, try refreshing by pressing F5 or ⌘+R on macOS) + +
+
+ +7. Click the text box at the bottom, press Ctrl+A (⌘+A on macOS) then Ctrl+C (⌘+C on macOS) to copy the value to your clipboard. + +
+
+ +##### In Firefox + +###### Using the network monitor + +1. Press Ctrl+Shift+E (⌥+⌘+E on macOS). Firefox’s [web developer tools](https://firefox-source-docs.mozilla.org/devtools-user/) will display at the bottom of the window, and the [network monitor](https://firefox-source-docs.mozilla.org/devtools-user/network_monitor/) will display. + +
+
+ +2. Press F5. The page will reload, and the [network request list](https://firefox-source-docs.mozilla.org/devtools-user/network_monitor/request_list/index.html) will populate with entries. + +
+
+ +3. Type `library` into the filter. The network request list will filter out any entries not containing the string `library`. + +
+
+ +4. Click `library`. The [network request details pane](https://firefox-source-docs.mozilla.org/devtools-user/network_monitor/request_details/index.html) will display. The [headers tab](https://firefox-source-docs.mozilla.org/devtools-user/network_monitor/request_details/index.html#network-monitor-request-details-headers-tab) should be active by default. If it isn’t, click it. + +
+
+ +5. Type `authorization` into the text box labelled `Filter Headers`. + +
+
+ +6. Scroll down until you see an entry labeled [authorization](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization) under `Request Headers`. + +
+
+ +7. Right-click the entry labeled `authorization` and select `copy value`. + +
+
+ +###### Using the storage inspector + +1. Press Shift+F9. Firefox’s [web developer tools](https://firefox-source-docs.mozilla.org/devtools-user/) will display at the bottom of the window, and the [storage](https://firefox-source-docs.mozilla.org/devtools-user/storage_inspector/index.html) panel will be selected. + +
+
+ +2. Press Ctrl+Shift+M (⌥+⌘+M on macOS). Firefox will toggle [responsive design mode](https://firefox-source-docs.mozilla.org/devtools-user/responsive_design_mode/), and the web page will display as if on a mobile device. (Note: Discord may steal focus and respond to the command by toggling mute. If this happens, return focus to Firefox’s web developer tools by clicking somewhere in it, then try the command again.) + +
+
+ +3. In the [storage tree](https://firefox-source-docs.mozilla.org/devtools-user/storage_inspector/index.html#storage-inspector-storage-tree) (the list on the left side of the web developer tools panel), click [Local Storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage). The entry will expand, and the entry `https://discord.com` will display beneath it. + +
+
+ +4. In the storage tree, click `https://discord.com`. The [table widget](https://firefox-source-docs.mozilla.org/devtools-user/storage_inspector/index.html#storage-inspector-table-widget) to the right of the storage tree will display several key-value pairs. + +
+
+ +5. In the text box labelled `Filter items` at the top of the table widget, enter `token`. The table will now only display entries containing the string `token`. + +
+
+ +6. Click the entry `token`. The [sidebar](https://firefox-source-docs.mozilla.org/devtools-user/storage_inspector/index.html#storage-inspector-sidebar) will display. (Note: If the token doesn’t display, try refreshing by pressing F5.) + +
+
+ +7. Right-click the single entry in the sidebar and select `copy`. + +
+
+ +#### Through the desktop app / Enabling web developer tools + +##### By editing the settings file + +1. If Discord is running, exit the application by right-clicking the icon in your taskbar tray and clicking `Quit Discord`. + +2. Open Discord's settings file in your preferred text editor. See the following table for help finding it: + + | OS | Stable | Canary | Public Test Build (PTB) | + |---------|-------------------------------------------------------|-------------------------------------------------------------|----------------------------------------------------------| + | Windows | `%APPDATA%\discord\settings.json` | `%APPDATA%\discordcanary\settings.json` | `%APPDATA%\discordptb\settings.json` | + | macOS | `~/Library/Application Support/discord/settings.json` | `~/Library/Application Support/discordcanary/settings.json` | `~/Library/Application Support/discordptb/settings.json` | + | Linux | `~/.config/discord/settings.json` | `~/.config/discordcanary/settings.json` | `~/.config/discordptb/settings.json` | + + If you use BetterDiscord, use the following table instead: + + | OS | Stable | Canary | Public Test Build (PTB) | + |---------|-------------------------------------------------------------------------|-------------------------------------------------------------------------|----------------------------------------------------------------------| + | Windows | `%APPDATA%\BetterDiscord\data\stable\settings.json` | `%APPDATA%\BetterDiscord\data\canary\settings.json` | `%APPDATA%\BetterDiscord\data\ptb\settings.json` | + | macOS | `~/Library/Application Support/BetterDiscord/data/stable/settings.json` | `~/Library/Application Support/BetterDiscord/data/canary/settings.json` | `~/Library/Application Support/BetterDiscord/data/ptb/settings.json` | + | Linux | `~/.config/BetterDiscord/data/stable/settings.json` | `~/.config/BetterDiscord/data/canary/settings.json` | `~/.config/BetterDiscord/data/ptb/settings.json` | + +3. Insert a blank line after the first curly bracket (`{`), add the text `"DANGEROUS_ENABLE_DEVTOOLS_ONLY_ENABLE_IF_YOU_KNOW_WHAT_YOURE_DOING": true,` to it, and save the file. Your file should resemble the following: + +```json +{ + "DANGEROUS_ENABLE_DEVTOOLS_ONLY_ENABLE_IF_YOU_KNOW_WHAT_YOURE_DOING": true, + "BACKGROUND_COLOR": "#202225", + "IS_MAXIMIZED": true +} +``` + +4. Launch Discord. + +5. To find your user token, continue [here](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md#in-chrome). + +##### Via settings menu (BetterDiscord only) + +1. Click the User Settings button (the gear icon to the right of your username). Discord’s settings page will open. + +
+
+ +2. In the sidebar to the left, click `Settings` under the `BetterDiscord` group. BetterDiscord’s settings page will display. + +
+
+ +3. In the main panel to the right, expand the `Developer Settings` group if necessary, and toggle `DevTools` to enabled. + +
+
+ +4. Press Esc. The settings page will close. + +5. To find your user token, continue [here](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md#in-chrome). + +### How to get a Bot Token +**1.** Go to [Discord developer portal](https://discord.com/developers/applications) +**2.** Open your Application's settings +**3.** Navigate to the **Bot** section on the left +**4.** Under **Token** click **Copy** + +**Important**: your bot needs to have **Message Content Intent** enabled for it to be able to read messages! + +![https://discord.com/developers/applications/](https://i.imgur.com/BdrrxlY.png) +*** + +### How to get a Server ID or a Server Channel ID +**1.** Open Discord Settings +**2.** Go to the **Advanced** section +**3.** Enable **Developer Mode** +**4.** Right click on the desired server or channel and click Copy ID + +### How to get a Direct Message Channel ID + +**1.** Click the three dots next to any message in the channel you want to export. +**2.** Paste the link into a text editor. +**3.** Copy the text in the highlighted part of the link. + +> E.g. in https꞉//discord.com/channels/@me/**189716987098470**/0985709387059874, you should copy **189716987098470** + +Make sure you're not copying the user's ID. + +**Alternatively, you can also:** +**1.** Open the desired direct message channel +**2.** Press Ctrl+Shift+I (⌥+⌘+I on macOS) on Discord to show developer tools +**3.** Navigate to the `Console` tab +**4.** Type `window.location.href` and press Enter +**5.** Copy the first long sequence of numbers inside the URL + +> E.g. in https꞉//discord.com/channels/@me/**84289740160**, you should copy **84289740160** diff --git a/.docs/Readme.md b/.docs/Readme.md new file mode 100644 index 0000000..d225779 --- /dev/null +++ b/.docs/Readme.md @@ -0,0 +1,38 @@ +# Home + +

+ +
+DiscordChatExporter can be used to export message history from a Discord channel to a file. +

+ +## Installation & Usage + +**Step 1:** [Get .NET Core Runtime](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Install-.NET-Core-runtime.md) (Required for CLI; Installed automatically for GUI; Not required in Docker) + +**Step 2:** [Windows](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#gui-or-cli) | [macOS](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/macOS-usage-instructions.md) | [Linux](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Linux-usage-instructions.md) | [Docker](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Linux-usage-instructions.md) + +**Step 3:** Getting Started: + * [Using the GUI](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#using-the-gui) + * [Using the CLI](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#using-the-cli) + * [File formats](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#file-formats) + +## Guides +* [How to get Token and Channel IDs](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md) +* [How to use message filters](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Message-filters.md) +* **Export Scheduling with CLI** + * [Windows](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Scheduling-exports-on-Windows.md) | [macOS](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Scheduling-exports-on-macOS.md) | [Linux](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Scheduling-exports-with-Cron.md) + +## Video tutorial + +- Video by [NoIntro Tutorials](https://youtube.com/channel/UCFezKSxdNKJe77-hYiuXu3Q) (using DiscordChatExporter GUI) + +[![Video tutorial](https://i.ytimg.com/vi/jjtu0VQXV7I/hqdefault.jpg)](https://youtube.com/watch?v=jjtu0VQXV7I) + +## FAQ & Troubleshooting +* [General questions](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md#general) +* [First steps help](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md#first-steps) +* [It's crashing/failing](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md#DCE-is-crashingfailing) +* [.NET Core Runtime is required](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md#net-core-runtime-is-required) +* [Errors](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md#errors) +* [**More help**](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md) \ No newline at end of file diff --git a/.docs/Scheduling-exports-on-Windows.md b/.docs/Scheduling-exports-on-Windows.md new file mode 100644 index 0000000..fca09bf --- /dev/null +++ b/.docs/Scheduling-exports-on-Windows.md @@ -0,0 +1,81 @@ +# Scheduling exports on Windows + +We'll be using [DiscordChatExporter CLI](https://github.com/Tyrrrz/DiscordChatExporter/releases/latest), PowerShell, and Task Scheduler. + +**1.** Open a text editor such as Notepad and paste: +```powershell +# Info: https://github.com/Tyrrrz/DiscordChatExporter/wiki + +$TOKEN = "tokenhere" +$CHANNEL = "channelhere" +$EXEPATH = "exefolderhere" +$FILENAME = "filenamehere" +$EXPORTDIRECTORY = "dirhere" +$EXPORTFORMAT = "formathere" +# Available export formats: PlainText, HtmlDark, HtmlLight, Json, Csv + +cd $EXEPATH + +.\DiscordChatExporter.Cli.exe export -t $TOKEN -c $CHANNEL -f $EXPORTFORMAT -o "$FILENAME.tmp" + +$Date = Get-Date -Format "yyyy-MM-dd-HH-mm" + +If($EXPORTFORMAT -match "PlainText"){mv "$FILENAME.tmp" -Destination "$EXPORTDIRECTORY\$FILENAME-$Date.txt"} +ElseIf($EXPORTFORMAT -match "HtmlDark"){mv "$FILENAME.tmp" -Destination "$EXPORTDIRECTORY\$FILENAME-$Date.html"} +ElseIf($EXPORTFORMAT -match "HtmlLight"){mv "$FILENAME.tmp" -Destination "$EXPORTDIRECTORY\$FILENAME-$Date.html"} +ElseIf($EXPORTFORMAT -match "Json"){mv "$FILENAME.tmp" -Destination "$EXPORTDIRECTORY\$FILENAME-$Date.json"} +ElseIf($EXPORTFORMAT -match "Csv"){mv "$FILENAME.tmp" -Destination "$EXPORTDIRECTORY\$FILENAME-$Date.csv"} +exit +``` + +**2.** Replace: + + `tokenhere` with your [Token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md) + + `channelhere` with a [Channel ID](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md) + + `exefolderhere` with the .exe **directory's path** (e.g. C:\Users\User\Desktop\DiscordChatExporter) + + `filenamehere` with a filename without spaces + + `dirhere` with the export directory (e.g. C:\Users\User\Documents\Exports) + + `formathere` with one of the available export formats + + Make sure not to delete the quotes (") + +**3.** Save the file as `filename.ps1` not `.txt` + +## Export at Startup + +**1.** Press Windows + R, type `shell:startup` and press ENTER + +**2.** Paste `filename.ps1` or a shortcut into this folder + + +## Scheduling with Task Scheduler + +Please notice your computer must be turned on so the exportation can occur. + +**1.** Press Windows + R, type `taskschd.msc` and press ENTER + +**2.** Select `Task Scheduler Library`, create a Basic Task, and follow the instructions on-screen + + + +[ ![](https://i.imgur.com/m2DKhA8.png) ](https://i.imgur.com/3gHkF0t.png) + +**3.** At 'Start a Program', write `powershell -file -ExecutionPolicy ByPass -WindowStyle Hidden "C:\path\to\filename.ps1"` in the Program/script text box + +![](https://i.imgur.com/FGtWRod.png) + +**4.** Click 'Yes' + +![](https://i.imgur.com/DuaRBt3.png) + +**5.** Click 'Finish' + +![](https://i.imgur.com/LHgXp9Q.png) + +# +Special thanks to [@Yudi](https://github.com/Yudi) \ No newline at end of file diff --git a/.docs/Scheduling-exports-on-macOS.md b/.docs/Scheduling-exports-on-macOS.md new file mode 100644 index 0000000..a38dd62 --- /dev/null +++ b/.docs/Scheduling-exports-on-macOS.md @@ -0,0 +1,271 @@ +# Scheduling exports on macOS + +Scheduling on macOS is a bit tricky, but it should work if you follow the instructions accordingly. + +Make sure you already have **DiscordChatExporter.CLI** and **.NET Core** properly installed ([instructions here](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/macOS-usage-instructions.md)). + +* [**1.** Creating the script](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Scheduling-exports-on-macOS.md#1-creating-the-script) +* [**2.** Creating the .plist file](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Scheduling-exports-on-macOS.md#2-creating-the-plist-file) + * [Export on System Boot/User Login](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Scheduling-exports-on-macOS.md#export-on-system-bootuser-login) + * [Export every _n_ seconds](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Scheduling-exports-on-macOS.md#export-every-n-seconds) + * [Export at a specific time and date](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Scheduling-exports-on-macOS.md#export-at-a-specific-time-and-date) +* [**3.** Loading the .plist into launchctl](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Scheduling-exports-on-macOS.md#3-loading-the-plist-into-launchctl) + + +## 1. Creating the script + +**1.** Open TextEdit.app and create a new file + +**2.** Convert the file to a plain text one in 'Format > Make Plain Text' (⇧⌘T) + +![](https://i.imgur.com/WXrTtXM.png) + +**3.** Paste the following into the text editor: +```bash +#!/bin/bash +# Info: https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs + +TOKEN=tokenhere +CHANNELID=channelhere +DLLFOLDER=dceFOLDERpathhere +FILENAME=filenamehere +EXPORTDIRECTORY=dirhere +EXPORTFORMAT=formathere +# Available export formats: plaintext, htmldark, htmllight, json, csv +# /\ CaSe-SeNsItIvE /\ +# You can edit the export command on line 43 if you'd like to include more options like date ranges and date format. You can't use partitioning (-p) with this script. + +# This variable specifies in which directories the executable programs are located. Don't change it. +PATH=/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/share/dotnet + +# This will verify if EXPORTFORMAT is valid and will set the final file extension according to it. If the format is invalid, the script will display a message and exit. +if [[ "$EXPORTFORMAT" == "plaintext" ]]; then +FORMATEXT=.txt +elif [[ "$EXPORTFORMAT" == "htmldark" ]] || [[ "$EXPORTFORMAT" == "htmllight" ]]; then +FORMATEXT=.html +elif [[ "$EXPORTFORMAT" == "json" ]]; then +FORMATEXT=.json +elif [[ "$EXPORTFORMAT" == "csv" ]]; then +FORMATEXT=.csv +else +echo "$EXPORTFORMAT - Unknown export format" +echo "Available export formats: plaintext, htmldark, htmllight, csv, json" +echo "/\ CaSe-SeNsItIvE /\\" +exit 1 +fi + +# This will change the script's directory to DLLPATH, if unable to do so, the script will exit. +cd $DLLFOLDER || exit 1 + +# This will export your chat +dotnet DiscordChatExporter.Cli.dll export -t $TOKEN -c $CHANNELID -f $EXPORTFORMAT -o $FILENAME.tmp + +# This sets the current time to a variable +CURRENTTIME=$(date +"%Y-%m-%d-%H-%M-%S") + +# This will move the .tmp file to the desired export location. If unable to do so, it will attempt to delete the .tmp file. +if ! mv "$FILENAME.tmp" "${EXPORTDIRECTORY//\"}/$FILENAME-$CURRENTTIME$FORMATEXT" ; then +echo "Unable to move $FILENAME.tmp to $EXPORTDIRECTORY/$FILENAME-$CURRENTTIME$FORMATEXT." +echo "Cleaning up..." + if ! rm -Rf "$FILENAME.tmp" ; then + echo "Unable to remove $FILENAME.tmp." + fi +exit 1 +fi +exit 0 +``` + +**4.** Replace: + `tokenhere` with your [Token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md) + + `channelhere` with a [Channel ID](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md) + + `dceFOLDERpathhere` with DCE's **directory's path** (e.g. `/Users/user/Desktop/DiscordChatExporterFolder`, NOT `/Users/user/Desktop/DiscordChatExporterFolder/DiscordChatExporter.DLL`) + + `filenamehere` with the exported channel's filename, without spaces + + `dirhere` with the directory you want the files to be saved at (e.g. `/Users/user/Documents/Discord\ Exports`) + + `formathere` with one of the available export formats + + + +To quickly get file or folder paths, select the file/folder, then hit Command+I (⌘I) and copy what's after `Where:`. +After copying and pasting, make sure the file/folder name is not missing. If a folder has spaces in its name, add `\` before the spaces, like in the example below: +* `Discord\ Exports` - Wrong ✗ +* `/Users/user/Documents` - Wrong ✗ +* `/Users/user/Documents/Discord Exports` - Wrong ✗ +* `/Users/user/Documents/Discord\ Exports/DCE.Cli.dll` - Wrong ✗ +* `/Users/user/Documents/Discord \Exports` - Wrong ✗ +* `/Users/user/Documents/Discord\ Exports` - Correct ✓ +* `/Users/user/Desktop/DiscordChatExporter` - Correct ✓ + +![](https://i.imgur.com/29u6Nyx.png) + + + +**5.** Save the file as `filename.sh`, not `.txt` + +**6.** Open Terminal.app, type `chmod +x`, press the SPACE key, then drag & drop the `filename.sh` into the Terminal window and hit RETURN. You may be prompted for your password, and you won't be able to see it as you type. + +## 2. Creating the .plist file +Open TextEdit, make a Plain Text (⇧⌘T) and then paste the following into it: +```xml + + + + + Label + local.discordchatexporter + Program + /path/to/filename.sh + REPLACEME + + +``` +* The `Label` string is the name of the export job, it must be something unique. Replace the `local.discordchatexporter` between the `` with another name if you'd like to run more than one script. + +* The `Program` string is the path to the script. Replace `/path/to/filename.sh` between the `` with the path of the previously created script. + +* Replace the `REPLACEME` with the content presented in the following sections according to when you want to export. + +When you're done, save the file with the same name as the `Label` and with the `.plist` extension (not `.txt`), like `local.discordchatexporter.plist`. + +### Exporting on System Boot/User Login + +```xml +RunAtLoad + +``` + +### Export every _n_ seconds + +The following example is to export every 3600 seconds (1 hour), replace the integer value with your desired time: + +```xml +StartInterval +3600 +``` + +### Export at a specific time and date + +```xml +StartCalendarInterval + + Weekday + 0 + Month + 0 + Day + 0 + Hour + 0 + Minute + 0 + +``` + +Key | Integer +------------ | ------------- +**Month** | 1-12 +**Day** | 1-31 +**Weekday** | 0-6 (0 is Sunday) +**Hour** | 0-23 +**Minute** | 0-59 + +**Sunday** - 0; **Monday** - 1; **Tuesday** - 2; **Wednesday** - 3; **Thursday** - 4; **Friday** - 5; **Saturday** - 6 + +Replace the template's `0`s according to the desired times. + +You can delete the ``s you don't need, don't forget to remove the `0` under it. +Omitted keys are interpreted as wildcards, for example, if you delete the Minute key, the script will run at every minute, delete the Weekday key and it'll run at every weekday, and so on. + +Be aware that if you set the day to '31', the script will only run on months that have the 31st day. + +**Check the examples below ([or skip to step 3 (loading the file)](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Scheduling-exports-on-macOS.md#3-loading-the-plist-into-launchctl)):** + +Export everyday at 5:15 PM: + +```xml +StartCalendarInterval + + Hour + 17 + Minute + 15 + + +``` + +Every 15 minutes of an hour (xx:15): + +```xml +StartCalendarInterval + + Minute + 15 + + +``` + +Every Sunday at midnight and every Wednesday full hour (xx:00). Notice the inclusion of `` and `` to allow multiple values: + +```xml +StartCalendarInterval + + + Weekday + 0 + Hour + 00 + Minute + 00 + + + Weekday + 3 + Minute + 00 + + +``` + +## 3. Loading the .plist into launchctl + +**1.** Copy your `filename.plist` file to one of these folders according to how you want it to run: + +* `~/Library/LaunchAgents` runs as the current logged-in user. + +* `/Library/LaunchDaemons` runs as the system "_administrator_" (root). + +* If macOS has a single user: + * If you want to export only when the user is logged in, choose the first one. + * If you want the script to always run on System Startup, choose the second one. +* If macOS has multiple users: + * If you want the script to run only when a certain user is logged in, choose the first one. + * If you want the script to always run on System Startup, choose the second one. + +To quickly go to these directories, open Finder and press Command+Shift+G (⌘⇧G), then paste the path into the text box. + +**2.** To load the job into launchctl, in Terminal, type `launchctl load`, press SPACE, drag and drop the `.plist` into the Terminal window, then hit RETURN. It won't output anything if it was successfully loaded. + +### Extra launchctl commands + +**Unloading a job** +``` +launchctl unload /path/to/Library/LaunchAgents/local.discordchatexporter.plist +``` + +**List every loaded job** +``` +launchctl list +``` + +**Check if a specific job is enabled** +You can also see error codes (2nd number) by running this command. +``` +launchctl list | grep local.discordchatexporter +``` +# +Further reading: [Script management with launchd in Terminal on Mac](https://support.apple.com/guide/terminal/script-management-with-launchd-apdc6c1077b-5d5d-4d35-9c19-60f2397b2369/mac) and [launchd.info](https://launchd.info/). +Special thanks to [@Yudi](https://github.com/Yudi) \ No newline at end of file diff --git a/.docs/Scheduling-exports-with-Cron.md b/.docs/Scheduling-exports-with-Cron.md new file mode 100644 index 0000000..bf6ecee --- /dev/null +++ b/.docs/Scheduling-exports-with-Cron.md @@ -0,0 +1,122 @@ +# Scheduling exports with Cron + +Make sure you already have **DiscordChatExporter.CLI** and **.NET Core** properly installed ([instructions here](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Linux-usage-instructions.md)). + +You can use Cron on macOS, but [this method](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Scheduling-exports-on-macOS.md) is preferred. + +# + +**1.** Open Terminal and create a new text file with `nano /path/to/DiscordChatExporter/cron.sh`
+> For beginners: You can't use your mouse in nano, use the arrow keys to control the cursor (caret). + +**2.** Paste the following into the text file: + +```bash +#!/bin/bash +# Info: https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs + +TOKEN=tokenhere +CHANNELID=channelhere +DLLFOLDER=dceFOLDERpathhere +FILENAME=filenamehere +EXPORTDIRECTORY=dirhere +EXPORTFORMAT=formathere +# Available export formats: plaintext, htmldark, htmllight, json, csv +# /\ CaSe-SeNsItIvE /\ +# You can edit the export command on line 40 if you'd like to include more options like date ranges and date format. You can't use partitioning (-p) with this script. + +# This will verify if EXPORTFORMAT is valid and will set the final file extension according to it. If the format is invalid, the script will display a message and exit. +if [[ "$EXPORTFORMAT" == "plaintext" ]]; then +FORMATEXT=.txt +elif [[ "$EXPORTFORMAT" == "htmldark" ]] || [[ "$EXPORTFORMAT" == "htmllight" ]]; then +FORMATEXT=.html +elif [[ "$EXPORTFORMAT" == "json" ]]; then +FORMATEXT=.json +elif [[ "$EXPORTFORMAT" == "csv" ]]; then +FORMATEXT=.csv +else +echo "$EXPORTFORMAT - Unknown export format" +echo "Available export formats: plaintext, htmldark, htmllight, csv, json" +echo "/\ CaSe-SeNsItIvE /\\" +exit 1 +fi + +# This will change the script's directory to DLLPATH, if unable to do so, the script will exit. +cd $DLLFOLDER || exit 1 + +# This will export your chat +dotnet DiscordChatExporter.Cli.dll export -t $TOKEN -c $CHANNELID -f $EXPORTFORMAT -o $FILENAME.tmp + +# This sets the current time to a variable +CURRENTTIME=$(date +"%Y-%m-%d-%H-%M-%S") + +# This will move the .tmp file to the desired export location, if unable to do so, it will attempt to delete the .tmp file. +if ! mv "$FILENAME.tmp" "${EXPORTDIRECTORY//\"}/$FILENAME-$CURRENTTIME$FORMATEXT" ; then +echo "Unable to move $FILENAME.tmp to $EXPORTDIRECTORY/$FILENAME-$CURRENTTIME$FORMATEXT." +echo "Cleaning up..." + if ! rm -Rf "$FILENAME.tmp" ; then + echo "Unable to remove $FILENAME.tmp." + fi +exit 1 +fi +exit 0 +``` + +**3.** Replace: + + `tokenhere` with your [Token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md). + + `channelhere` with a [Channel ID](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md). + + `dceFOLDERpathhere` with DCE's **directory path** (e.g. `/path/to/folder`, NOT `/path/to/folder/DiscordChatExporter.dll`). + + `filenamehere` with the exported channel's filename, without spaces. + + `dirhere` with the export directory (e.g. /home/user/Documents/Discord\ Exports). + + `formathere` with one of the available export formats. + +**Remember to escape spaces** (add `\` before them) or to quote (") the paths (`"/home/my user"`)!
+ +> For beginners: To save, hold down CTRL and then press O, if asked for a filename, type it and press ENTER. Hit CTRL+X to exit the text editor.
+[Check out this page](https://wiki.gentoo.org/wiki/Nano/Basics_Guide) if you want to know more about nano. + +**4.** Make your script executable with `chmod +x /path/to/DiscordChatExporter/cron.sh` + +**5.** Let's edit the cron file. If you want to run the script with your user privileges, edit it by running `crontab -e`. If you want to run the script as root, edit it with `sudo crontab -e`.
+If this is your first time running this command, you might be asked to select a text editor. Nano is easier for beginners. + +**6.** Add the following to the end of the file `* * * * * /path/to/DiscordChatExporter/cron.sh >/tmp/discordchatexporter.log 2>/tmp/discordchatexportererror.log`
+Don't forget to replace the `/path/to/DiscordChatExporter/cron.sh`! +> 💡 Tip: If you don't want logs to be created, replace both `/tmp/discordchatexporter.log` with `/dev/null` + +Then replace the *s according to: + +![](https://i.imgur.com/RY7USM6.png) + +# + +**Examples**
+If you want to execute the script at minute 15 of every hour: `15 * * * *`
+Every 30 minutes `*/30 * * * *`
+Everyday at midnight `0 0 * * *`
+Everyday at noon `0 12 * * *`
+Everyday at 3, 4 and 6 PM `0 15,16,18 * * *`
+Every Wednesday at 9 AM `0 9 * * 3` + +Verify your cron time [here](https://crontab.guru). + +# +**Extra information** + +The week starts on Sunday. 0 = SUN, 1 = MON ... 7 = SUN. + +Be aware that if you set the day to '31', the script will only run on months that have the 31st day. +> 💡 Tip: [Learn more about running a cron job on the last day of the month here](https://stackoverflow.com/questions/6139189/cron-job-to-run-on-the-last-day-of-the-month) (expert). + +The default filename for the exported channel is `YYYY-MM-DD-hh-mm-ss-yourfilename`. You can change it if you'd like. + +Don't forget to update your token in the script after it has been reset! + +# +Special thanks to [@Yudi](https://github.com/Yudi) \ No newline at end of file diff --git a/.docs/Troubleshooting.md b/.docs/Troubleshooting.md new file mode 100644 index 0000000..01d7656 --- /dev/null +++ b/.docs/Troubleshooting.md @@ -0,0 +1,153 @@ +# Troubleshooting + +Welcome to the Frequently Asked Questions (FAQ) and Troubleshooting page! +Here you'll find the answers to most of the questions related to **DiscordChatExporter** (DCE for short) and its core features. + +❓ If you still have unanswered questions _after_ reading this page, feel free to [create a new discussion](https://github.com/Tyrrrz/DiscordChatExporter/discussions/new). +🐞 If you have encountered a problem that's not described here, has not [been discussed before](https://github.com/Tyrrrz/DiscordChatExporter/discussions), and is not a [known issue](https://github.com/Tyrrrz/DiscordChatExporter/issues?q=is%3Aissue), please [create a new discussion](https://github.com/Tyrrrz/DiscordChatExporter/discussions/new) or [open a bug report](https://github.com/Tyrrrz/DiscordChatExporter/issues/new). +Don't forget to include your platform (Windows, Mac, Linux, etc.) and a detailed description of your question/problem. + +**Index** +* [**General questions**](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md#general) +* [**First steps**](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md#first-steps) + * [Token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md#i-cant-find-my-token) + * [Channel ID](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md#where-can-i-find-the-channel-ids) + * [Running the program in Mac/Linux](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md#how-do-i-run-DCE-on-mac-or-linux) + * [Scheduling exports (advanced)](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md#how-can-i-set-DCE-to-export-automatically-at-certain-times) + * [Exported chat crashes browser](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md#the-file-is-too-big-i-cant-open-it) + * [DCE is crashing/failing](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md#DCE-is-crashingfailing) + * [.NET Core Runtime is required](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md#net-core-runtime-is-required) +* [**CLI help**](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md#cli) + * [Errors](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md#errors) + +# General + +### Token stealer? +No. That's why this kind of software needs to be open-source, so the code can be audited by anyone. +Your token is only used to connect to Discord's API, it's not sent anywhere else. +If you're using the GUI, be aware that your token will be saved to a plain text file unless you disable it in the settings menu. + +### Why should I be worried about the safety of my token? +A token can be used to log into your account, so treat it like a password and never share it. + +### How can I reset my token? +Follow the [instructions here](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md). + +### Will I get banned if I use this? +Automating user accounts is technically against [TOS](https://discord.com/terms), use at your discretion. [Bot accounts](https://discord.com/developers/docs/topics/oauth2#bots) don't have this restriction. + +### Will the messages disappear from the exported file if I delete a message, delete my account or block a person? +Text messages will not be removed from the exported file, but if media, such as images and user avatars, is changed or deleted, it will no longer be displayed. To avoid this, export using the "Download media" (`--media`) option. + +### Can DCE export messages that have already been deleted? +No, DCE cannot access them since they have been permanently deleted from Discord's servers. + +### Can DCE export private chats? +Yes, if your account has access to them. + +### Can DCE download images? +Yes, and other media too. Export using the "Download media" (`--media`) option. + +### Can the exported chats be shared? +Yes. + +### Can DCE recreate the exported chats in Discord? +No, DCE is an exporter. + +### Can DCE reupload exported messages to another channel? +No, DCE is an exporter. + +# First steps + +### How can I find my token? +Check the following page: [Obtaining token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md) + +### When I open DCE a black window pops up quickly or nothing shows up. +If you have [.NET Core Runtime correctly installed](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Install-.NET-Core-runtime.md), you might have downloaded DCE.CLI, try [downloading the GUI](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#gui-or-cli) instead. + +### I can't open DCE. It sends me to a Visual Studio webpage. +Check the following page: +[Installation and usage](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Readme.md#installation--usage) + +### How do I run DCE on macOS or Linux? +Check the following pages: + * [macOS usage instructions](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/macOS-usage-instructions.md) + * [Linux usage instructions](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Linux-usage-instructions.md) + +### How can I set DCE to export automatically at certain times? +Check the following pages to learn how to schedule **DiscordChatExporter.CLI** runs (advanced): +* [Windows scheduling](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Scheduling-exports-on-Windows.md) +* [macOS scheduling](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Scheduling-exports-on-macOS.md) +* [Linux scheduling](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Scheduling-exports-with-Cron.md) + +### The exported file is too large, I can't open it! +Try opening it with a different program, try partitioning or use a different file format, like `PlainText`. + +### DCE is crashing/failing. +Check the following page: [Installing .NET Core Runtime](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Install-.NET-Core-runtime.md) + +If you already have .NET Core installed, please check if your problem is a [known issue](https://github.com/Tyrrrz/DiscordChatExporter/issues?q=is%3Aissue) before [opening a bug report](https://github.com/Tyrrrz/DiscordChatExporter/issues/new). + +### .NET Core Runtime is required. +Check the following page: [Installing .NET Core Runtime](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Install-.NET-Core-runtime.md) + +# CLI + +### How do I use the CLI? +Check the following page: +* [Using the CLI](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#using-the-cli) + +If you're using **Docker**, please refer to the [Docker Usage Instructions](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Linux-usage-instructions.md) instead. + +### Where can I find the 'Channel IDs'? +Check the following page: + * [Obtaining Channel IDs](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md) + +### I can't find Docker exported chats +Check the following page: +* [Docker usage instructions](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Linux-usage-instructions.md#file-output) + +### I can't export Direct Messages +Make sure you're [copying the DM Channel ID](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md#how-to-get-a-direct-message-channel-id), not the person's user ID. + +### Errors + +``` +DiscordChatExporter.Domain.Exceptions.DiscordChatExporterException: Authentication token is invalid. +... +``` +↳ Make sure the provided token is correct. + + +``` +DiscordChatExporter.Domain.Exceptions.DiscordChatExporterException: Requested resource does not exist. +``` +↳ Check your channel ID, it might be invalid. [Read this if you need help](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md). + + +``` +DiscordChatExporter.Domain.Exceptions.DiscordChatExporterException: Access is forbidden. +``` +↳ This means you don't have access to the channel. + + +``` +The application to execute does not exist: +``` +↳ The `DiscordChatExporter.Cli.dll` file is missing. Keep the `.exe` and all the `.dll` files together. If you didn't move the files, try unzipping again. + +``` +System.Net.WebException: Error: TrustFailure ... Invalid certificate received from server. +... +``` +↳ Try running cert-sync. + +Debian/Ubuntu: `cert-sync /etc/ssl/certs/ca-certificates.crt` + +Red Hat: `cert-sync --user /etc/pki/tls/certs/ca-bundle.crt` + +If it still doesn't work, try mozroots: `mozroots --import --ask-remove` + +*** +❓ If you still have unanswered questions, feel free to [create a new discussion](https://github.com/Tyrrrz/DiscordChatExporter/discussions/new). +🐞 If you have encountered a problem that's not described here, has not [been discussed before](https://github.com/Tyrrrz/DiscordChatExporter/discussions), and is not a [known issue](https://github.com/Tyrrrz/DiscordChatExporter/issues?q=is%3Aissue), please [create a new discussion](https://github.com/Tyrrrz/DiscordChatExporter/discussions/new) or [open a bug report](https://github.com/Tyrrrz/DiscordChatExporter/issues/new). \ No newline at end of file diff --git a/.docs/macOS-usage-instructions.md b/.docs/macOS-usage-instructions.md new file mode 100644 index 0000000..fb7da39 --- /dev/null +++ b/.docs/macOS-usage-instructions.md @@ -0,0 +1,18 @@ +# macOS usage instructions + +![Might look different depending on your macOS version](https://i.imgur.com/gA8jFjJ.png) + +### Step 1: Install .NET Core Runtime +Please follow the [instructions provided here](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Install-.NET-Core-runtime.md). + +### Step 2: Downloading and using DiscordChatExporter.Cli +**1.** Download [DiscordChatExporter.CLI.zip](https://github.com/Tyrrrz/DiscordChatExporter/releases/latest) and extract it to a folder.
+**2.** Search for `Terminal.app` in Spotlight (⌘+SPACE), then open it.
+**3.** In the Terminal window, type `cd` , press the SPACE key, then drag and drop the extracted folder into the window, then press the RETURN key.
+**4.** Execute the following command to export, replacing `TOKEN` and `CHANNEL` with your own values: + + dotnet DiscordChatExporter.Cli.dll export -t TOKEN -c CHANNEL + +> 💡 Tip: [How to get Token and Channel IDs](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Obtaining-Token-and-Channel-IDs.md). + +There's much more you can do with DCE.CLI! Read the [CLI explained](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/GUI%2C-CLI-and-Formats-explained.md#dcecli-commands-) page to get started. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index bbeac8d..112f950 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -6,8 +6,8 @@ contact_links: - name: 💬 Discord server url: https://discord.gg/2SUWKFnHSm about: Chat with the project community. - - name: 📖 Wiki - url: https://github.com/Tyrrrz/DiscordChatExporter/wiki + - name: 📖 Documentation + url: https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs about: Find usage guides and frequently asked questions. - name: 🗨 Discussions url: https://github.com/Tyrrrz/DiscordChatExporter/discussions/new diff --git a/DiscordChatExporter.Cli/Commands/GuideCommand.cs b/DiscordChatExporter.Cli/Commands/GuideCommand.cs index 673bc77..4e08d50 100644 --- a/DiscordChatExporter.Cli/Commands/GuideCommand.cs +++ b/DiscordChatExporter.Cli/Commands/GuideCommand.cs @@ -61,11 +61,11 @@ public class GuideCommand : ICommand console.Output.WriteLine(" 6. Copy the first long sequence of numbers inside the URL"); console.Output.WriteLine(); - // Wiki link + // Docs link using (console.WithForegroundColor(ConsoleColor.White)) - console.Output.WriteLine("If you have questions or issues, please refer to the wiki:"); + console.Output.WriteLine("If you have questions or issues, please refer to the documentation:"); using (console.WithForegroundColor(ConsoleColor.DarkCyan)) - console.Output.WriteLine("https://github.com/Tyrrrz/DiscordChatExporter/wiki"); + console.Output.WriteLine("https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs"); return default; } diff --git a/DiscordChatExporter.Gui/App.xaml.cs b/DiscordChatExporter.Gui/App.xaml.cs index f883b92..c16022b 100644 --- a/DiscordChatExporter.Gui/App.xaml.cs +++ b/DiscordChatExporter.Gui/App.xaml.cs @@ -17,7 +17,7 @@ public partial class App public static string GitHubProjectUrl { get; } = "https://github.com/Tyrrrz/DiscordChatExporter"; - public static string GitHubProjectWikiUrl { get; } = GitHubProjectUrl + "/wiki"; + public static string GitHubProjectDocsUrl { get; } = GitHubProjectUrl + "/blob/master/.docs"; } public partial class App diff --git a/DiscordChatExporter.Gui/ViewModels/Components/DashboardViewModel.cs b/DiscordChatExporter.Gui/ViewModels/Components/DashboardViewModel.cs index 8b18373..1b920c1 100644 --- a/DiscordChatExporter.Gui/ViewModels/Components/DashboardViewModel.cs +++ b/DiscordChatExporter.Gui/ViewModels/Components/DashboardViewModel.cs @@ -83,7 +83,7 @@ public class DashboardViewModel : PropertyChangedBase await _dialogManager.ShowDialogAsync(dialog); } - public void ShowHelp() => ProcessEx.StartShellExecute(App.GitHubProjectWikiUrl); + public void ShowHelp() => ProcessEx.StartShellExecute(App.GitHubProjectDocsUrl); public bool CanPopulateGuildsAndChannels => !IsBusy && !string.IsNullOrWhiteSpace(Token); diff --git a/DiscordChatExporter.Gui/Views/Components/DashboardView.xaml b/DiscordChatExporter.Gui/Views/Components/DashboardView.xaml index 780ce67..1be0769 100644 --- a/DiscordChatExporter.Gui/Views/Components/DashboardView.xaml +++ b/DiscordChatExporter.Gui/Views/Components/DashboardView.xaml @@ -225,7 +225,7 @@ - wiki + documentation diff --git a/Readme.md b/Readme.md index 8264f41..aa144b9 100644 --- a/Readme.md +++ b/Readme.md @@ -14,7 +14,7 @@ **DiscordChatExporter** is an application that can be used to export message history from any [Discord](https://discord.com) channel to a file. It works with direct messages, group messages, and server channels, and supports Discord's dialect of markdown as well as most other rich media features. -> ❔ If you have questions or issues, **please refer to the [wiki](https://github.com/Tyrrrz/DiscordChatExporter/wiki)**. +> ❔ If you have questions or issues, **please refer to the [docs](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs)**. > 💬 If you want to chat, **join my [Discord server](https://discord.gg/2SUWKFnHSm)**.