https://github.com/garyttierney/me3
A framework for modding and instrumenting games.
https://github.com/garyttierney/me3
eldenring fromsoftware mod mod-manager modengine nightreign
Last synced: 10 days ago
JSON representation
A framework for modding and instrumenting games.
- Host: GitHub
- URL: https://github.com/garyttierney/me3
- Owner: garyttierney
- License: apache-2.0
- Created: 2022-09-24T15:55:37.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2026-02-23T07:33:58.000Z (16 days ago)
- Last Synced: 2026-02-23T15:48:51.740Z (15 days ago)
- Topics: eldenring, fromsoftware, mod, mod-manager, modengine, nightreign
- Language: Rust
- Homepage: https://me3.help
- Size: 4.49 MB
- Stars: 425
- Watchers: 5
- Forks: 42
- Open Issues: 58
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-APACHE
- Codeowners: CODEOWNERS
- Security: SECURITY.md
- Support: support/config-dist.toml
Awesome Lists containing this project
README
me3
A framework for modifying and instrumenting games.
Report Bug
·
Request Feature
[][discord-invite]
[![Discussions][discussions-shield]][discussions-url]
[![MIT + Apache-2.0 License][license-shield]][license-url]
![GitHub Downloads (all assets, all releases)][downloads-badge]
![GitHub commits since latest release][commits-badge]
- [About The Project](#about-the-project)
- [Supported platforms](#supported-platforms)
- [Supported games](#supported-games)
- [Installation](#installation)
- [Developer Quickstart](#developer-quickstart)
- [Prerequisites](#prerequisites)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
- [Acknowledgments](#acknowledgments)
- [Sponsors](#sponsors)
- [Sentry](#sentry)
- [Crowdin](#crowdin)
## About The Project
me3 is a tool that extends the functionality of FROMSOFTWARE games.
### Supported platforms
- Windows
- Linux via Proton
- macOS via [CrossOver®](https://www.codeweavers.com/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](https://me3.readthedocs.io/en/latest/#quickstart)
## Developer Quickstart
### Prerequisites
- Cargo
- Windows: download and run [rustup‑init.exe][rustup-installer] then follow the onscreen instructions.
- Linux:
```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
- Visual Studio C++ Build Tools
- Windows: download and run [vs_BuildTools.exe][buildtools-installer] then follow the onscreen instructions.
- Linux: Acquire the Windows SDK using `xwin`
```bash
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`
```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
```sh
git clone https://github.com/garyttierney/me3.git
```
2. Build the binaries
```sh
cargo build [--release]
```
3. Attach the sample host DLL to your game
```sh
cargo run -p me3-cli -- launch -g elden-ring
```
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md)
## License
With the exception of the [me3 logo](distribution/assets/me3.ico), this project is distributed under the terms of both the Apache Software License 2.0 and MIT License. See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for more information.
The me3 logo is not available under any license - all rights are reserved.
## Contact
Project Link: [https://github.com/garyttierney/me3](https://github.com/garyttierney/me3)
Discussions Board: [https://github.com/garyttierney/me3/discussions](https://github.com/garyttierney/me3/discussions)
[Discord][discord-invite]
## Acknowledgments
- [Mod Engine](https://github.com/katalash/ModEngine/tree/master/DS3ModEngine) - prior art for runtime modification of FROMSOFTWARE games.
- [Mod Organizer 2](https://github.com/ModOrganizer2/modorganizer/) - inspiration for the VFS framework.
- [Elden Ring Reforged](https://www.nexusmods.com/eldenring/mods/541) - provided invaluable feedback on the end-user perspective
- [Dasaav](https://github.com/dasaav-dsv) - work on compatibility across a variety of FROMSOFTWARE titles.
- [Skadi](https://twitter.com/Skadi_sbw) - [me3 icon](./distribution/assets/me3.png) artwork
## Sponsors
We are grateful for the generous support of our sponsors.
### Sentry
### Crowdin
[discord-invite]: https://discord.gg/3TcDtfShXd
[rustup-installer]: https://static.rust-lang.org/dist/rust-1.87.0-x86_64-pc-windows-msvc.msi
[buildtools-installer]: https://aka.ms/vs/17/release/vs_BuildTools.exe
[discussions-shield]: https://img.shields.io/github/discussions/garyttierney/me3
[discussions-url]: https://github.com/garyttierney/me3/discussions
[contributors-shield]: https://img.shields.io/github/contributors/garyttierney/me3.svg?style=flat
[contributors-url]: https://github.com/garyttierney/me3/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/garyttierney/me3.svg?style=flat
[forks-url]: https://github.com/garyttierney/me3/network/members
[license-shield]: https://img.shields.io/badge/license-MIT%2FApache--2.0-green?style=flat
[license-url]: https://github.com/garyttierney/me3/blob/main/LICENSE-APACHE
[downloads-badge]: https://img.shields.io/github/downloads/garyttierney/me3/total
[commits-badge]: https://img.shields.io/github/commits-since/garyttierney/me3/latest