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 e293c1c commit 7f00cad
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 10 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ on:
push:
paths-ignore:
- '.github/ISSUE_TEMPLATE/**'
- 'README.MD'
- 'README-*.MD'
- 'LICENSE'
pull_request:
branches:
- master
Expand Down
8 changes: 3 additions & 5 deletions README-zh_CN.MD
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,9 @@

构建的文件可以在 Action 里面找到,稳定版可以在 Release 里面找到。

对于每个平台都有两个版本,分别为带有额外解析函数的版本和不带有额外解析函数(`No Function`)的版本。额外解析函数可以解析实体 ID 和同步协议数据等
Windows 下载后把`mcdissector.dll`文件放入 Wireshark 的解析器目录(`plugins/4.2/epan`)并启动 Wireshark 即可

Windows 下载后把`mcdissector.dll`文件放入 Wireshark 的解析器目录(`plugins/4.0/epan`)并启动 Wireshark 即可。

Linux 下载后把`mcdissector.so`文件放入 Wireshark 的解析器目录(`~/.local/lib/wireshark/plugins/4.0/epan`)并启动 Wireshark 即可。
Linux 下载后把`mcdissector.so`文件放入 Wireshark 的解析器目录(`~/.local/lib/wireshark/plugins/4.2/epan`)并启动 Wireshark 即可。

## 可调选项

Expand Down Expand Up @@ -68,7 +66,7 @@ Linux 下载后把`mcdissector.so`文件放入 Wireshark 的解析器目录(`~

## 构建项目(Windows)

构建此项目需要有 Wireshark 的源码并需要配置依赖,且需要 python 用于代码生成
构建此项目需要有 Wireshark 的源码并需要配置依赖。

1. 克隆 Wireshark 仓库到本地,配置好需要的依赖。
2. 指定环境变量`PLATFORM``x64`,指定环境变量`WIRESHARK_LIB_DIR`为 Wireshark 依赖库目录(运行 cmake 时会自动创建)。
Expand Down
8 changes: 3 additions & 5 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,11 @@ English | [简体中文](./README-zh_CN.MD)

Built files can be found in Actions, stable version can be found in Release.

For each platform there are 2 different versions with and without additional parse function (`No Function`). Additional parse function can parse entity ID and synchronize protocol data etc.

After downloading:

For Windows, put file `mcdissector.dll` into dissector directory of Wireshark (`plugins/4.0/epan`) and run Wireshark.
For Windows, put file `mcdissector.dll` into dissector directory of Wireshark (`plugins/4.2/epan`) and run Wireshark.

For Linux, put file `mcdissector.so` into dissector directory of Wireshark (`~/.local/lib/wireshark/plugins/4.0/epan`) and run Wireshark.
For Linux, put file `mcdissector.so` into dissector directory of Wireshark (`~/.local/lib/wireshark/plugins/4.2/epan`) and run Wireshark.

## Tunable Options

Expand Down Expand Up @@ -65,7 +63,7 @@ The overall protocol is dynamically built by protocol description file in `minec

## How To Build Projects (Windows)

Building this project requires Wireshark source code with configured dependencies and python for code generation.
Building this project requires Wireshark source code with configured dependencies.

1. Clone Wireshark repository to local and configure necessary dependencies.
2. Set environment variable `PLATFORM` as `x64`, and `WIRESHARK_LIB_DIR` as directory of dependency library of Wireshark (automatically created at running cmake).
Expand Down

0 comments on commit 7f00cad

Please sign in to comment.