Skip to content

Commit

Permalink
More README.
Browse files Browse the repository at this point in the history
  • Loading branch information
Jomolungma committed Jan 5, 2021
1 parent 5c6d490 commit 6cba64a
Showing 1 changed file with 31 additions and 13 deletions.
44 changes: 31 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# WhatsAppChatBeautifier

WhatsAppChatBeautifier is a tool to render WhatsApp and Threema chats into
WhatsAppChatBeautifier is a tool to render WhatsApp and Threema chats as
HTML.

WhatsApp and Threema allow exporting chat histories in ZIP format.
WhatsAppChatBeautifier reads this exported chat and formats it as HTML
for viewing, archiving or printing.
WhatsApp and Threema allow exporting chat histories in ZIP format (see
below for more details.) WhatsAppChatBeautifier reads these files and
converts them to HTML for viewing, archiving or printing.

## Prerequisites

Expand Down Expand Up @@ -130,18 +130,23 @@ WhatsApp conversations. These images have been downloaded from
[Pixabay](https://pixabay.com/de/). Images and Videos on Pixabay are
released under Creative Commons CC0.

## Threema
## Whats App

WhatsAppChatBeautifier also includes preliminary support for single chats
exported from the [Threema](https://threema.ch/) messenger.
The WhatsApp app has an "Export chat" feature that allows exporting
individual chats. On Android, the exported chat can be saved to Google
Drive, where it can be downloaded. On iPhone, the exported chat can be
saved to iCloud, where it can be downloaded using a Browser, or saved
to "Files", where it can be copied to your PC using iTunes.

However, WhatsAppChatBeautifier is unable to decrypt the ZIP file format
used by Threema. Please unzip the ZIP file using software that supports
AES encryption, such as [7-Zip](https://www.7-zip.org/) to extract the
ZIP file, then point WhatsAppChatBeautifier to the extracted contents.
Note: do not send the exported chat by mail, because that will include
only the most recent media files. Exporting to cloud or file will include
all attachments.

In single chats, incoming messages use the sender `<<<`. You can use the
`--map` option to substitute `<<<` with a different name.
If the above process does not appeal to you, if it does not work for
you (e.g., because your storage is full), or if the "Export chat"
feature is not available to you (WhatsApp has restricted the "Export
chat" feature in some locations, e.g., in Germany), then Explorer
for WhatsApp can be used as an alternative (see below).

## Explorer for WhatsApp

Expand All @@ -153,6 +158,19 @@ the WhatsApp database (i.e., all conversations and attached media) can
be exported from Explorer for WhatsApp as a spreadsheet ("XLSX").
This spreadsheet can then be used as an input for WhatsAppChatBeautifier.

## Threema

WhatsAppChatBeautifier also includes preliminary support for single chats
exported from the [Threema](https://threema.ch/) messenger.

However, WhatsAppChatBeautifier is unable to decrypt the ZIP file format
used by Threema. Please unzip the ZIP file using software that supports
AES encryption, such as [7-Zip](https://www.7-zip.org/) to extract the
ZIP file, then point WhatsAppChatBeautifier to the extracted contents.

In single chats, incoming messages use the sender `<<<`. You can use the
`--map` option to substitute `<<<` with a different name.

## Caveats

WhatsApp and Threma use localized strings in their exported chats, such
Expand Down

0 comments on commit 6cba64a

Please sign in to comment.