A framework for modding and instrumenting games.

• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgments

About The Project

TODO: write me

(back to top)

Built With

• Rust
• egui
• egui-d3d11
• mlua
• Many others...

(back to top)

Getting Started

me3 is simply a framework for building a host DLL that performs runtime modifications, however, a sample host is provided that supports Dark Souls 3 and a variety of integrations with the me3 framework. See below for instructions on using it.

Prerequisites

• Cargo
  • Windows: download and run [rustup‑init.exe][rustup-installer] then follow the onscreen instructions.
  • Linux:

    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

• Visual Studio C++ Build Tools
  • Windows: download and run vs_BuildTools.exe then follow the onscreen instructions.
  • Linux: install the mingw64 packages provided by youru distribution. Example (Fedora):

    dnf install mingw64-binutils mingw64-gcc

Usage

1. Clone the repo

   git clone https://github.com/garyttierney/me3.git

2. Build the binaries

   cargo build [--release]

3. Attach the sample host DLL to your game

   cargo run [--release] --package me3_launcher -- DarkSoulsIII.exe

(back to top)

Roadmap

• Script bindings
  • Interactive console
• Game overlay
• Game profiler
• Virtual filesystem
• Runtime binary analysis
  • RTTI recovery
  • Function recovery
  • Function analysis
  • Memory access tracing

(back to top)

Contributing

See CONTRIBUTING.md

License

Distributed under either the Apache Software License 2.0 or MIT License. See LICENSE-APACHE and LICENSE-MIT for more information.

(back to top)

Contact

Project Link: https://github.com/garyttierney/me3

Discussions Board: https://github.com/garyttierney/me3/discussions

(back to top)

Acknowledgments

• Mod Engine - prior art for runtime modification of FROMSOFTWARE games.
• Mod Organizer 2 - inspiration for the VFS framework.

(back to top)