Me3

<!-- markdownlint-disable no-inline-html first-line-h1 -->

<a name="readme-top"></a>

<br /> <div align="center"> <p align="center"> <img src="distribution/assets/me3.png" alt="me3 icon" /> </p> <h2 align="center">me³</h2> <p align="center"> <strong> A framework for modifying and instrumenting games. <br /> <p align="center"> <a href="https://me3.help/en"><img src="https://img.shields.io/badge/Documentation-🇬🇧-darkgrey?style=for-the-badge" alt="English"></a> <a href="https://me3.help/zh"><img src="https://img.shields.io/badge/文档-🇨🇳-darkgrey?style=for-the-badge" alt="文档"></a> <a href="https://me3.help/pl"><img src="https://img.shields.io/badge/Dokumentacja-🇵🇱-darkgrey?style=for-the-badge" alt="Dokumentacja"></a> </p> <a href="https://github.com/garyttierney/me3/discussions/categories/bug-reports">Report Bug</a> · <a href="https://github.com/garyttierney/me3/discussions/categories/ideas">Request Feature</a> </strong> </p>

</div>

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

<!-- ABOUT THE PROJECT -->

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

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- GETTING STARTED -->

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
   

   <p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- CONTRIBUTING -->

Contributing

See CONTRIBUTING.md

<!-- LICENSE -->

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.

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- CONTACT -->

Contact

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

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

Discord

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- ACKNOWLEDGMENTS -->

Acknowledgments

<!-- markdown-link-check-disable -->

• 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

<!-- markdown-link-check-enable -->

Sponsors

We are grateful for the generous support of our sponsors.

Sentry

<a href="https://sentry.io/" target="_blank"><img src="assets/sponsors/sentry-wordmark-dark-200x60.png" alt="Sentry" /></a>

Crowdin

<a href="https://crowdin.com/" target="_blank"><img src="https://support.crowdin.com/assets/logos/plate/png/crowdin-logo-with-plate.png" alt="Crowdin" width="200"/></a>

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- MARKDOWN LINKS & IMAGES --> <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->