Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Nickid2018 committed Jul 21, 2024
1 parent 8cc71a9 commit 4fb105d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README-zh_CN.MD
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Linux 下载后把`mcdissector.so`文件放入 Wireshark 的解析器目录(`~

## 解析错误

如果出现了解析错误,可能有下面三种情况
如果出现了解析错误,可能有下面两种种情况

* Wireshark 没有抓取到所有数据。由于 Java 版使用 TCP,数据由长度字段拆分,一旦缺少某一部分,
数据就会立刻无法解析。如果你在数据解析错误的前后发现了`TCP Previous segment not captured`,那么就是这种情况。
Expand Down
6 changes: 4 additions & 2 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ For Linux, put file `mcdissector.so` into dissector directory of Wireshark (`~/.

## Tunable Options

`MCJE` can be found in `Preferences/Protocols` in Wireshark, where you can adjust some options here.
`Minecraft` can be found in `Preferences/Protocols` in Wireshark, where you can adjust some options here.

* Directory for protocol data: The directory for protocol data, used to parse data.
* Ignore Packets: Prevent parsing some packets to filt unwanted information. The format is commas-separated list of `<s|c>:<packet_name>`. `s` represents packets sent to server, `c` represents packets sent to client.The default is `c:map_chunk` which stops parsing server-to-client chunk data packets, since to parse such packets will spend extra long time and produce excess data fields.
Expand Down Expand Up @@ -66,11 +66,13 @@ Only a single circumstance will disable the program: Mods have modified encrypti

## Parsing Errors

Parsing error exists under 3 circumstances as follow:
Parsing error exists under 2 circumstances as follow:

* Wireshark failed to capture all data. Since Java edition uses TCP, data is spilt by length field, and once missing any segment, data will be unparsable immediately. You can confirm this circumstance if you have discovered `TCP Previous segment not captured` near the data parsing error.
* The program has not finished adaption or process properly for this part, or has not added corresponding strings. Such errors can be reported by open issues.

All protocol data is generated by `MC_Protocol_Data`, so if you have any questions about the data, you can open an issue in the repository.

## How To Build Projects (Windows)

Building this project requires Wireshark source code with configured dependencies.
Expand Down

0 comments on commit 4fb105d

Please sign in to comment.