Skip to content

piz-ewing/x64dbglua

Repository files navigation

Contributions Welcome GitHub release Github Releases Github All Releases GitHub stars license Language

x64dbglua is a plugin for x64dbg that provides Lua support. The plugin is based on x64dbgPlaytime by ZehMatt and includes additional ideas and features. Currently, the main goal of x64dbglua is to complete automated binding, allowing users to access all functionalities of the x64dbg plugin SDK in Lua. Please note that the project is still in its early stages, and there may be many issues that need to be addressed and improved.

Table Of Contents

Features

Some of the key features and improvements comprise:

  • Enhanced adherence to C++ style
  • Improved readability and ease of debugging, along with enhanced extensibility
  • Addition of more modules
  • Integration with sol2
  • Using xmake
  • Automatic binding (support planned for the future)

Download

Download HERE the latest release of the binaries

Installation

  1. Download the latest version of x64dbg
  2. Extract release.zip to the release directory of x64dbg.
  3. The Lua scripts are located in the release directory.

Tips: release is the directory where x96dbg.exe is located.

Configuration

This will be provided in future versions.

Usage

plugin guid

  1. Enter lua print("hello") in the command line.
  2. Navigate to plugins -> x64dbglua -> Load Lua File.
  3. Navigate to plugins -> x64dbglua -> Reload File.

lua guide

  • Adds lua/libs directory to the package.path.
  • Adds lua/libs/dll/[x86|x64] directory to the package.cpath.
  • Examples can be found in lua/examples.
  • Reference is available in lua/libs/buildin.lua.
  • Recommend using stuartwang.luapanda extension in VSCode as the lua debugger.

Development

Step 1 - Install Visual Studio C++ Build tools

If you have installed Visual Studio, go to the next step.

Click the following link to go to the Visual Studio C++ Build tools page.

Step 2 - Install Visual Studio and choose workload

At least, you should choose Desktop development with C++ and Universal Windows Platform development, If you don't know what the other options do, leave them as default.

Please wait for the installation process to complete before proceeding to the next step.

Step 3 - Install xmake

Click the following link to go to the xmake release page, you should download the file which named xmake-master.win64.exe

Step 4 - Install Git for Windows

Click the following link to go to the Git download page

Step 5 - Clone this project

git clone https://github.com/piz-ewing/x64dbglua.git
cd x64dbglua
git submodule update --init --recursive

Step 6 - Build this project

Now just run xmake -y, xmake should do it all for you!

Other

To-Do Long-Term

  • Automatic binding
  • Advanced interface
  • Unit test

Acknowledgments

Contributing

All contributions are welcome!

Please use the issue tracker to report any bugs or file feature requests.