README.md

me³

A framework for modifying and instrumenting games.
Explore the docs »

Report Bug · Request Feature

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

About The Project

TODO: write me

(back to top)

Built With

• Rust
• Many others...

(back to top)

Getting Started

me3 is a launcher and mod loader for the Dark Souls series of games from FROMSOFTWARE and similar titles.

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: while me3 can be built against mingw64, this generally isn't recommended. Instead acquire the Windows SDK using xwin

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

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

    [target.x86_64-pc-windows-msvc]
    linker = "lld"
    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

   TODO: fix these instructions.

(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.
• Elden Ring Reforged - provided invaluable feedback on the end-user perspective

(back to top)