diff --git a/README.md b/README.md index 5dc9adc..5209b9f 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ If you are good at cryptography / reverse engineereing, or you work at Tencent, It is also possible to recover the image without knowing the first 1KB (just have to detect chunks without knowing metadata), but I don't have time to do that either. If this tools works for you, please take a moment to __add your phone/OS to__ [the wiki](https://github.com/ppwwyyxx/wechat-dump/wiki). -If it doesn't work, please leave an issue together with your phone/OS/wechat version. +If it doesn't work, you probably have to investigate it as the behavior may be different on each phone. ### How to use: @@ -36,8 +36,6 @@ Database parsing and rendering needs: + csscompressor (suggested, optional) + Silk audio decoder (included; just run `./third-party/compile_silk.sh`) -On Debian/Ubuntu systems, these dependencies can be installed via: - #### Get Necessary Data: 1. Pull database file and avatar index: @@ -86,25 +84,25 @@ On Debian/Ubuntu systems, these dependencies can be installed via: tar xf emoji.cache.tar.bz2 #### Run: -+ Parse and dump text messages of __every__ chat (requires `decrypted.db`): ++ Parse and dump text messages of __every__ chat (requires decrypted database): ``` ./dump-msg.py decrypted.db output_dir ``` -+ List all chats (requires `decrypted.db`): ++ List all chats (required decrypted database): ``` ./list-chats.py decrypted.db ``` -+ Generate statistical report on text messages (requires `output_dir` from `./dump-msg.py`): ++ Generate statistics report on text messages (requires `output_dir` from `./dump-msg.py`): ``` ./count-message.sh output_dir ``` -+ Dump messages of one contact to html, containing voice messages, emojis, and images (requires `decrypted.db`, `avatar.index`, and `resource`): ++ Dump messages of one contact to html, containing voice messages, emojis, and images (requires decrypted database, `avatar.index`, and `resource`): ``` ./dump-html.py "" @@ -122,6 +120,7 @@ Screenshots of generated html: See [here](http://ppwwyyxx.com/static/wechat/example.html) for an example html. ### TODO List ++ Migrate core to Python3 + Attack the emoji encryption problem + Fix rare unhandled message types: > 10000 and < 0 + Better user experiences... see `grep 'TODO' wechat -R`