You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
DiscordChatExporter/Readme.md

102 lines
4.5 KiB

# DiscordChatExporter
[![Build](https://github.com/Tyrrrz/DiscordChatExporter/workflows/CI/badge.svg?branch=master)](https://github.com/Tyrrrz/DiscordChatExporter/actions)
7 years ago
[![Release](https://img.shields.io/github/release/Tyrrrz/DiscordChatExporter.svg)](https://github.com/Tyrrrz/DiscordChatExporter/releases)
[![Downloads](https://img.shields.io/github/downloads/Tyrrrz/DiscordChatExporter/total.svg)](https://github.com/Tyrrrz/DiscordChatExporter/releases)
[![Donate](https://img.shields.io/badge/donate-$$$-purple.svg)](https://tyrrrz.me/donate)
7 years ago
4 years ago
**Project status: active**.
4 years ago
4 years ago
DiscordChatExporter can be used to export message history from a [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 all other rich media features.
4 years ago
**If you have questions or issues, please refer to the [wiki](https://github.com/Tyrrrz/DiscordChatExporter/wiki)**.
## Download
4 years ago
This application comes in two flavors: graphical user interface (**GUI**) and command line interface (**CLI**).
The following table lists all available download options:
4 years ago
<table>
<thead>
<tr>
<th></th>
<th>Downloads</th>
<th>Supported OS</th>
<th>Requirements</th>
</tr>
</thead>
<tbody>
<tr>
<td><b>GUI</b></td>
<td>
<ul>
<li>🟢 <b><a href="https://github.com/Tyrrrz/DiscordChatExporter/releases/latest">Stable release</a></b> (<code>DiscordChatExporter.zip</code>)</li>
<li>🟠 <a href="https://github.com/Tyrrrz/DiscordChatExporter/actions?query=workflow%3ACI">CI build</a> (<code>DiscordChatExporter.zip</code>)</li>
</ul>
4 years ago
</td>
<td>
<ul>
4 years ago
<li>Windows <b>7</b>+</li>
4 years ago
</ul>
</td>
<td>
<div>.NET v3.1 Desktop Runtime</div>
<ul>
4 years ago
<li><a href="https://dotnet.microsoft.com/download/dotnet-core/thank-you/runtime-desktop-3.1.0-windows-x64-installer">Windows <b>x64</b></a></li>
4 years ago
<li><a href="https://dotnet.microsoft.com/download/dotnet-core/thank-you/runtime-desktop-3.1.0-windows-x86-installer">Windows <b>x86</b></a></li>
4 years ago
</ul>
</td>
</tr>
<tr>
<td><b>CLI</b></td>
<td>
<ul>
<li>🟢 <b><a href="https://github.com/Tyrrrz/DiscordChatExporter/releases/latest">Stable release</a></b> (<code>DiscordChatExporter.CLI.zip</code>)</li>
<li>🟠 <a href="https://github.com/Tyrrrz/DiscordChatExporter/actions?query=workflow%3ACI">CI build</a> (<code>DiscordChatExporter.CLI.zip</code>)</li>
<li>🐋 <a href="https://hub.docker.com/r/tyrrrz/discordchatexporter">Docker</a> (<code>tyrrrz/discordchatexporter</code>) 🚀</li>
<li>📦 <a href="https://aur.archlinux.org/packages/discord-chat-exporter-cli">AUR</a> (<code>discord-chat-exporter-cli</code>) 🚀 🦄</li>
</ul>
4 years ago
</td>
<td>
<ul>
<li>Windows <b>7</b> or higher</li>
<li>macOS <b>10.13 (High Sierra)</b> or higher</li>
4 years ago
<li>Linux</li>
</ul>
</td>
<td>
<div>.NET v3.1 Base Runtime</div>
<ul>
4 years ago
<li><a href="https://dotnet.microsoft.com/download/dotnet-core/thank-you/runtime-desktop-3.1.0-windows-x64-installer">Windows <b>x64</b></a></li>
<li><a href="https://dotnet.microsoft.com/download/dotnet-core/thank-you/runtime-desktop-3.1.0-windows-x86-installer">Windows <b>x86</b></a></li>
<li><a href="https://dotnet.microsoft.com/download/dotnet-core/thank-you/runtime-3.1.0-macos-x64-installer">macOS <b>x64</b></a></li>
4 years ago
<li><a href="https://docs.microsoft.com/en-us/dotnet/core/install/linux">Linux (find your distribution)</a></li>
</ul>
</td>
</tr>
</tbody>
</table>
4 years ago
- 🚀 - .NET Runtime is already embedded or installed automatically
- 🦄 - Community-maintained resource
4 years ago
> Note that DiscordChatExporter requires **.NET v3.1 Runtime** in order to work!
4 years ago
Refer to the **Requirements** column in the above table to download the appropriate installer for your system.
7 years ago
## Features
5 years ago
- Graphical user interface (Windows)
- Command line interface (Windows, Linux, macOS)
4 years ago
- Support for both user and bot tokens
- Support for Discord's dialect of markdown
- Support for attachments, embeds, emojis, and other rich media features
- Multiple output formats: HTML (dark/light), TXT, CSV, JSON
- File partitioning, date ranges, and other export options
- Exports messages on the fly without buffering in-memory
7 years ago
## Screenshots
![channel list](.screenshots/list.png)
![rendered output](.screenshots/output.png)