DiscordChatExporter/.docs/Getting-started.md

61 lines
2.4 KiB
Markdown
Raw Normal View History

2023-01-26 21:29:36 -05:00
# Getting started
Welcome to the getting started page!
Here you'll learn how to use every **DiscordChatExporter** (DCE for short) feature.
2023-11-11 10:47:48 -05:00
For other things you can do with DCE, check out the [Guides](Readme.md#guides) section.
2023-01-26 21:29:36 -05:00
2023-11-11 10:47:48 -05:00
If you still have unanswered questions after reading this page or if you have encountered a problem, please visit our [FAQ & Troubleshooting](Troubleshooting.md) section.
2023-01-26 21:29:36 -05:00
The information presented on this page is valid for **all** platforms.
2023-01-27 02:59:02 -05:00
## GUI or CLI?
2023-01-26 21:29:36 -05:00
2023-09-29 07:53:52 -04:00
![GUI vs CLI](https://i.imgur.com/j9OTxRB.png)
2023-11-11 10:47:48 -05:00
2023-01-26 21:29:36 -05:00
**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.
2023-02-01 05:35:30 -05:00
- **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.
2023-01-26 21:29:36 -05:00
2023-09-29 07:53:52 -04:00
There are dedicated guides for each version:
2023-01-26 21:29:36 -05:00
2023-11-11 10:47:48 -05:00
- [Using the GUI](Using-the-GUI.md)
- [Using the CLI](Using-the-CLI.md)
2023-01-26 21:29:36 -05:00
2023-01-27 02:59:02 -05:00
## File formats
2023-01-26 21:29:36 -05:00
2023-01-27 02:59:02 -05:00
### HTML
2023-01-26 21:29:36 -05:00
![](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.
2023-01-27 02:59:02 -05:00
> **Warning**:
> If a picture is deleted, or if a user changes its avatar, the respective images will no longer be displayed.
2023-01-26 21:29:36 -05:00
> Export using the "Download referenced assets" (`--media`) option to avoid this.
2023-01-27 02:59:02 -05:00
### Plain Text
2023-01-26 21:29:36 -05:00
<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.
You can open `.txt` files with a text editor, such as Notepad.
2023-01-27 02:59:02 -05:00
### JSON
2023-01-26 21:29:36 -05:00
<img src="https://i.imgur.com/FAeSA4O.png" height="400"/>
The JSON format contains more technical information and is easily parsable.
You can open `.json` files with a text editor, such as Notepad.
2023-01-27 02:59:02 -05:00
### CSV
2023-01-26 21:29:36 -05:00
![](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.