me³

A framework for modifying and instrumenting games.

Report Bug · Request Feature

• About The Project
  • Supported platforms
  • Supported games
• Installation
• Developer Quickstart
  • Prerequisites
  • Usage
• Contributing
• License
• Contact
• Acknowledgments
• Sponsors
  • Sentry
  • Crowdin

About The Project

me3 is a tool that extends the functionality of FROMSOFTWARE games.

Supported platforms

• Windows
• Linux via Proton
• macOS via CrossOver®

Supported games

• DARK SOULS III
• Sekiro: Shadows Die Twice
• ELDEN RING
• Armored Core VI: Fires of Rubicon
• ELDEN RING NIGHTREIGN

Installation

Important

Follow the user guide

(back to top)

Developer Quickstart

Prerequisites

• Cargo

  • Windows: download and run rustup‑init.exe 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: Acquire the Windows SDK using xwin

    cargo install xwin && xwin --accept-license splat --output ~/.xwin

    And configure Cargo to link with lld-link and use the binaries from xwin in ~/.cargo/config.toml

    [target.x86_64-pc-windows-msvc]
    linker = "lld-link"
    runner = "wine"
    rustflags = [
      "-Lnative=/home/gtierney/.xwin/crt/lib/x86_64",
      "-Lnative=/home/gtierney/.xwin/sdk/lib/um/x86_64",
      "-Lnative=/home/gtierney/.xwin/sdk/lib/ucrt/x86_64"
    ]

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 -p me3-cli -- launch -g elden-ring

   (back to top)

Contributing

See CONTRIBUTING.md

License

With the exception of the me3 logo, this project is distributed under the terms of both the Apache Software License 2.0 and MIT License. See LICENSE-APACHE and LICENSE-MIT for more information.

The me3 logo is not available under any license - all rights are reserved.

(back to top)

Contact

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

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

Discord

(back to top)

Acknowledgments

• Mod Engine - prior art for runtime modification of FROMSOFTWARE games.
• Mod Organizer 2 - inspiration for the VFS framework.
• Elden Ring Reforged - provided invaluable feedback on the end-user perspective
• Dasaav - work on compatibility across a variety of FROMSOFTWARE titles.
• Skadi - me3 icon artwork

Sponsors

We are grateful for the generous support of our sponsors.

SignPath.io

For the Windows binary, free code signing provided by SignPath.io, certificate by SignPath Foundation.

See our code signing policy

Sentry

Crowdin

(back to top)