Proxmark III development environment for Windows

ProxSpace is a collection of tools that are required to compile the firmware and client of the Proxmark III. At its core ProxSpace uses msys2. MSYS2 is a software distro and building platform for Windows, it provides a bash shell, Autotools, revision control systems and the like for building native Windows applications using MinGW-w64 toolchains. ProxSpace uses the GNU Arm Embedded Toolchain for compiling the Proxmark III firmware.

Files

ProxSpace comes with 2 different executables .bat files.

• runme64.bat will start ProxSpace in x64 mode.
• autobuild.bat runs a script (msys2/autobuild.sh) in x64 mode at startup. The script will update all git repositories in the pm3 folder and then compile them and move a zip file with the just compiled firmware and client into the build folder. It is not designed for development, just for compiling.

What's installed

ProxSpace will automatically download and update to the latest required packages. All tools will be contained within the ProxSpace folder, however once ProxSpace is setup the ProxSpace folder must not be moved. If you wish to have ProxSpace in a different directory, you need to reinstall it.

ProxSpace is based on:

• msys2-x86_64-20210215

Following packages will be automatically download or updated:

• arm-none-eabi-gcc
• arm-none-eabi-gdb
• openocd
• git
• make
• cmake
• gcc
• gdb
• Qt5
• readline
• pkg-config
• libsndfile
• lua
• bzip2
• python
• jansson

Package management system

MSYS2 features a package management system to provide easy installation of packages, Pacman. It brings many powerful features such as dependency resolution and simple complete system upgrades (excluding the GNU Arm Embedded Toolchain), as well as straight-forward package building. All installed packages can be updated with pacman -Syuu For more details visit the MSYS2 wiki

Installation

1. There are two methods of installing the ProxSpace environment.
   • Downloading the latest master. This will upgrade the msys2 core packages and then will download and install every package required for compiling the Proxmark client and firmware.
   • Downloading the latest release. This ProxSpace environment has the required packages cached and will only install and update outdated packages.
2. Extract 'ProxSpace' to a location on drive without spaces. For example C:\Proxspace or D:\projects\public\proxmark\proxspace are ok, whereas C:\My Documents\My Projects\proxspace is not.
3. Run runme64.bat depending on your Windows architecture.
4. Get the Proxmark III repository you wish to compile. This can be done with git. For example git clone https://github.com/Proxmark/proxmark3.git.
5. Go into the root directory of the repository you wish to compile. For example cd proxmark3.
6. To build the project type make clean && make all.
7. In most cases the Proxmark III needs to be flashed with the just compiled firmware for details see Firmware upgrading the Proxmark III.
8. To run the Proxmark III client type ./client/proxmark3.exe COM1 where COM1 is the USB port of the Proxmark III.
9. Check your firmware revision on the Proxmark III with hw ver
10. For basic help type help. Or for help on a set of sub commands type the command followed by help. For example hf mf help.

Firmware upgrading the Proxmark III

Please note that more detail is available on the wiki: https://github.com/Proxmark/proxmark3/wiki

1. Attach the Proxmark III to a USB port on your computer.
2. Flash the bootrom and fullimage with ./client/flasher COM1 -b ./bootrom/obj/bootrom.elf ./armsrc/obj/fullimage.elfwhere COM1 is the USB port of the Proxmark III.
3. Wait for the process to complete.

Setup video