You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Proxmark3GUI/README.md

92 lines
3.0 KiB
Markdown

5 years ago
# Proxmark3GUI
4 years ago
![downloads](https://img.shields.io/github/downloads/wh201906/Proxmark3GUI/total)
2 years ago
A cross-platform GUI for [Proxmark3](https://github.com/Proxmark/proxmark3)/[Proxmark3 Iceman fork](https://github.com/RfidResearchGroup/proxmark3) client
(The [orignal Proxmark3 repo](https://github.com/Proxmark/proxmark3) has been unmaintained for a long time. I personally suggest using the [Proxmark3 Iceman fork](https://github.com/RfidResearchGroup/proxmark3))
5 years ago
3 years ago
[中文介绍](doc/README/README_zh_CN.md)
5 years ago
***
## Features
+ Easy to find available Serial Port
+ Support raw commands of Proxmark3 client(Official/Iceman)
5 years ago
+ Have a friendly UI to test Mifare cards
+ Support different card size(MINI, 1K, 2K, 4K)
+ Easy to edit Mifare block data
4 years ago
+ Easy to read all/selected blocks with well-designed read logic
+ Easy to write all/selected blocks
+ Support binary(.bin .dump) files and text(.eml) files
+ Analyze Access Bits
+ Support Chinese Magic Card
4 years ago
+ Have basic support for LF commands
+ Customize UI
+ ...
5 years ago
***
## Preview
3 years ago
![preview](doc/README/preview.png)
5 years ago
3 years ago
[more previews](doc/preview/previews.md)
5 years ago
***
## About Iceman fork/repo
3 years ago
The [Iceman fork/repo](https://github.com/RfidResearchGroup/proxmark3) has more powerful functions. These guys even developed a new hardware called Proxmark3 RDV4 with smart card support. But the official repo and the Iceman repo is not fully compatible.
This GUI is compatible with Iceman/RRG repo(tested on v4.13441)
***
## About Compiled Windows clients
4 years ago
A cool guy [Gator96100](https://github.com/Gator96100) creates [ProxSpace](https://github.com/Gator96100/ProxSpace) and makes it possible to compile both the firmware and the client on Windows.
4 years ago
Also, he makes the [pre-compiled Windows client](https://www.proxmarkbuilds.org/) so you can download it and run your PM3 client on Windows instantly.
I included his compiled client in my releases so you can use the GUI on the fly, and you can also use the GUI with your prefered client.
Great thanks to him.
5 years ago
5 years ago
***
4 years ago
## Build on Linux
cd ~
sudo apt-get update
sudo apt-get install qt5-default libqt5serialport5 libqt5serialport5-dev
git clone https://github.com/wh201906/Proxmark3GUI.git --depth=1
4 years ago
cd Proxmark3GUI
mkdir build && cd build
qmake ../src
make -j4 && make clean
4 years ago
./Proxmark3GUI
## Build on macOS
cd ~
brew update
brew install qt@5
brew link qt5 --force
git clone https://github.com/wh201906/Proxmark3GUI.git --depth=1
cd Proxmark3GUI
mkdir build && cd build
qmake ../src
make -j4 && make clean
cp -r ../config ./
open Proxmark3GUI.app
> In order for the GUI to connect to the device in macOS, you'd need to tweak the settings a little bit
![macOS_settings](doc/README/macOS_settings.png)
4 years ago
***
3 years ago
## Tutorial
[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)
3 years ago
***
4 years ago
3 years ago
## Change Log
[Change Log](CHANGELOG.md)