2.21 features: --media, new gui menu, updated screenshots

Yudi
2020-07-18 18:58:17 -03:00
parent f71edf2079
commit a947b68ac3

@@ -1,11 +1,11 @@
# Getting started # Getting started
Welcome to the getting started page!<br/> Welcome to the getting started page!<br>
Here you'll learn how to use every **DiscordChatExporter** (DCE for short) feature.<br/> Here you'll learn how to use every **DiscordChatExporter** (DCE for short) feature.<br>
For other things you can do with DCE, check out the [Guides](https://github.com/Tyrrrz/DiscordChatExporter/wiki#guides) section. For other things you can do with DCE, check out the [Guides](https://github.com/Tyrrrz/DiscordChatExporter/wiki#guides) section.
If you still have unanswered questions after reading this page or if you have encountered a problem, please check our [FAQ & Troubleshooting](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Troubleshooting) section.<br/> 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/wiki/Troubleshooting) section.<br>
> The information presented in this page is valid for **all** platforms. > The information presented in this page is valid for **all** platforms.
@@ -22,15 +22,15 @@ If you still have unanswered questions after reading this page or if you have en
# GUI or CLI? ↴ # GUI or CLI? ↴
![](https://i.imgur.com/n9RlhUY.png) ![](https://i.imgur.com/j9OTxRB.png)
**DCE** has two different versions: **DCE** has two different versions:
* **Graphical User Interface** (**GUI**) - it's the preferred version for newcomers as it provides ease of use.<br/> * **Graphical User Interface** (**GUI**) - it's the preferred version for newcomers as it provides ease of use.<br>
You can get it by [downloading](https://github.com/Tyrrrz/DiscordChatExporter/releases/latest) the `DiscordChatExporter.zip` file.<br/><br/> You can get it by [downloading](https://github.com/Tyrrrz/DiscordChatExporter/releases/latest) the `DiscordChatExporter.zip` file.<br><br>
* **Command Line Interface** (**CLI**) - offers greater flexibility and more features for advanced users, such as export scheduling, ID lists, and more specific date ranges.<br/> * **Command Line Interface** (**CLI**) - offers greater flexibility and more features for advanced users, such as export scheduling, ID lists, and more specific date ranges.<br>
You can get it by [downloading](https://github.com/Tyrrrz/DiscordChatExporter/releases/latest) the `DiscordChatExporter.CLI.zip` file. 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.<br/> If you're not comfortable with **Windows'** Command Line (cmd), please choose the GUI.<br>
[**macOS**](https://github.com/Tyrrrz/DiscordChatExporter/wiki/macOS-usage-instructions), [**Linux**](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Linux-usage-instructions) and [**Docker**](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Docker-usage-instructions) users can only use the CLI version.<br/> [**macOS**](https://github.com/Tyrrrz/DiscordChatExporter/wiki/macOS-usage-instructions), [**Linux**](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Linux-usage-instructions) and [**Docker**](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Docker-usage-instructions) users can only use the CLI version.<br>
**(Skip to [Using the CLI](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#using-the-cli-) or [File Formats](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#file-formats-))** **(Skip to [Using the CLI](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#using-the-cli-) or [File Formats](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#file-formats-))**
# Using the GUI ↴ # Using the GUI ↴
@@ -43,36 +43,43 @@ Special thanks to [TroubleChute](https://www.youtube.com/channel/UCkih2oVTbXPEpV
### Text Guide ↴ ### Text Guide ↴
**1.** After extracting the `.zip`, open `DiscordChatExporter.exe` **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 (→). <br/> **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 (→). <br>
**NEVER SHARE YOUR TOKEN**. A token gives <u>full access</u> to an account, treat it like a password. **NEVER SHARE YOUR TOKEN**. A token gives <u>full access</u> to an account, treat it like a password.
<img src="https://i.imgur.com/vqJSVrV.png" height="400" /> <img src="https://i.imgur.com/SuLQ5tZ.png" height="400" />
**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.<br/> **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.<br>
> 💡 Tip: You can export multiple channels at once by holding `CTRL` or `SHIFT` while selecting.<br/> > 💡 Tip: You can export multiple channels at once by holding `CTRL` or `SHIFT` while selecting.<br>
> Double-click a channel to export it without needing to click the ![](https://i.imgur.com/dnTOlDa.png) button. > You can also double-click a channel to export it without clicking the ![](https://i.imgur.com/dnTOlDa.png) button.
<img src="https://i.imgur.com/w4PCVxK.png" height="400" /> <img src="https://i.imgur.com/JHMFRh2.png" height="400" />
**4.** In this screen you can customize the following: **4.** In this screen you can customize the following:
* **Export format** - HTML (Dark), HTML (Light), TXT, CSV and JSON * **Export format** - HTML (Dark), HTML (Light), TXT, CSV and JSON
* **Date range (from/to)** (Optional) - Only exports messages sent in the provided date range. Only one value (from/to) is required if you want to use this option.
> Please notice 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 the 18th won't be exported. Click the menu button (<img src="https://raw.githubusercontent.com/google/material-design-icons/master/navigation/2x_web/ic_menu_black_18dp.png" height="15"/>) to see more options:
* **Date range (from/to)** (Optional) - If set, only messages sent in the provided date range will be exported. Only one value (either from or to) 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 the 18th won't be exported.
* **Partitioning** (Optional) - Splits files after a given number of messages. For example, a channel with 36 messages set to be partitioned every 10 messages will output 4 files. * **Partitioning** (Optional) - Splits files after a given number of messages. For example, a channel with 36 messages set to be partitioned every 10 messages will output 4 files.
* **Download media** (Optional) - If this option is set, the export will include additional files such as user avatars, attached files, images, etc.<br>
Only files which 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.<br>
A folder containing the media will be created among the exported chat. They must be kept together.
**5.** Click `EXPORT` to export. **5.** Click `EXPORT` to export.
<img src="https://i.imgur.com/Moi6iqW.png" height="400" /> <img src="https://i.imgur.com/KPgMH2D.png" height="400" /><img src="https://i.imgur.com/mtUFojS.png" height="400" />
**Date formats**<br/>
You can customize how dates are formatted in the exported files in the settings menu (![](https://i.imgur.com/0K3tt1M.png)). <br/> **Date formats**<br>
* The default one is `17-Sep-19 11:34 PM` - `dd-MMM-yy hh:mm tt`<br/> You can customize how dates are formatted in the exported files in the settings menu (![](https://i.imgur.com/0K3tt1M.png)). <br>
* To change it to `09-17-19 11:34 PM` use `MM-dd-yy hh:mm tt`<br/> * The default one is `17-Sep-19 11:34 PM` - `dd-MMM-yy hh:mm tt`<br>
* To change it to `17-09-2019 23:34` use `dd-MM-yyyy HH:mm`<br/> * To change it to `09-17-19 11:34 PM` use `MM-dd-yy hh:mm tt`<br>
* To change it to `2019-09-17 23:34:05.6534` use `yyyy-MM-dd HH:mm:ss.ffff`<br/> * To change it to `17-09-2019 23:34` use `dd-MM-yyyy HH:mm`<br>
* To change it to UTC `2019-09-18 04:34:05Z` use `u`<br/> * To change it to `2019-09-17 23:34:05.6534` use `yyyy-MM-dd HH:mm:ss.ffff`<br>
* 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)`<br/> * To change it to UTC `2019-09-18 04:34:05Z` use `u`<br>
* 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)`<br>
More info about .NET date formats [here](https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings). More info about .NET date formats [here](https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings).
@@ -80,24 +87,24 @@ More info about .NET date formats [here](https://docs.microsoft.com/en-us/dotnet
**(Skip to [File Formats](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#file-formats-))** **(Skip to [File Formats](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#file-formats-))**
# Using the CLI ↴ # Using the CLI ↴
> Make sure you have [.NET Core installed](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Install-.NET-Core-runtime) before attempting to run the commands bellow.<br/> > Make sure you have [.NET Core installed](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Install-.NET-Core-runtime) before attempting to run the commands bellow.<br>
**Docker** users, please refer to the [Docker usage instructions](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Docker-usage-instructions). **Docker** users, please refer to the [Docker usage instructions](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Docker-usage-instructions).
**1.** After extracting the `.zip`, open Command Prompt, aka `cmd` (`Terminal` on **macOS** and **Linux**). **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. **2.** Change the current directory to DCE's folder with `cd C:\path\to\directory`, then press ENTER to run the command.
<br/><br/> <br><br>
**Windows** users can quickly get the directory's path by clicking the address bar while inside the folder.<br/> **Windows** users can quickly get the directory's path by clicking the address bar while inside the folder.<br>
![](https://i.imgur.com/XncnhC2.gif)<br/><br/> ![](https://i.imgur.com/XncnhC2.gif)<br><br>
**macOS** users can select the `.exe`, hit Command+I (⌘I) and copy what's after `Where:` to get the directory<br/> **macOS** users can select the `.exe`, hit Command+I (⌘I) and copy what's after `Where:` to get the directory<br>
![](https://camo.githubusercontent.com/3c51a904b0099c9f68a4797461d4a7914902fc04/68747470733a2f2f692e696d6775722e636f6d2f323975364e79782e706e67)<br/><br/> ![](https://camo.githubusercontent.com/3c51a904b0099c9f68a4797461d4a7914902fc04/68747470733a2f2f692e696d6775722e636f6d2f323975364e79782e706e67)<br><br>
You can also drag and drop the folder on **every platform**.</br> You can also drag and drop the folder on **every platform**.<br>
![](https://i.imgur.com/sOpZQAb.gif) ![](https://i.imgur.com/sOpZQAb.gif)
**3.** Now we're ready to run the commands, but please notice that the commands differ depending on your platform. The examples in this page follow the Windows format.<br/> **3.** Now we're ready to run the commands, but please note that the commands differ depending on your platform. The examples in this page follow the Windows format.<br>
Non-Windows users will need to change the examples according to what is described below. Non-Windows users will need to change the examples according to what is described below.
Let's run the following to list DCE's options: Let's do the following to list DCE's options:
**Windows:** Type the following in Command Prompt, then press ENTER to run it: **Windows:** Type the following in Command Prompt, then press ENTER to run it:
```powershell ```powershell
@@ -141,6 +148,7 @@ DiscordChatExporter.Cli.exe command -h
||[-f](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#changing-the-format-) | [Output file format](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#file-formats-) ||[-f](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#changing-the-format-) | [Output file format](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#file-formats-)
||[-o](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#changing-the-output-filename-) | Output file or directory path ||[-o](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#changing-the-output-filename-) | Output file or directory path
||[-p](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#partitioning-) | Split output into partitions limited to this number of messages ||[-p](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#partitioning-) | Split output into partitions limited to this number of messages
||[--media](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#Downloading-media-) | Download referenced media content
||[--dateformat](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#date-formats-) | Date format used in output ||[--dateformat](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#date-formats-) | Date format used in output
||[--after](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#date-ranges-)| Limit to messages sent after this date ||[--after](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#date-ranges-)| Limit to messages sent after this date
||[--before](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#date-ranges-) | Limit to messages sent before this date ||[--before](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#date-ranges-) | Limit to messages sent before this date
@@ -174,33 +182,43 @@ DiscordChatExporter.Cli.exe export -t "mfa.Ifrn" -c 53555 -o myserver
``` ```
### Changing the output directory ↴ ### Changing the output directory ↴
You can change the export directory by using `-o`<br/> You can change the export directory by using `-o`<br>
If any of the folders has a space in its name, add quotes (") If any of the folders has a space in its name, add quotes (")
```powershell ```powershell
DiscordChatExporter.Cli.exe export -t "mfa.Ifrn" -c 53555 -o "C:\Discord Exports" DiscordChatExporter.Cli.exe export -t "mfa.Ifrn" -c 53555 -o "C:\Discord Exports"
``` ```
### Changing the filename and output directory ↴ ### Changing the filename and output directory ↴
You can change both the filename and export directory by using `-o directory\name`<br/> You can change both the filename and export directory by using `-o directory\name`<br>
If any of the folders has a space in its name, add quotes (") If any of the folders has a space in its name, add quotes (")
```powershell ```powershell
DiscordChatExporter.Cli.exe export -t "mfa.Ifrn" -c 53555 -o "C:\Discord Exports\myserver" DiscordChatExporter.Cli.exe export -t "mfa.Ifrn" -c 53555 -o "C:\Discord Exports\myserver"
``` ```
### Partitioning ↴ ### Partitioning ↴
You can use partitioning to split files after a given number of messages<br/> You can use partitioning to split files after a given number of messages<br>
For example, a channel with 36 messages set to be partitioned every 10 messages will output 4 files For example, a channel with 36 messages set to be partitioned every 10 messages will output 4 files
```powershell ```powershell
DiscordChatExporter.Cli.exe export -t "mfa.Ifrn" -c 53555 -p 10 DiscordChatExporter.Cli.exe export -t "mfa.Ifrn" -c 53555 -p 10
``` ```
### Downloading media ↴
If this option is set, the export will include additional files such as user avatars, attached files, images, etc.<br>
Only files which 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.<br>
A folder containing the media will be created among the exported chat. They must be kept together.
```powershell
DiscordChatExporter.Cli.exe export -t "mfa.Ifrn" -c 53555 --media
```
### Date formats ↴ ### Date formats ↴
This setting changes how dates are formatted in the exported files.<br/> This setting changes how dates are formatted in the exported files.<br>
* The default one is `17-Sep-19 11:34 PM` - `dd-MMM-yy hh:mm tt`<br/> * The default one is `17-Sep-19 11:34 PM` - `dd-MMM-yy hh:mm tt`<br>
* To change it to `09-17-19 11:34 PM` use `MM-dd-yy hh:mm tt`<br/> * To change it to `09-17-19 11:34 PM` use `MM-dd-yy hh:mm tt`<br>
* To change it to `17-09-2019 23:34` use `dd-MM-yyyy HH:mm`<br/> * To change it to `17-09-2019 23:34` use `dd-MM-yyyy HH:mm`<br>
* To change it to `2019-09-17 23:34:05.6534` use `yyyy-MM-dd HH:mm:ss.ffff`<br/> * To change it to `2019-09-17 23:34:05.6534` use `yyyy-MM-dd HH:mm:ss.ffff`<br>
* To change it to UTC `2019-09-18 04:34:05Z` use `u`<br/> * To change it to UTC `2019-09-18 04:34:05Z` use `u`<br>
* 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)`<br/> * 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)`<br>
More info about .NET date formats [here](https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings). More info about .NET date formats [here](https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings).
@@ -210,24 +228,24 @@ DiscordChatExporter.Cli.exe export -t "mfa.Ifrn" -c 53555 --dateformat "yyyy-MM-
``` ```
### Date ranges ↴ ### Date ranges ↴
**Messages sent before a date**<br/> **Messages sent before a date**<br>
Use `--before` to export messages sent before the provided date. E.g. messages sent before September 18th 2019: Use `--before` to export messages sent before the provided date. E.g. messages sent before September 18th 2019:
```powershell ```powershell
DiscordChatExporter.Cli.exe export -t "mfa.Ifrn" -c 53555 --before 2019-09-18 DiscordChatExporter.Cli.exe export -t "mfa.Ifrn" -c 53555 --before 2019-09-18
``` ```
**Messages sent after a date**<br/> **Messages sent after a date**<br>
Use `--after` to export messages sent after the provided date. E.g. messages sent after September 17th 2019 11:34 PM: Use `--after` to export messages sent after the provided date. E.g. messages sent after September 17th 2019 11:34 PM:
```powershell ```powershell
DiscordChatExporter.Cli.exe export -t "mfa.Ifrn" -c 53555 --after "2019-09-17 23:34" DiscordChatExporter.Cli.exe export -t "mfa.Ifrn" -c 53555 --after "2019-09-17 23:34"
``` ```
**Messages sent in a date range**<br/> **Messages sent in a date range**<br>
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: 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 ```powershell
DiscordChatExporter.Cli.exe export -t "mfa.Ifrn" -c 53555 --after "2019-09-17 23:34" --before "2019-09-18" DiscordChatExporter.Cli.exe 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`!<br/> 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`!<br>
Don't forget to quote (") the date if it has spaces!<br/> Don't forget to quote (") the date if it has spaces!<br>
More info about .NET date formats [here](https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings). More info about .NET date formats [here](https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings).
@@ -239,11 +257,12 @@ More info about .NET date formats [here](https://docs.microsoft.com/en-us/dotnet
||[-f](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#changing-the-format-) | [Output file format](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#file-formats-) ||[-f](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#changing-the-format-) | [Output file format](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#file-formats-)
||[-o](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#changing-the-output-filename-) | Output file or directory path ||[-o](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#changing-the-output-filename-) | Output file or directory path
||[-p](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#partitioning-) | Split output into partitions limited to this number of messages ||[-p](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#partitioning-) | Split output into partitions limited to this number of messages
||[--media](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#Downloading-media-) | Download referenced media content
||[--dateformat](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#date-formats-) | Date format used in output ||[--dateformat](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#date-formats-) | Date format used in output
||[--after](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#date-ranges-) | Limit to messages sent after this date ||[--after](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#date-ranges-) | Limit to messages sent after this date
||[--before](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#date-ranges-) | Limit to messages sent before this date ||[--before](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#date-ranges-) | Limit to messages sent before this date
> Options with an asterisk (**\***) are required. The order of the options doesn't matter.<br/> > Options with an asterisk (**\***) are required. The order of the options doesn't matter.<br>
This command exports all your Direct Messages. This command exports all your Direct Messages.
@@ -257,11 +276,12 @@ This command exports all your Direct Messages.
||[-f](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#changing-the-format-) | [Output file format](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#file-formats-) ||[-f](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#changing-the-format-) | [Output file format](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#file-formats-)
||[-o](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#changing-the-output-filename-) | Output file or directory path ||[-o](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#changing-the-output-filename-) | Output file or directory path
||[-p](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#partitioning-) | Split output into partitions limited to this number of messages ||[-p](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#partitioning-) | Split output into partitions limited to this number of messages
||[--media](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#Downloading-media-) | Download referenced media content
||[--dateformat](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#date-formats-) | Date format used in output ||[--dateformat](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#date-formats-) | Date format used in output
||[--after](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#date-ranges-) | Limit to messages sent after this date ||[--after](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#date-ranges-) | Limit to messages sent after this date
||[--before](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#date-ranges-) | Limit to messages sent before this date ||[--before](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#date-ranges-) | Limit to messages sent before this date
> Options with an asterisk (**\***) are required. The order of the options doesn't matter.<br/> > Options with an asterisk (**\***) are required. The order of the options doesn't matter.<br>
This command exports all channels of a Server. This command exports all channels of a Server.
@@ -272,10 +292,10 @@ This command exports all channels of a Server.
||[-b](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#using-a-bot-token-) | Whether this authorization token belongs to a bot ||[-b](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#using-a-bot-token-) | Whether this authorization token belongs to a bot
**\***|-g| [Server ID](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Obtaining-Token-and-Channel-IDs#how-to-get-guild-id-or-guild-channel-id) **\***|-g| [Server ID](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Obtaining-Token-and-Channel-IDs#how-to-get-guild-id-or-guild-channel-id)
> Options with an asterisk (**\***) are required. The order of the options doesn't matter.<br/> > Options with an asterisk (**\***) are required. The order of the options doesn't matter.<br>
This command outputs the server channels in the following format:<br/> This command outputs the server channels in the following format:<br>
`Channel ID | Channel Name`<br/><br/> `Channel ID | Channel Name`<br><br>
To save the output to a file, run the command below. If the file already exists, it will be overwritten. To save the output to a file, run the command below. If the file already exists, it will be overwritten.
```powershell ```powershell
DiscordChatExporter.exe channels -t "mfa.Ifrn" -g 21814 > C:\path\to\output.txt DiscordChatExporter.exe channels -t "mfa.Ifrn" -g 21814 > C:\path\to\output.txt
@@ -287,9 +307,9 @@ DiscordChatExporter.exe channels -t "mfa.Ifrn" -g 21814 > C:\path\to\output.txt
**\***|[-t](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#basic-usage-) | [Authorization token](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Obtaining-Token-and-Channel-IDs#how-to-get-user-token) **\***|[-t](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#basic-usage-) | [Authorization token](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Obtaining-Token-and-Channel-IDs#how-to-get-user-token)
||[-b](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#using-a-bot-token-) | Whether this authorization token belongs to a bot ||[-b](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#using-a-bot-token-) | Whether this authorization token belongs to a bot
> Options with an asterisk (**\***) are required. The order of the options doesn't matter.<br/> > Options with an asterisk (**\***) are required. The order of the options doesn't matter.<br>
This command outputs the list of Direct Messages.<br/> This command outputs the list of Direct Messages.<br>
To save the output to a file, run the command with `> C:\path\…` like the in example below. If the file already exists, it will be overwritten. To save the output to a file, run the command with `> C:\path\…` like the in example below. If the file already exists, it will be overwritten.
```powershell ```powershell
DiscordChatExporter.exe dm -t "mfa.Ifrn" > C:\path\to\output.txt DiscordChatExporter.exe dm -t "mfa.Ifrn" > C:\path\to\output.txt
@@ -302,9 +322,9 @@ DiscordChatExporter.exe dm -t "mfa.Ifrn" > C:\path\to\output.txt
**\***|[-t](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#basic-usage-) | [Authorization token](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Obtaining-Token-and-Channel-IDs#how-to-get-user-token) **\***|[-t](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#basic-usage-) | [Authorization token](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Obtaining-Token-and-Channel-IDs#how-to-get-user-token)
||[-b](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#using-a-bot-token-) | Whether this authorization token belongs to a bot ||[-b](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#using-a-bot-token-) | Whether this authorization token belongs to a bot
> Options with an asterisk (**\***) are required. The order of the options doesn't matter.<br/> > Options with an asterisk (**\***) are required. The order of the options doesn't matter.<br>
This command outputs a list of your Server List.<br/> This command outputs a list of your Server List.<br>
To save the output to a file, run the command with `> C:\path\…` like the in example below. If the file already exists, it will be overwritten. To save the output to a file, run the command with `> C:\path\…` like the in example below. If the file already exists, it will be overwritten.
```powershell ```powershell
DiscordChatExporter.exe guilds -t "mfa.Ifrn" > C:\path\to\output.txt DiscordChatExporter.exe guilds -t "mfa.Ifrn" > C:\path\to\output.txt
@@ -318,37 +338,36 @@ This command explains [how to get your token, guild, and channel IDs](https://gi
## HTML ↴ ## HTML ↴
![](https://i.imgur.com/S7lBTkV.png) ![](https://i.imgur.com/S7lBTkV.png)
The HTML format replicates Discord's interface, making it the most user-friendly option.<br/> The HTML format replicates Discord's interface, making it the most user-friendly option.<br>
It's the best format for attachment preview and sharing.<br/> It's the best format for attachment preview and sharing.<br>
You can open `.html` files with a web browser, such as Google Chrome.<br/> You can open `.html` files with a web browser, such as Google Chrome.<br>
> Please notice that if a picture is deleted, or if a user changes its avatar, the respective images will no longer be displayed.<br/> > Please note that if a picture is deleted, or if a user changes its avatar, the respective images will no longer be displayed.<br>
[Save the file for offline viewing to avoid this problem](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Storing-HTML-locally)!<br/> Export using the "Download referenced media content" (`--media`) option to avoid this.
![](https://i.imgur.com/9uAHT3o.png)
## Plain Text ↴ ## Plain Text ↴
<img src="https://i.imgur.com/PbUyRXD.png" height="400" /> <img src="https://i.imgur.com/PbUyRXD.png" height="400" />
The Plain Text format is the best option for archiving due to its small size.<br/> The Plain Text format is the best option for archiving due to its small size.<br>
You can open `.txt` files with text editors, such as Notepad. You can open `.txt` files with a text editor, such as Notepad.
## JSON ↴ ## JSON ↴
<img src="https://i.imgur.com/FAeSA4O.png" height="400" /> <img src="https://i.imgur.com/FAeSA4O.png" height="400" />
The JSON format contains more technical information and is easily parsable.<br/> The JSON format contains more technical information and is easily parsable.<br>
You can open `.json` files with text editors, such as Notepad. You can open `.json` files with a text editor, such as Notepad.
## CSV ↴ ## CSV ↴
![](https://i.imgur.com/VEVUsKs.png) ![](https://i.imgur.com/VEVUsKs.png)
![](https://i.imgur.com/1vPmQqQ.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.<br/> The CSV format allows for easy parsing of the chat log. Depending on your needs, the JSON format might be better.<br>
You can open `.csv` files with text editors, such as Notepad, or spreadsheet programs, like Microsoft Excel and Google Sheets. You can open `.csv` files with a text editor, such as Notepad, or a spreadsheet program, like Microsoft Excel or Google Sheets.
**([Back to top](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#getting-started))** **([Back to top](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#getting-started))**
# #
Further reading: [Storing HTML files locally for offline viewing](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Storing-HTML-locally), [.NET date formats](https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings)<br/> Further reading: [.NET date formats](https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings)<br>
Special thanks to [@Yudi](https://github.com/Yudi) Special thanks to [@Yudi](https://github.com/Yudi)