Add tutorial for ProxSpace

master
wh201906 1 year ago
parent a9b03f081a
commit 785fde6e2d
No known key found for this signature in database

@ -85,10 +85,13 @@ open Proxmark3GUI.app
![macOS_settings](doc/README/macOS_settings.png) ![macOS_settings](doc/README/macOS_settings.png)
*** ***
## Tutorial ## Tutorial
[1.Quickstart](doc/tutorial/Quickstart/quickstart.md) [1.Quickstart](doc/tutorial/Quickstart/quickstart.md)
[2.Edit Mifare Classic data](doc/tutorial/Edit_Mifare_Classic_data/Edit_Mifare_Classic_data.md)(Proxmark3 hardware is not necessary) [2.Work with ProxSpace](doc/tutorial/Work_With_ProxSpace/work_with_proxspace.md)
[3.Edit Mifare Classic data](doc/tutorial/Edit_Mifare_Classic_data/Edit_Mifare_Classic_data.md)(Proxmark3 hardware is not necessary)
*** ***
## Change Log ## Change Log

@ -87,7 +87,8 @@ open Proxmark3GUI.app
*** ***
## 教程 ## 教程
[1.快速上手](../tutorial/Quickstart/quickstart_zh_CN.md) [1.快速上手](../tutorial/Quickstart/quickstart_zh_CN.md)
[2.编辑Mifare(IC)卡数据](../tutorial/Edit_Mifare_Classic_data/Edit_Mifare_Classic_data_zh_CN.md)无需PM3硬件 [2.使用ProxSpace编译的客户端](../tutorial/Work_With_ProxSpace/work_with_proxspace_zh_CN.md)
[3.编辑Mifare(IC)卡数据](../tutorial/Edit_Mifare_Classic_data/Edit_Mifare_Classic_data_zh_CN.md)无需PM3硬件
*** ***
## 更新日志 ## 更新日志

@ -0,0 +1,79 @@
# Work with ProxSpace
This GUI supports clients built from ProxSpace, making it easier to use the latest client with this GUI.
## 1. Set up ProxSpace
Please refer to this tutorial to set up ProxSpace and compile Proxmark3 client:
https://github.com/Gator96100/ProxSpace/blob/HEAD/README.md
After that, you will get a folder structure like this:
```
.
├── autobuild.bat
├── msys2
│   ├── autorebase.bat
│   └── ......
├── pm3
│   └── proxmark3
│   ├── client
│   ├── ......
│   ├── pm3
│   ├── README.md
│   └── ......
├── README.md
├── runme64.bat
└── setup
└── ......
```
The proxmark3 repository is located in `./pm3/proxmark3`
## 2. Download GUI
You can download prebuilt binaries there.
[Prebuilt binaries](../../../README.md#download-binaries-for-windows)
Please download a version without the client, like `V0.2.7-win64.7z`.
After downloading, extract it to a path without non-ASCII characters and spaces. Plus, the target folder should not be the same as the proxmark3 repository.
For example, if you extract it to ./pm3/GUI/, you will get a folder structure like this:
```
.
├── autobuild.bat
├── msys2
│   ├── autorebase.bat
│   └── ......
├── pm3
│   ├── GUI
│   │   └── V0.2.7-win64
│   │   ├── plugins
│   │   ├── Proxmark3GUI.exe
│   │   └── ......
│   └── proxmark3
│   ├── client
│   ├── ......
│   ├── pm3
│   ├── README.md
│   └── ......
├── README.md
├── runme64.bat
└── setup
└── ......
```
## 3. Run the GUI in ProxSpace
Double-click `./runme64.bat` to run the ProxSpace. Now the working directory is `./pm3`.
In the terminal of ProxSpace, run `cd GUI` to go to the `./pm3/GUI`, then run `./V0.2.7-win64/Proxmark3GUI.exe` to open the GUI.
***
**Note:** You can run the GUI in your preferred folder, but please avoid running it in the same directory as the GUI itself, otherwise it will cause errors when loading the client.
Using the directory structure above as an example, you can first run `cd /pm3` to set the working directory to `/pm3`, then run `./V0.2.7-win64/Proxmark3GUI.exe` to open the GUI.
However, you should not first run `cd /pm3/GUI/V0.2.7-win64` and then run `./Proxmark3GUI.exe`.
## 4. Connect to the device in GUI
## Specify the Client Path
Using the directory structure above as an example, assuming the current working directory is `./pm3/GUI`, and the client path is `./pm3/proxmark3/client/proxmark3.exe`, you need to enter `../proxmark3/client/proxmark3.exe` in the `Client Path`.
## Clear the Preload Script Path
The GUI is launched in ProxSpace so it includes the necessary environment variables for the client, there is no need to use any preload script.
## Select the Config File
Depending on the client version, you need to select the corresponding config file. For example, select `config_official.json` for the official client, and select `config_rrgv4.15864.json` for the rrg version v4.15864. If your client version is not listed, try selecting the config file with a similar version number.
## Connect to the Device
Select the port number of the PM3 hardware, then click `Connect`.

@ -0,0 +1,75 @@
# 使用ProxSpace编译的客户端
此GUI可以和ProxSpace编译出来的客户端配合运行满足一部分用户使用最新版客户端的需求
## 1. 搭建ProxSpace环境
请参考此教程搭建ProxSpace环境并编译proxmark3客户端:
https://github.com/Gator96100/ProxSpace/blob/HEAD/README.md
搭建完成后,你将会获得如下的目录结构:
```
.
├── autobuild.bat
├── msys2
│   ├── autorebase.bat
│   └── ......
├── pm3
│   └── proxmark3
│   ├── client
│   ├── ......
│   ├── pm3
│   ├── README.md
│   └── ......
├── README.md
├── runme64.bat
└── setup
└── ......
```
其中proxmark3仓库位于 `./pm3/proxmark3`
## 2. 下载GUI
你可以在此处下载编译好的客户端
[预编译客户端](../../README/README_zh_CN.md#关于预编译windows客户端)
下载时请选择不含客户端的版本,例如`V0.2.7-win64.7z`
下载后请将其解压到不含中文字符和空格的路径中同时要确保GUI文件和proxmark3仓库不位于同一文件夹下
以解压到`./pm3/GUI/`为例,你将会获得如下的目录结构
```
.
├── autobuild.bat
├── msys2
│   ├── autorebase.bat
│   └── ......
├── pm3
│   ├── GUI
│   │   └── V0.2.7-win64
│   │   ├── plugins
│   │   ├── Proxmark3GUI.exe
│   │   └── ......
│   └── proxmark3
│   ├── client
│   ├── ......
│   ├── pm3
│   ├── README.md
│   └── ......
├── README.md
├── runme64.bat
└── setup
└── ......
```
## 3. 从ProxSpace运行GUI
双击`./runme64.bat`运行ProxSpace环境此时工作目录位于`./pm3`
在新弹出的终端中运行`cd GUI`来到`./pm3/GUI/`目录下,然后运行`./V0.2.7-win64/Proxmark3GUI.exe`此时的GUI将会包含客户端运行所需要的所有环境变量
***
**请注意**你可以在你喜欢的工作目录下运行GUI但请不要在GUI文件所在目录下运行否则加载客户端时会出错
以上面的目录结构为例,你可以先运行`cd /pm3`将工作目录设为`/pm3`,然后运行`./V0.2.7-win64/Proxmark3GUI.exe`来打开GUI
但是你不能先运行`cd /pm3/GUI/V0.2.7-win64`,然后运行`./Proxmark3GUI.exe`,否则之后无法正确加载客户端
## 4. 从GUI连接设备
### 填写客户端路径
以上面的目录结构为例,假设此时的工作目录为`./pm3/GUI`,而客户端路径为`./pm3/proxmark3/client/proxmark3.exe`,则需要在客户端路径里面填写`../proxmark3/client/proxmark3.exe`
### 清空预加载脚本路径
因为GUI是从ProxSpace中启动的本身已包含客户端所需的环境变量因此不需要使用任何预加载脚本
### 选择(客户端)配置文件
根据客户端版本的不同你需要选择对应的配置文件。例如official版本对应`config_official.json`rrg版本号v4.15864对应`config_rrgv4.15864.json`。如果选项中没有你所使用的客户端版本,可以尝试选择版本号相近的对应配置文件
### 连接设备
在“端口”当中选择需要连接的端口号,单击“连接”即可
Loading…
Cancel
Save