mirror of https://github.com/WerWolv/ImHex.git
129 lines
5.6 KiB
Markdown
129 lines
5.6 KiB
Markdown
# ImHex
|
|
|
|
A Hex Editor for Reverse Engineers, Programmers and people that value their eye sight when working at 3 AM.
|
|
|
|
## Supporting
|
|
|
|
If you like my work, consider supporting me on GitHub Sponsors, Patreon or PayPal. Thanks a lot!
|
|
|
|
<a href="https://github.com/sponsors/WerWolv"><img src="https://werwolv.net/assets/github_banner.png" alt="GitHub donate button" /> </a>
|
|
<a href="https://www.patreon.com/werwolv"><img src="https://c5.patreon.com/external/logo/become_a_patron_button.png" alt="Patreon donate button" /> </a>
|
|
<a href="https://werwolv.net/donate"><img src="https://werwolv.net/assets/paypal_banner.png" alt="PayPal donate button" /> </a>
|
|
|
|
## Features
|
|
|
|
- Featureful hex view
|
|
- Byte patching
|
|
- Patch management
|
|
- Copy bytes as feature
|
|
- Bytes
|
|
- Hex string
|
|
- C, C++, C#, Rust, Python, Java & JavaScript array
|
|
- ASCII-Art hex view
|
|
- HTML self contained div
|
|
- String and hex search
|
|
- Colorful highlighting
|
|
- Goto from start, end and current cursor position
|
|
- Custom C++-like pattern language for parsing highlighting a file's content
|
|
- Automatic loading based on MIME type
|
|
- arrays, pointers, structs, unions, enums, bitfields, using declarations, litte and big endian support
|
|
- Useful error messages, syntax highlighting and error marking
|
|
- Data importing
|
|
- Base64 files
|
|
- IPS and IPS32 patches
|
|
- Data exporting
|
|
- IPS and IPS32 patches
|
|
- Data Exporting
|
|
- Data inspector allowing interpretation of data as many different types (little and big endian)
|
|
- Huge file support with fast and efficient loading
|
|
- Strings search
|
|
- Copying of strings
|
|
- Copying of demangled strings
|
|
- File hashing support
|
|
- CRC16 and CRC32 with custom initial values and polynomials
|
|
- MD4, MD5
|
|
- SHA-1, SHA-224, SHA-256, SHA-384, SHA-512
|
|
- Disassembler supporting many different architectures
|
|
- ARM32 (ARM, Thumb, Cortex-M, aarch32)
|
|
- ARM64
|
|
- MIPS (MIPS32, MIPS64, MIPS32R6, Micro)
|
|
- x86 (16 bit, 32 bit, 64 bit)
|
|
- PowerPC (32 bit, 64 bit)
|
|
- Sparc
|
|
- SystemZ
|
|
- XCore
|
|
- M68K
|
|
- TMS320C64X
|
|
- M680X
|
|
- Ethereum
|
|
- Bookmarks
|
|
- Region highlighting
|
|
- Comments
|
|
- Data Analyzer
|
|
- File magic based file parser and MIME type database
|
|
- Byte distribution graph
|
|
- Entropy graph
|
|
- Highest and avarage entropy
|
|
- Encrypted / Compressed file detection
|
|
- Helpful tools
|
|
- Itanium and MSVC demangler
|
|
- ASCII table
|
|
- Regex replacer
|
|
- Mathematical expression evaluator (Calculator)
|
|
- Hexadecimal Color picker
|
|
- Built-in cheat sheet for pattern language and Math evaluator
|
|
- Doesn't burn out your retinas when used in late-night sessions
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
|
|
## Additional Files
|
|
|
|
For format patterns, includable libraries and magic files, check of the [ImHex-Patterns](https://github.com/WerWolv/ImHex-Patterns) repository here. Feel free to PR your own files there as well!
|
|
|
|
## Compiling
|
|
|
|
This guide assumes you're either on Windows using mingw or on Arch Linux
|
|
|
|
You need a C++20 compatible compiler such as GCC 10.2.0 to compile ImHex.
|
|
The following libraries are needed to compile ImHex. All of them can be found in the default pacman repositories
|
|
```
|
|
GLFW3 ( (sudo) pacman -S glfw )
|
|
libmagic, libgnurx, libtre, libintl, libiconv ( (sudo) pacman -S file )
|
|
libcrypto ( (sudo) pacman -S openssl )
|
|
capstone ( (sudo) pacman -S capstone )
|
|
libLLVMDemangle ( (sudo) pacman -S llvm llvm-libs )
|
|
nlohmann json ( (sudo) pacman -S nlohmann-json )
|
|
Python3 ( (sudo) pacman -S python3 )
|
|
|
|
All in one: sudo pacman -S glfw file openssl capstone llvm llvm-libs nlohmann-json python3
|
|
All in one for mingw: pacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-cmake mingw-w64-x86_64-make mingw-w64-x86_64-capstone mingw-w64-x86_64-glfw mingw-w64-x86_64-glm mingw-w64-x86_64-file mingw-w64-x86_64-llvm mingw-w64-x86_64-nlohmann-json mingw-w64-x86_64-openssl mingw-w64-x86_64-polly mingw-w64-x86_64-python
|
|
```
|
|
|
|
After all the libraries are installed, run the following commands to build ImHex
|
|
```
|
|
mkdir build
|
|
cd build
|
|
cmake ..
|
|
make -j
|
|
```
|
|
|
|
On Windows, download the python standard library from https://github.com/python/cpython/tree/master/Lib and place the files and folders in `lib/python3.8` next to your built executable. Don't forget to also copy the `libpython3.8.dll` and `libwinpthread-1.dll` from your mingw setup next to the executable.
|
|
|
|
On both Windows and Linux, copy the files from `python_libs` in the `lib` folder next to your built executable.
|
|
Place your magic databases in the `magic` folder next to your built executable
|
|
Place your patterns in the `pattern` folder next to your built executable
|
|
Place your include pattern files in the `include` folder next to your built executable
|
|
|
|
## Credits
|
|
|
|
- Thanks a lot to ocornut for their amazing [Dear ImGui](https://github.com/ocornut/imgui) which is used for building the entire interface
|
|
- Thanks to orconut as well for their hex editor view used as base for this project.
|
|
- Thanks to BalazsJako for their incredible [ImGuiColorTextEdit](https://github.com/BalazsJako/ImGuiColorTextEdit) used for the pattern language syntax highlighting
|
|
- Thanks to AirGuanZ for their amazing [imgui-filebrowser](https://github.com/AirGuanZ/imgui-filebrowser) used for loading and saving files
|
|
- Thanks to nlohmann for their [json](https://github.com/nlohmann/json) library used for project files
|
|
- Thanks to aquynh for [capstone](https://github.com/aquynh/capstone) which is the base of the disassembly window
|
|
|