DiscordChatExporter/Readme.md

99 lines
4.5 KiB
Markdown
Raw Normal View History

2017-07-12 13:18:00 -04:00
# DiscordChatExporter
2019-11-06 13:34:59 -05:00
[![Build](https://github.com/Tyrrrz/DiscordChatExporter/workflows/CI/badge.svg?branch=master)](https://github.com/Tyrrrz/DiscordChatExporter/actions)
2017-10-15 16:58:33 -04:00
[![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)
2019-11-19 14:17:05 -05:00
[![Donate](https://img.shields.io/badge/donate-$$$-purple.svg)](https://tyrrrz.me/donate)
2017-10-15 16:58:33 -04:00
2020-12-28 11:38:22 -05:00
**Project status: active**.
2020-10-24 18:53:32 -04:00
2021-02-09 19:05:08 -05:00
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.
2017-07-12 13:18:00 -04:00
2021-02-09 19:05:08 -05:00
**If you have questions or issues, please refer to the [wiki](https://github.com/Tyrrrz/DiscordChatExporter/wiki)**.
2019-11-16 13:59:53 -05:00
2017-08-28 17:45:04 -04:00
## Download
2021-02-09 19:05:08 -05:00
This application comes in two flavors: graphical user interface (**GUI**) and command line interface (**CLI**).
The following table lists all available download options:
2017-08-28 17:45:04 -04:00
2021-02-09 19:05:08 -05:00
<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>
2021-02-09 19:26:58 -05:00
<div>🟢 <b><a href="https://github.com/Tyrrrz/DiscordChatExporter/releases/latest">Stable release</a></b> (<code>DiscordChatExporter.zip</code>)</div>
<div>🟠 <a href="https://github.com/Tyrrrz/DiscordChatExporter/actions?query=workflow%3ACI">CI build</a> (<code>DiscordChatExporter.zip</code>)</div>
2021-02-09 19:05:08 -05:00
</td>
<td>
<ul>
2021-02-09 19:26:58 -05:00
<li>Windows <b>7</b>+</li>
2021-02-09 19:05:08 -05:00
</ul>
</td>
<td>
<div>.NET v3.1 Desktop Runtime</div>
<ul>
2021-02-09 19:26:58 -05:00
<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>
2021-02-09 19:44:55 -05:00
<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>
2021-02-09 19:05:08 -05:00
</ul>
</td>
</tr>
<tr>
<td><b>CLI</b></td>
<td>
2021-02-09 19:26:58 -05:00
<div>🟢 <b><a href="https://github.com/Tyrrrz/DiscordChatExporter/releases/latest">Stable release</a></b> (<code>DiscordChatExporter.CLI.zip</code>)</div>
<div>🟠 <a href="https://github.com/Tyrrrz/DiscordChatExporter/actions?query=workflow%3ACI">CI build</a> (<code>DiscordChatExporter.CLI.zip</code>)</div>
<div>🐋 <a href="https://hub.docker.com/r/tyrrrz/discordchatexporter">Docker</a> (<code>tyrrrz/discordchatexporter</code>) 🚀</div>
<div>📦 <a href="https://aur.archlinux.org/packages/discord-chat-exporter-cli">AUR</a> (<code>discord-chat-exporter-cli</code>) 🚀 🦄</div>
2021-02-09 19:05:08 -05:00
</td>
<td>
<ul>
2021-02-09 19:26:58 -05:00
<li>Windows <b>7</b>+</li>
<li>macOS <b>10.11</b>+</li>
2021-02-09 19:05:08 -05:00
<li>Linux</li>
</ul>
</td>
<td>
<div>.NET v3.1 Base Runtime</div>
<ul>
2021-02-09 19:26:58 -05:00
<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>
2021-02-09 19:05:08 -05:00
<li><a href="https://docs.microsoft.com/en-us/dotnet/core/install/linux">Linux (find your distribution)</a></li>
</ul>
</td>
</tr>
</tbody>
</table>
2019-12-08 07:00:12 -05:00
2021-02-09 19:05:08 -05:00
- 🚀 - .NET Runtime is already embedded or installed automatically
- 🦄 - Community-maintained resource
2019-12-08 07:00:12 -05:00
2021-02-09 19:26:58 -05:00
> Note: DiscordChatExporter requires **.NET v3.1 Runtime** in order to work!
Refer to the **Requirements** column in the above table to download the appropriate installer for your system.
2017-07-13 02:32:44 -04:00
## Features
2019-12-10 12:27:41 -05:00
- Graphical user interface (Windows)
- Command line interface (Windows, Linux, macOS)
- Works with both user and bot tokens
- Exports on the fly without buffering messages in memory
- Allows exporting messages in a specified range
- Supports file partitioning based on message count
- Uses custom markdown parser compatible with Discord syntax
- Handles all rich media features, including attachments, embeds, emojis, etc
2020-02-03 11:10:06 -05:00
- Renders to HTML (dark & light), TXT, CSV, JSON
2017-07-13 02:32:44 -04:00
## Screenshots
2019-09-06 13:27:53 -04:00
![channel list](.screenshots/list.png)
2020-09-20 08:52:44 -04:00
![rendered output](.screenshots/output.png)