1
0
Fork 0
x64dbg/README.md

121 lines
4.9 KiB
Markdown
Raw Normal View History

2015-04-10 07:51:35 +08:00
# x64dbg
2015-12-29 20:56:43 +08:00
[![BountySource](https://www.bountysource.com/badge/team?team_id=18188&style=raised)](https://www.bountysource.com/teams/x64dbg?utm_source=x64dbg&utm_medium=shield&utm_campaign=raised) [![Telegram](http://i.imgur.com/merFyCf.png)](https://telegram.me/joinchat/BzwLaQcORqjkM1k9YbTNmg) [![Join the chat at Gitter](https://badges.gitter.im/x64dbg/x64dbg.svg)](https://gitter.im/x64dbg/x64dbg?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![freenode](http://i.imgur.com/JEG5fJr.png)](http://webchat.freenode.net/?channels=x64dbg) [![Jenkins](http://jenkins.x64dbg.com/job/vs13/badge/icon)](http://jenkins.x64dbg.com) [![coverity](https://scan.coverity.com/projects/7478/badge.svg?flat=1)](https://scan.coverity.com/projects/7478/badge.svg?flat=1)
2015-12-30 05:42:12 +08:00
2014-07-05 06:20:15 +08:00
## Note
2015-12-29 20:56:43 +08:00
2015-06-27 14:18:27 +08:00
Please run `install.bat` before you start committing code, this ensures your code is auto-formatted to the *x64dbg* [standards](https://github.com/x64dbg/x64dbg/wiki/Coding-Guidelines).
2014-12-21 20:22:58 +08:00
## Compiling
2015-12-29 20:56:43 +08:00
2015-04-13 04:35:12 +08:00
For a complete guide on compiling *x64dbg* read [this](https://github.com/x64dbg/x64dbg/wiki/Compiling the whole project).
2014-08-05 06:29:46 +08:00
2014-07-05 06:20:15 +08:00
## Downloads
2015-12-29 20:56:43 +08:00
Releases of *x64dbg* can be found [here](http://releases.x64dbg.com).
2014-12-21 20:22:58 +08:00
Jenkins build server can be found [here](http://jenkins.x64dbg.com).
2014-07-05 06:20:15 +08:00
## Overview
2015-12-29 20:56:43 +08:00
2015-04-10 07:51:35 +08:00
*x64dbg* is an open-source x32/x64 debugger for Windows.
2014-07-05 06:20:15 +08:00
## Activity Graph
[![Throughput Graph](https://graphs.waffle.io/x64dbg/x64dbg/throughput.svg)](https://waffle.io/x64dbg/x64dbg/metrics/throughput)
2014-07-05 06:20:15 +08:00
## Features
2015-12-29 20:56:43 +08:00
2014-07-05 06:20:15 +08:00
- Open-source
- Intuitive and familiar, yet new user interface
- C-like expression parser
- Full-featured debugging of DLL and EXE files (TitanEngine)
- IDA-like sidebar with jump arrows
- IDA-like instruction token highlighter (highlight registers, etc.)
- Memory map
- Symbol view
- Thread view
2015-04-13 06:38:43 +08:00
- Source code view
2014-07-05 06:20:15 +08:00
- Content-sensitive register view
- Fully customizable color scheme
- Dynamically recognize modules and strings
- Import reconstructor integrated (Scylla)
2015-11-08 13:40:47 +08:00
- Fast disassembler (Capstone)
2014-07-05 06:20:15 +08:00
- User database (JSON) for comments, labels, bookmarks, etc.
- Plugin support with growing API
- Extendable, debuggable scripting language for automation
- Multi-datatype memory dump
- Basic debug symbol (PDB) support
- Dynamic stack view
2016-06-13 06:07:05 +08:00
- Built-in assembler (XEDParse/Keystone)
2015-04-13 06:38:43 +08:00
- Executable patching
2015-05-08 06:25:32 +08:00
- Yara Pattern Matching
2015-11-08 13:40:47 +08:00
- Decompiler (Snowman)
- Analysis
2014-07-05 06:20:15 +08:00
## License
2015-12-29 20:56:43 +08:00
2015-05-02 18:19:55 +08:00
*x64dbg* is licensed under GPLv3, which means you can freely distribute and/or modify the source of *x64dbg*, as long as you share your changes with us. The only exception is that plugins you write do not have to comply with the GPLv3 license. They do not have to be open-source and they can be commercial and/or private. The only exception to this is when your plugin uses code copied from *x64dbg*. In that case you would still have to share the changes to *x64dbg* with us.
2014-07-05 06:20:15 +08:00
## Credits
2015-12-29 20:56:43 +08:00
2016-04-09 19:21:58 +08:00
- Debugger core by [TitanEngine Community Edition](https://bitbucket.org/titanengineupdate/titanengine-update)
2015-11-08 13:40:47 +08:00
- Disassembly powered by [Capstone](http://capstone-engine.org)
2014-12-21 20:22:58 +08:00
- Assembly powered by [XEDParse](https://bitbucket.org/mrexodia/xedparse)
- Import reconstruction powered by [Scylla](https://github.com/NtQuery/Scylla)
- JSON powered by [Jansson](http://www.digip.org/jansson)
- Database compression powered by [lz4](https://bitbucket.org/mrexodia/lz4)
- Bug icon by [VisualPharm](http://www.visualpharm.com)
- Interface icons by [Fugue](http://p.yusukekamiyamane.com)
2015-05-08 06:25:32 +08:00
- Website by [tr4ceflow](http://tr4ceflow.com)
2014-07-05 06:20:15 +08:00
## Special Thanks
2015-12-29 20:56:43 +08:00
- All the donators!
- Everybody adding issues!
- People I forgot to add to this list
2014-12-21 20:22:58 +08:00
- [EXETools community](http://forum.exetools.com)
- [Tuts4You community](http://forum.tuts4you.com)
- [ReSharper](https://www.jetbrains.com/resharper)
- [Coverity](http://www.coverity.com)
2014-07-05 06:20:15 +08:00
- acidflash
- cyberbob
- cypher
2014-07-05 06:20:15 +08:00
- Teddy Rogers
2014-07-30 05:29:31 +08:00
- TEAM DVT
2014-07-05 06:20:15 +08:00
- DMichael
- Artic
- ahmadmansoor
- \_pusher\_
- firelegend
2014-07-05 06:20:15 +08:00
## Developers
2015-12-29 20:56:43 +08:00
- [mrexodia](http://mrexodia.cf)
2014-07-05 06:20:15 +08:00
- Sigma
2014-11-12 02:46:52 +08:00
- [tr4ceflow](http://blog.tr4ceflow.com)
2015-04-10 07:51:35 +08:00
- [Dreg](http://www.fr33project.org)
2015-12-29 20:56:43 +08:00
- [Nukem](https://github.com/Nukem9)
- [Herz3h](https://github.com/Herz3h)
## Contributers
- [torusrxxx](https://github.com/torusrxxx)
- [blaquee](https://github.com/blaquee)
- [wk-952](https://github.com/wk-952)
- [RaMMicHaeL](http://rammichael.com)
- [lovrolu](https://github.com/lovrolu)
- [fileoffset](https://github.com/fileoffset)
- [SmilingWolf](https://github.com/SmilingWolf)
- [ApertureSecurity](https://github.com/ApertureSecurity)
- [mrgreywater](https://github.com/mrgreywater)
- [Dither](https://github.com/Dither)
- [zerosum0x0](https://github.com/zerosum0x0)
- [RadicalRaccoon](https://github.com/RadicalRaccoon)
- [fetzerms](https://github.com/RadicalRaccoon)
- [muratsu](https://github.com/RadicalRaccoon)
- [ForNeVeR](https://github.com/RadicalRaccoon)
2016-06-03 21:08:08 +08:00
- [wynick27](https://github.com/wynick27)
- [Atvaark](https://github.com/Atvaark)
2016-06-09 23:45:38 +08:00
- [Avin](https://github.com/Avinm)