/Mecha

🚀 Mecha - debugger and custom plugin loader for the League of Legends client

Primary LanguageC++MIT LicenseMIT

Mecha Header
Mecha - debugger and custom plugin loader for the League of Legends client

Usage

To use Mecha you must compile it first. See this for more information.


Once compiled, you can open the Mecha GUI via the Mecha GUI.exe file, where you can then manage debug settings and plugins. Other .exe and .dll files are merely dependencies.


As the description may already suggest, Mecha allows you to completely debug the client from top to bottom. It also gives you a chance to inject your own JavaScript code and resources into the League of Legends client.


The Mecha GUI makes this all simple and features functionality for:

  • Hooking and Unhooking your client
  • Retrieving the DevTools URL
  • Injecting custom JavaScript "plugins" into the client
  • Customizing hook settings

Installation

  1. Build or download a compiled version of Mecha
  2. Launch your LoL client
  3. Launch Mecha GUI.exe
  4. Press "Hook" (Note: Only once is enough. Your client will be hooked until you unhook.)
  5. Relaunch your client

Using Mecha is simple. Clicking around in the GUI should answer all of your questions, but in case something goes wrong, you can always create an issue.


Development

Building Mecha from Source

  1. Clone the repository git clone https://github.com/x00bence/Mecha.git
  2. Build the solution with Visual Studio 2019 using the default Release | x86 configuration. (Note: Will NOT compile with other configurations by default)

JavaScript Plugins

As noted in above sections, you also have the possibility to develop JavaScript "plugins" that will get executed in the scope of the client. This allows you to directly modify resources, hook and override internal JavaScript, dump data, and more. Mecha tries to be unopinionated and provides no API by default for creating plugins. It's up to the developers to reverse engineer the client, create an API, design the lifecycle flow, and decide the bundling process.


Plugins can be installed simply by dragging and dropping them into your chosen "plugins" folder. Plugins are loaded from said folder every time you load or refresh your client. Refer to the Mecha GUI for more information.


Roadmap in order of priority

  • ⚙️ Add support for plugin initialization ordering, exclusions, and more opt-in settings
  • 🔊 Add error logging, improve fault tolerance
  • 🔍 Support for resource replacing
  • 🚀 Minimalist API/Example plugins
  • ✨ Prettier GUI

Acknowledgements

Mecha has been heavily inspired and influenced by Ace and a Hackathon-created patch diff tool. Although Mecha has different intentions, these two tools ultimately gave the idea to create Mecha. Big shoutouts.


License

Mecha is licensed under the MIT license.


See the LICENSE file for more details.