└── README.md


/README.md:
--------------------------------------------------------------------------------
 1 | # ymir
 2 | ymir is a sniffing tool ("sniffer") which captures traffic sent between wow servers and clients and writes it to a file. 
 3 | 
 4 | ## Disclaimer
 5 | 
 6 | Use at your own risk, TrinityCore is not responsible for any actions caused (by Activision Blizzard, jurists or anyone else) due to usage of this tool.  
 7 | The generated sniff files contain private data (e.g. your real name), so its highly advised to only share it with TrinityCore developers and official contributors.
 8 | 
 9 | Since initial development during patch 8.1.5/Retail no known bans were caused so far. Nevertheless this is no proof for total security.
10 | 
11 | ## Operating system requirements
12 | The sniffer is developed for usage on Windows 10.  
13 | It might be possible to use it on OS X via. wine (untested)
14 | 
15 | ## Installation
16 | 1. Download and install Npcap using Npcap installer from https://nmap.org/npcap/ (and install it in **WinPcap compatibility mode**)
17 | 2. Download sniffer binary for your version, patch from [Releases](http://github.com/TrinityCore/ymir/releases) and save it anywhere (preferably not in wow directory)
18 | 
19 | ## How to sniff
20 | 1. Delete Cache directory within your relevant wow installation (for retail e.g. inside *\_retail\_* directory)
21 | 2. Start *ymir_retail.exe* (name might be different depending on wow branch, e.g. *ymir_ptr.exe* for PTR)
22 | 3. Start wow client (via Battle.net or explorer)
23 | 4. Sniffs will be saved in the dump/ subdirectory next to the sniffer while playing
24 | 5. When done playing just close wow regularly and wait for the sniffer to close automatically (usually happens 1-5s after client is closed)
25 | 6. Compress sniff in 7z, rar or zip, upload them to any file hoster (e.g. mega, zippyshare) and share the links [in the TC Forum](https://community.trinitycore.org/forum/13-wdbadbsniffs/), we're working on an easier solution for this already.
26 | 
27 | ## Tips
28 | You can combine step 1 & 2 with a batch file (adjust paths to your needs, especially partitions *E:* and *F:*):
29 | ```batch
30 | E:
31 | cd E:\Games\World of Warcraft\_retail_\
32 | rmdir /S /Q Cache
33 | 
34 | F:
35 | cd F:\ymir\Retail
36 | start ymir_retail.exe
37 | ```
38 | 
39 | ## Sniff processing
40 | The saved sniffs may be further processed using [WowPacketParser](http://github.com/TrinityCore/WowPacketParser)
41 | 
42 | ## Authors
43 | - [shelby](http://github.com/Izidor)
44 | - [ModoX](http://github.com/mdX7)
45 | - [Shauren](http://github.com/Shauren)
46 | 


--------------------------------------------------------------------------------