mirror of
https://github.com/RfidResearchGroup/proxmark3.git
synced 2025-08-14 18:48:13 -07:00
text
This commit is contained in:
iceman1001
parent
14d9b08946
commit
3450439b7b
7 changed files with 195 additions and 10 deletions
|
|
@ -1,11 +1,30 @@
|
|||
# Installing on Windows
|
||||
<a id="top"></a>
|
||||
|
||||
## Table of Contents
|
||||
# Windows Installation instructions
|
||||
|
||||
|
||||
## Table of Contents
|
||||
- [Windows Installation instructions](#windows-installation-instructions)
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [Installing dev-environment with ProxSpace](#installing-dev-environment-with-proxspace)
|
||||
- [Video Installation guide](#video-installation-guide)
|
||||
- [Driver Installation ( Windows 7 )](#driver-installation--windows-7-)
|
||||
- [Download ProxSpace repo](#download-proxspace-repo)
|
||||
- [Launch ProxSpace](#launch-proxspace)
|
||||
- [Clone the RRG/Iceman repository](#clone-the-rrgiceman-repository)
|
||||
- [Compile and use the project](#compile-and-use-the-project)
|
||||
- [Done!](#done)
|
||||
- [Installing pre-compiled binaries with ProxSpace](#installing-pre-compiled-binaries-with-proxspace)
|
||||
- [Installing dev-environment with WSL 1](#installing-dev-environment-with-wsl-1)
|
||||
- [Stay away from WSL 2](#stay-away-from-wsl-2)
|
||||
- [More about WSL](#more-about-wsl)
|
||||
- [X Server Installation](#x-server-installation)
|
||||
- [Windows Terminal Installation](#windows-terminal-installation)
|
||||
- [Dependencies](#dependencies)
|
||||
- [Clone the RRG/Iceman repository](#clone-the-rrgiceman-repository-1)
|
||||
- [Compile and use the project](#compile-and-use-the-project-1)
|
||||
- [Done!](#done-1)
|
||||
|
||||
* [Installing dev-environment with ProxSpace](#installing-dev-environment-with-proxspace)
|
||||
* [Installing pre-compiled binaries with ProxSpace](#installing-pre-compiled-binaries-with-proxspace)
|
||||
* [Installing dev-environment with WSL 1](#installing-dev-environment-with-wsl-1)
|
||||
|
||||
There are two ways to install, build and use Proxmark3 on Windows:
|
||||
|
||||
|
|
@ -20,10 +39,13 @@ We have listed three ways to use these two setups (dev environment vs pre-compi
|
|||
^[Top](#top)
|
||||
|
||||
## Video Installation guide
|
||||
^[Top](#top)
|
||||
|
||||
_note: this video is out-of-date but still informative_
|
||||
[](https://youtu.be/zzF0NCMJnYU "Windows Installation Tutorial")
|
||||
|
||||
## Driver Installation ( Windows 7 )
|
||||
^[Top](#top)
|
||||
|
||||
_note: for Windows 7 you will this step. On a later Windows edition skip this._
|
||||
|
||||
|
|
@ -31,6 +53,7 @@ Install required drivers for your Windows installation. You may need admin privi
|
|||
Step by step guides are online such as [RyscCorps](https://store.ryscc.com/blogs/news/how-to-install-a-proxmark3-driver-on-windows-10).
|
||||
|
||||
## Download ProxSpace repo
|
||||
^[Top](#top)
|
||||
|
||||
Download the Gator96100 ProxSpace package from https://github.com/Gator96100/ProxSpace/releases
|
||||
|
||||
|
|
@ -50,6 +73,7 @@ C:\My Documents\My Projects\proxspace
|
|||
If you're running Windows in a Virtualbox guest, make sure not to install ProxSpace on a vbox shared drive. (It's ok later to move the `/pm3` subfolder to a shared drive and edit the `*.bat`)
|
||||
|
||||
## Launch ProxSpace
|
||||
^[Top](#top)
|
||||
|
||||
Run `runme64.bat`.
|
||||
|
||||
|
|
@ -58,6 +82,7 @@ You'll get a Bash prompt and your home directory should become the ProxSpace `pm
|
|||
Please note you will need to use `/` in paths as you are using Bash.
|
||||
|
||||
## Clone the RRG/Iceman repository
|
||||
^[Top](#top)
|
||||
|
||||
```sh
|
||||
cd
|
||||
|
|
@ -72,10 +97,12 @@ pacman -S mingw-w64-x86_64-astyle
|
|||
```
|
||||
|
||||
## Compile and use the project
|
||||
^[Top](#top)
|
||||
|
||||
To use the compiled client, the only differences are that executables end with `.exe` (e.g. `proxmark3.exe`) and that the Proxmark3 port is one of your `comX` ports where "X" is the com port number assigned to proxmark3 under Windows, so commands like `proxmark3 /dev/ttyACMX` become `proxmark3.exe comX`.
|
||||
|
||||
## Done!
|
||||
^[Top](#top)
|
||||
|
||||
Now you're ready to follow the [compilation instructions](/doc/md/Use_of_Proxmark/0_Compilation-Instructions.md).
|
||||
|
||||
|
|
@ -96,9 +123,13 @@ It has excellent instructions to follow.
|
|||
WSL 1 requires to run on Windows 10 version 1709 or above. Previous windows versions didn't have support for COM ports.
|
||||
|
||||
### Stay away from WSL 2
|
||||
^[Top](#top)
|
||||
|
||||
*Microsoft introduced WSL 2 starting on Windows 10 version 2004 with Hyper-V powering its virtualization; As of 2020-08-13, WSL 2 does not support USB and Serial.*
|
||||
|
||||
### More about WSL
|
||||
^[Top](#top)
|
||||
|
||||
Install WSL 1 with e.g. the standard Ubuntu. You can follow the guide on [Microsoft Docs](https://docs.microsoft.com/en-us/windows/wsl/install-win10) but be careful to follow WSL 1 specific instructions! When they recommend you to restart, you must restart.
|
||||
|
||||
For WSL configuration, see [Manage and configure Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/wsl-config).
|
||||
|
|
@ -106,6 +137,7 @@ For WSL configuration, see [Manage and configure Windows Subsystem for Linux](ht
|
|||
Make sure your WSL can launch Windows processes to get the `pm3` scripts working (cf `interop` in the WSL settings).
|
||||
|
||||
## X Server Installation
|
||||
^[Top](#top)
|
||||
|
||||
If you want to run the graphical components of the Proxmark3 client, you need to install a X Server such as in the list below, and launch it, e.g. by executing XLaunch.
|
||||
* [VcXsrv](https://sourceforge.net/projects/vcxsrv/)
|
||||
|
|
@ -113,11 +145,14 @@ If you want to run the graphical components of the Proxmark3 client, you need to
|
|||
|
||||
|
||||
## Windows Terminal Installation
|
||||
^[Top](#top)
|
||||
|
||||
Microsoft has recently released a new terminal for their OS. It is much better experience than old `cmd.exe` so we strongly recommend installing it.
|
||||
It is also open sourced (see [github.com/microsoft/terminal](https://github.com/microsoft/terminal)). You can download and install from [GitHub](https://github.com/microsoft/terminal/releases/latest) or [Microsoft Store](https://www.microsoft.com/en-us/p/windows-terminal/9n0dx20hk701).
|
||||
|
||||
|
||||
## Dependencies
|
||||
^[Top](#top)
|
||||
|
||||
Enter WSL prompt (`wsl` or Start Windows Terminal with `wt`) and from there, follow the [Linux Installation Instructions](/doc/md/Installation_Instructions/Linux-Installation-Instructions.md) for Ubuntu, summarized here below:
|
||||
|
||||
|
|
@ -140,12 +175,14 @@ If you don't need the graphical components of the Proxmark3 client, you can skip
|
|||
If you don't need support for Python3 scripts in the Proxmark3 client, you can skip the installation of `libpython3-dev`.
|
||||
|
||||
## Clone the RRG/Iceman repository
|
||||
^[Top](#top)
|
||||
|
||||
```sh
|
||||
git clone https://github.com/RfidResearchGroup/proxmark3.git
|
||||
```
|
||||
|
||||
## Compile and use the project
|
||||
^[Top](#top)
|
||||
|
||||
To use the compiled client, the only difference is that the Proxmark3 port is translated from your `comX` port where **"X"** is the com port number assigned to proxmark3 under Windows, to a `/dev/ttySX`, so commands become:
|
||||
|
||||
|
|
@ -181,6 +218,7 @@ echo "export DISPLAY=:0" >> ~/.bashrc
|
|||
Note that it may take a quite long time for a freshly plugged Proxmark3 to be visible on a WSL /dev/ttySX port.
|
||||
|
||||
## Done!
|
||||
^[Top](#top)
|
||||
|
||||
Now you're ready to follow the [compilation instructions](/doc/md/Use_of_Proxmark/0_Compilation-Instructions.md).
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue