mirror of
https://github.com/Tyrrrz/DiscordChatExporter.git
synced 2026-01-28 22:01:55 +00:00
Formatting, arrows, welcome section
Yudi
@@ -1,35 +1,49 @@
|
||||
|
||||
# Getting started
|
||||
|
||||
Welcome to the getting started page!<br/>
|
||||
Here you'll learn how to use every **DiscordChatExporter** (DCE for short) feature.<br/>
|
||||
For other things you can do with DCE, check 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/>
|
||||
|
||||
> The information presented in this page is valid for **all** platforms.
|
||||
|
||||
**Index**
|
||||
* [GUI or CLI?](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#gui-or-cli-)
|
||||
* [Using the GUI](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#using-the-gui-)
|
||||
* [Using the CLI](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#using-the-cli-)
|
||||
* [Command List](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#dcecli-commands-)
|
||||
* [Which File Format to use?](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#file-formats-)
|
||||
* [HTML](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#html-)
|
||||
* [Plain Text](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#plain-text-)
|
||||
* [JSON](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#json-)
|
||||
* [CSV](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#csv-)
|
||||
|
||||
|
||||
* [GUI or CLI?](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#gui-or-cli)
|
||||
* [Using the GUI](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#using-the-gui)
|
||||
* [Using the CLI](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#using-the-cli)
|
||||
* [Command List](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#dcecli-commands)
|
||||
* [Which File Format to use?](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#file-formats)
|
||||
* [HTML](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#html)
|
||||
* [Plain Text](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#plain-text)
|
||||
* [JSON](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#json)
|
||||
* [CSV](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#csv)
|
||||
|
||||
# GUI or CLI?
|
||||
|
||||
**DiscordChatExporter** (DCE for short) has two different versions:
|
||||
* **Graphical User Interface** (**GUI**) - it's the preferred version as it provides ease of 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.
|
||||
# GUI or CLI? ↴
|
||||
|
||||
**DCE** has two different versions:
|
||||
* **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/>
|
||||
* **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.
|
||||
|
||||
If you're not comfortable with **Windows'** Command Line (cmd), please choose the GUI.<br/>
|
||||
**macOS** and **Linux** 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))**
|
||||
# Using the GUI
|
||||
### Community Video Guide
|
||||
**(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 ↴
|
||||
### Community Video Guide ↴
|
||||
|
||||
Special thanks to [TroubleChute](https://www.youtube.com/channel/UCkih2oVTbXPEpVwE-U7kmHw).
|
||||
|
||||
[](http://www.youtube.com/watch?v=3JwpN9cl5KE "How to: Export a Discord Chat Log | PM’s or text channels")
|
||||
### Text Guide
|
||||
<a href="http://www.youtube.com/watch?v=3JwpN9cl5KE"><img src="https://i.imgur.com/ByMpwSW.png" width="400" title="How to: Export a Discord Chat Log | PM’s or text channels" /></a>
|
||||
|
||||
### Text Guide ↴
|
||||
**1.** After extracting the `.zip`, open `DiscordChatExporter.exe`
|
||||
|
||||
**2.** Paste your token in the upper text box and hit ENTER, or click the arrow (→). Please refer to the on-screen instructions to get your token.<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.
|
||||
|
||||
<img src="https://i.imgur.com/vqJSVrV.png" height="400" />
|
||||
@@ -60,12 +74,13 @@ You can customize how dates are formatted in the exported files at the settings
|
||||
More info about .NET date formats [here](https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings).
|
||||
|
||||
|
||||
**(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
|
||||
> If you're using [macOS](https://github.com/Tyrrrz/DiscordChatExporter/wiki/macOS-usage-instructions) or [Linux](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Linux-usage-instructions), please follow the installation instructions before running the commands bellow.<br/>
|
||||
# Using the CLI ↴
|
||||
> If you're using [**macOS**](https://github.com/Tyrrrz/DiscordChatExporter/wiki/macOS-usage-instructions) or [**Linux**](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Linux-usage-instructions), please follow the installation instructions before running the commands bellow.<br/>
|
||||
**Docker** users, please refer to the [Docker usage instructions](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Docker-usage-instructions).
|
||||
|
||||
**1.** After extracting the `.zip`, open `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`. Press ENTER to run the commands after writing them.
|
||||
<br/><br/>
|
||||
@@ -88,17 +103,17 @@ dotnet DiscordChatExporter.Cli.dll
|
||||
|
||||
**Docker** users, please refer to the [Docker usage instructions](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Docker-usage-instructions).
|
||||
|
||||
## DCE.CLI Commands
|
||||
## DCE.CLI Commands ↴
|
||||
|
||||
| Command | Description |
|
||||
| ------- | ----------- |
|
||||
[export](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#export) | Export a channel
|
||||
[exportdm](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#exportdm) | Export all direct message channels
|
||||
[exportguild](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#exportguild) | Export all channels within specified server
|
||||
[channels](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#channels) | Outputs the list of channels in the given server
|
||||
[dm](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#dm) | Outputs the list of direct message channels
|
||||
[guilds](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#guilds) | Outputs the list of accessible servers
|
||||
[guide](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#guide) | Explains how to obtain token, guild and channel ID
|
||||
[export](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#export-) | Export a channel
|
||||
[exportdm](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#exportdm-) | Export all direct message channels
|
||||
[exportguild](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#exportguild-) | Export all channels within specified server
|
||||
[channels](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#channels-) | Outputs the list of channels in the given server
|
||||
[dm](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#dm-) | Outputs the list of direct message channels
|
||||
[guilds](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#guilds-) | Outputs the list of accessible servers
|
||||
[guide](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#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/wiki/Obtaining-Token-and-Channel-IDs), or run `DiscordChatExporter.Cli.exe guide`.
|
||||
To get help about a specific command, please run:
|
||||
@@ -106,69 +121,69 @@ To get help about a specific command, please run:
|
||||
DiscordChatExporter.Cli.exe command -h
|
||||
```
|
||||
|
||||
## export
|
||||
## export ↴
|
||||
|
||||
||Option | Description
|
||||
|--|------- | -------------
|
||||
|**\***|[-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
|
||||
|**\***|[-c](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#basic-usage) | [Channel ID](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Obtaining-Token-and-Channel-IDs#how-to-get-guild-id-or-guild-channel-id)
|
||||
||[-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
|
||||
||[-p](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#partitioning) | Split output into partitions limited to this number of messages
|
||||
||[--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
|
||||
||[--before](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#date-ranges) | Limit to messages sent before this date
|
||||
|**\***|[-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
|
||||
|**\***|[-c](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#basic-usage-) | [Channel ID](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Obtaining-Token-and-Channel-IDs#how-to-get-guild-id-or-guild-channel-id)
|
||||
||[-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
|
||||
||[-p](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#partitioning-) | Split output into partitions limited to this number of messages
|
||||
||[--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
|
||||
||[--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.
|
||||
|
||||
With this command you can export Server Channels and Direct Messages.
|
||||
|
||||
### Basic usage
|
||||
### Basic usage ↴
|
||||
You can quickly export with DCE's default settings by using just `-t token` and `-c channelid`
|
||||
```powershell
|
||||
DiscordChatExporter.Cli.exe export -t "mfa.Ifrn" -c 53555
|
||||
```
|
||||
|
||||
### Using a Bot Token
|
||||
### Using a Bot Token ↴
|
||||
Add `-b`
|
||||
```powershell
|
||||
DiscordChatExporter.Cli.exe export -t "Mjg5ODIz" -b -c 53555
|
||||
```
|
||||
|
||||
### Changing the format
|
||||
You can change the export format to `HtmlDark`, `HtmlLight`, `PlainText` or `Csv` by using `-f format`
|
||||
### Changing the format ↴
|
||||
You can change the export format to `HtmlDark`, `HtmlLight`, `PlainText` `Json` or `Csv` by using `-f format`
|
||||
```powershell
|
||||
DiscordChatExporter.Cli.exe export -t "mfa.Ifrn" -c 53555 -f PlainText
|
||||
DiscordChatExporter.Cli.exe export -t "mfa.Ifrn" -c 53555 -f Json
|
||||
```
|
||||
|
||||
### Changing the output filename
|
||||
### Changing the output filename ↴
|
||||
You can change the filename by using `-o name`
|
||||
```powershell
|
||||
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/>
|
||||
If any of the folders has a space in its name, add quotes (")
|
||||
```powershell
|
||||
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/>
|
||||
If any of the folders has a space in its name, add quotes (")
|
||||
```powershell
|
||||
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/>
|
||||
For example, a channel with 36 messages set to be partitioned every 10 messages will output 4 files
|
||||
```powershell
|
||||
DiscordChatExporter.Cli.exe export -t "mfa.Ifrn" -c 53555 -p 10
|
||||
```
|
||||
### Date formats
|
||||
### Date formats ↴
|
||||
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/>
|
||||
* To change it to `09-17-19 11:34 PM` use `MM-dd-yy hh:mm tt`<br/>
|
||||
@@ -182,7 +197,7 @@ More info about .NET date formats [here](https://docs.microsoft.com/en-us/dotnet
|
||||
DiscordChatExporter.Cli.exe export -t "mfa.Ifrn" -c 53555 --dateformat "yyyy-MM-dd HH:mm"
|
||||
```
|
||||
|
||||
### Date ranges
|
||||
### Date ranges ↴
|
||||
**Messages sent before a date**<br/>
|
||||
Use `--before` to export messages sent before the provided date. E.g. messages sent before September 18th 2019:
|
||||
```powershell
|
||||
@@ -191,7 +206,7 @@ DiscordChatExporter.Cli.exe export -t "mfa.Ifrn" -c 53555 --before 2019-09-18
|
||||
**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:
|
||||
```powershell
|
||||
DiscordChatExporter.Cli.exe export -t "mfa.Ifrn" -c 53555 --after "2019-09-18 23:34"
|
||||
DiscordChatExporter.Cli.exe export -t "mfa.Ifrn" -c 53555 --after "2019-09-17 23:34"
|
||||
```
|
||||
**Messages sent in a date range**<br/>
|
||||
Use `--before` and `--after` to export messages sent at the provided date range. E.g. messages sent between September 17th 2019 11:34 PM and September 18th:
|
||||
@@ -204,45 +219,45 @@ 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).
|
||||
|
||||
|
||||
## exportdm
|
||||
## exportdm ↴
|
||||
||Option | Description
|
||||
|-|------- | -------------
|
||||
**\***|[-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
|
||||
||[-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
|
||||
||[-p](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#partitioning) | Split output into partitions limited to this number of messages
|
||||
||[--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
|
||||
||[--before](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#date-ranges) | Limit to messages sent before this date
|
||||
**\***|[-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
|
||||
||[-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
|
||||
||[-p](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#partitioning-) | Split output into partitions limited to this number of messages
|
||||
||[--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
|
||||
||[--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/>
|
||||
|
||||
This command exports all your Direct Messages.
|
||||
|
||||
|
||||
## exportguild
|
||||
## exportguild ↴
|
||||
||Option | Description
|
||||
|-|------- | -------------
|
||||
|**\***|[-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
|
||||
|**\***|[-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
|
||||
|**\***|-g | [Server ID](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Obtaining-Token-and-Channel-IDs#how-to-get-guild-id-or-guild-channel-id)
|
||||
||[-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
|
||||
||[-p](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#partitioning) | Split output into partitions limited to this number of messages
|
||||
||[--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
|
||||
||[--before](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#date-ranges) | Limit to messages sent before this date
|
||||
||[-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
|
||||
||[-p](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#partitioning-) | Split output into partitions limited to this number of messages
|
||||
||[--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
|
||||
||[--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/>
|
||||
|
||||
This command exports all channels of a Server.
|
||||
|
||||
## channels
|
||||
## channels ↴
|
||||
||Option | Description
|
||||
|-|------- | -------------
|
||||
**\***|[-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
|
||||
**\***|[-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
|
||||
**\***|-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/>
|
||||
@@ -253,11 +268,11 @@ To save the output to a file, run the command below. If the file already exists,
|
||||
DiscordChatExporter.exe channels -t "mfa.Ifrn" -g 21814 > C:\path\to\output.txt
|
||||
```
|
||||
|
||||
## dm
|
||||
## dm ↴
|
||||
||Option | Description
|
||||
|-|------- | -------------
|
||||
**\***|[-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
|
||||
**\***|[-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
|
||||
|
||||
> Options with an asterisk (**\***) are required. The order of the options doesn't matter.<br/>
|
||||
|
||||
@@ -268,11 +283,11 @@ DiscordChatExporter.exe dm -t "mfa.Ifrn" > C:\path\to\output.txt
|
||||
```
|
||||
|
||||
|
||||
## guilds
|
||||
## guilds ↴
|
||||
||Option | Description
|
||||
|-|------- | -------------
|
||||
**\***|[-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
|
||||
**\***|[-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
|
||||
|
||||
> Options with an asterisk (**\***) are required. The order of the options doesn't matter.<br/>
|
||||
|
||||
@@ -282,35 +297,36 @@ To save the output to a file, run the command below. If the file already exists,
|
||||
DiscordChatExporter.exe guilds -t "mfa.Ifrn" > C:\path\to\output.txt
|
||||
```
|
||||
|
||||
## guide
|
||||
This command explains [how to get your token, guild or channel IDs](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Obtaining-Token-and-Channel-IDs).
|
||||
## guide ↴
|
||||
This command explains [how to get your token, guild, and channel IDs](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Obtaining-Token-and-Channel-IDs).
|
||||
|
||||
# File formats
|
||||
# File formats ↴
|
||||
|
||||
## HTML
|
||||
## HTML ↴
|
||||
|
||||
|
||||
The HTML format replicates Discord's interface, making it the most user-friendly option. It's the best format for attachment preview and sharing.<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/>
|
||||
You can open `.html` files with a web browser, such as Google Chrome.<br/>
|
||||
> Please notice that if the picture is deleted, or if a user changes its avatar, the images won't show up anymore.<br/>
|
||||
[Save images for offline viewing to avoid this problem](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Storing-HTML-locally)!<br/>
|
||||
|
||||
|
||||
## Plain Text
|
||||
## Plain Text ↴
|
||||
|
||||
<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/>
|
||||
You can open `.txt` files with text editors, such as Notepad.
|
||||
|
||||
## JSON
|
||||
## JSON ↴
|
||||
|
||||
<img src="https://i.imgur.com/FAeSA4O.png" height="400" />
|
||||
|
||||
The JSON format contains more technical information that's easily parsable.<br/>
|
||||
The JSON format contains more technical information and it's easily parsable.<br/>
|
||||
You can open `.json` files with text editors, such as Notepad.
|
||||
|
||||
## CSV
|
||||
## CSV ↴
|
||||
|
||||
|
||||
|
||||
@@ -318,7 +334,7 @@ You can open `.json` files with text editors, such as Notepad.
|
||||
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.
|
||||
|
||||
**([Back to top](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#gui-or-cli))**
|
||||
**([Back to top](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#getting-started))**
|
||||
|
||||
#
|
||||
Further reading: [Storing images 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/>
|
||||
|
||||
Reference in New Issue
Block a user