Improve documentation (#1225)

pull/1227/head
LostXOR 2 months ago committed by GitHub
parent bedf7de8c6
commit 886b8442d3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -35,13 +35,13 @@ You can open `.html` files with a web browser, such as Google Chrome.
> **Warning**: > **Warning**:
> If a picture is deleted, or if a user changes its avatar, the respective images will no longer be displayed. > 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. > Export using the "Download assets" (`--media`) option to avoid this.
### 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. The Plain Text format formats messages as plain text, and has the smallest size.
You can open `.txt` files with a text editor, such as Notepad. You can open `.txt` files with a text editor, such as Notepad.
### JSON ### JSON

@ -12,13 +12,12 @@ After extracting the `.zip`, open Command Prompt, aka `cmd` (`Terminal` on **mac
## Step 2 ## Step 2
Change the current directory to DCE's folder with `cd C:\path\to\directory`, then press ENTER to run the command. Change the current directory to DCE's folder with `cd C:\path\to\DiscordChatExporter` (`cd /path/to/DiscordChatExporter` on **MacOS** and **Linux**), 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. **Windows** users can quickly get the folder's path by clicking the address bar while inside the folder.
![Copy path from Explorer](https://i.imgur.com/XncnhC2.gif) ![Copy path from Explorer](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 **macOS** users can press Command+Option+C (⌘⌥C) while inside the folder (or selecting it) to copy its path to the clipboard.
![Mac info panel](https://camo.githubusercontent.com/3c51a904b0099c9f68a4797461d4a7914902fc04/68747470733a2f2f692e696d6775722e636f6d2f323975364e79782e706e67)
You can also drag and drop the folder on **every platform**. You can also drag and drop the folder on **every platform**.
![Drag and drop folder](https://i.imgur.com/sOpZQAb.gif) ![Drag and drop folder](https://i.imgur.com/sOpZQAb.gif)

@ -10,7 +10,7 @@
### Step 1 ### Step 1
After extracting the `.zip`, open `DiscordChatExporter.exe` After extracting the `.zip`, run `DiscordChatExporter.exe` (Windows), or `DiscordChatExporter` (Mac OS and Linux).
### Step 2 ### Step 2
@ -61,37 +61,30 @@ In this screen you can customize the following:
## Settings ## Settings
- **Auto-update** - **Auto-update** - Perform automatic updates on every launch.
Perform automatic updates on every launch.
Default: Enabled Default: Enabled
> **Note**: > **Note**:
> Keep this option enabled to receive the latest features and bug fixes! > Keep this option enabled to receive the latest features and bug fixes!
- **Dark mode** - **Dark mode** - Use darker colors in the UI (User Interface).
Use darker colors in the UI (User Interface).
Default: Disabled Default: Disabled
- **Persist token** - **Persist token** - Persist last used token between sessions.
Persist last used token between sessions.
Default: Enabled Default: Enabled
- **Show threads** - **Show threads** - Controls whether threads are shown in the channel list.
Controls whether threads are shown in the channel list.
Default: none Default: none
- **Locale** - **Locale** - Customize how dates are formatted in the exported files.
Customize how dates are formatted in the exported files.
- **Date format** - **Date format** - Customize how dates are formatted in the exported files in the settings menu ().
Customize how dates are formatted in the exported files in the settings menu ().
- **Parallel limit** - **Parallel limit** - The number of channels that will be exported at the same time.
The number of channels that will be exported at the same time.
Default: 1 Default: 1
- **Normalize to UTC**
Convert all dates to UTC before exporting.
> **Note**: > **Note**:
> Try to keep this number low so that your account doesn't get flagged. > Try to keep this number low so that your account doesn't get flagged.
- **Normalize to UTC** - Convert all dates to UTC before exporting.

Loading…
Cancel
Save