DiscordChatExporter/Readme.md

105 lines
5.3 KiB
Markdown
Raw Normal View History

2017-07-12 13:18:00 -04:00
# DiscordChatExporter
2022-03-21 13:24:44 -04:00
[![Made in Ukraine](https://img.shields.io/badge/made_in-ukraine-ffd700.svg?labelColor=0057b7)](https://vshymanskyy.github.io/StandWithUkraine)
2022-04-21 18:14:35 -04:00
[![Build](https://img.shields.io/github/workflow/status/Tyrrrz/DiscordChatExporter/main/master)](https://github.com/Tyrrrz/DiscordChatExporter/actions)
2022-03-21 13:24:44 -04:00
[![Coverage](https://img.shields.io/codecov/c/github/Tyrrrz/DiscordChatExporter/master)](https://codecov.io/gh/Tyrrrz/DiscordChatExporter)
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)
2021-07-26 11:55:46 -04:00
[![Discord](https://img.shields.io/discord/869237470565392384?label=discord)](https://discord.gg/2SUWKFnHSm)
2022-03-21 13:24:44 -04:00
[![Donate](https://img.shields.io/badge/donate-$$$-8a2be2.svg)](https://tyrrrz.me/donate)
[![Fuck Russia](https://img.shields.io/badge/fuck-russia-e4181c.svg?labelColor=000000)](https://twitter.com/tyrrrz/status/1495972128977571848)
2017-10-15 16:58:33 -04:00
2022-08-26 11:01:19 -04:00
> 🟡 **Project status**: maintenance mode<sup>[[?]](https://github.com/Tyrrrz/.github/blob/master/docs/project-status.md)</sup>
2020-10-24 18:53:32 -04:00
2021-12-05 15:15:51 -05:00
**DiscordChatExporter** can be used to export message history from a [Discord](https://discord.com) channel to a file.
2021-02-09 19:05:08 -05:00
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
2022-03-22 14:02:14 -04: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
2022-04-16 11:48:39 -04:00
> 💬 If you want to chat, **join my [Discord server](https://discord.gg/2SUWKFnHSm)**.
2022-05-31 05:29:24 -04:00
## Terms of use<sup>[[?]](https://github.com/Tyrrrz/.github/blob/master/docs/why-so-political.md)</sup>
2022-03-05 12:30:41 -05:00
By using this project or its source code, for any purpose and in any shape or form, you grant your **implicit agreement** to all the following statements:
- You **condemn Russia and its military aggression against Ukraine**
- You **recognize that Russia is an occupant that unlawfully invaded a sovereign state**
- You **support Ukraine's territorial integrity, including its claims over temporarily occupied territories of Crimea and Donbas**
- You **reject false narratives perpetuated by Russian state propaganda**
To learn more about the war and how you can help, [click here](https://tyrrrz.me). Glory to Ukraine! 🇺🇦
2021-07-26 11:55:46 -04: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>
</tr>
</thead>
<tbody>
<tr>
<td><b>GUI</b></td>
<td>
2021-04-14 08:02:06 -04:00
<ul>
<li>🟢 <b><a href="https://github.com/Tyrrrz/DiscordChatExporter/releases/latest">Stable release</a></b> (<code>DiscordChatExporter.zip</code>)</li>
2022-04-21 18:14:35 -04:00
<li>🟠 <a href="https://github.com/Tyrrrz/DiscordChatExporter/actions/workflows/main.yml">CI build</a> (<code>DiscordChatExporter.zip</code>)</li>
2021-04-14 08:02:06 -04:00
</ul>
2021-02-09 19:05:08 -05:00
</td>
<td>
<ul>
2021-04-14 08:04:42 -04:00
<li>Windows <b>7</b> or higher</li>
2021-02-09 19:05:08 -05:00
</ul>
</td>
</tr>
<tr>
<td><b>CLI</b></td>
<td>
2021-04-14 08:02:06 -04:00
<ul>
2022-07-06 07:08:07 -04:00
<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/workflows/main.yml">CI build</a> (<code>DiscordChatExporter.CLI.zip</code>)</li>
2021-06-08 11:04:19 -04:00
<li>🐋 <a href="https://hub.docker.com/r/tyrrrz/discordchatexporter">Docker</a> (<code>tyrrrz/discordchatexporter</code>)</li>
2022-07-06 07:08:07 -04:00
<li>📦 <a href="https://aur.archlinux.org/packages/discord-chat-exporter-cli">AUR</a> (<code>discord-chat-exporter-cli</code>)</li>
2021-04-14 08:02:06 -04:00
</ul>
2021-02-09 19:05:08 -05:00
</td>
<td>
<ul>
2021-04-14 08:02:06 -04:00
<li>Windows <b>7</b> or higher</li>
<li>macOS <b>10.13 (High Sierra)</b> or higher</li>
2021-06-08 11:04:19 -04:00
<li>Linux (multiple distros)</li>
2021-02-09 19:05:08 -05:00
</ul>
</td>
</tr>
</tbody>
</table>
2019-12-08 07:00:12 -05:00
2022-07-06 07:08:07 -04:00
> **Note**:
> **DiscordChatExporter**'s AUR package is maintained by the community.
> **Warning**:
> To run **DiscordChatExporter** on macOS or Linux, you will need to additionally install **.NET Runtime v6**:
> - [.NET Runtime v6 for **macOS x64**](https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-6.0.6-macos-x64-installer)
> - [.NET Runtime v6 for **macOS Arm64**](https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-6.0.6-macos-arm64-installer)
> - [.NET Runtime v6 for **Linux**](https://docs.microsoft.com/en-us/dotnet/core/install/linux) (find the correct download for your distro)
>
> This is not required if you installed **DiscordChatExporter** using a package manager, or if you plan to run **DiscordChatExporter** via Docker.
2021-02-09 19:26:58 -05:00
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)
2022-04-09 14:57:34 -04:00
- Authentication via both user and bot tokens
2021-02-21 20:15:09 -05:00
- Multiple output formats: HTML (dark/light), TXT, CSV, JSON
2022-04-09 14:57:34 -04:00
- Support for markdown, attachments, embeds, emoji, and other rich media features
- File partitioning, date ranges, message filtering, and other export options
2022-04-09 14:58:41 -04:00
- Self-contained exports that don't require internet
2017-07-13 02:32:44 -04:00
## Screenshots
2022-04-22 10:19:42 -04:00
![channel list](.assets/list.png)
![rendered output](.assets/output.png)