README.md

unity-rs

A Library for interacting with unity at runtime
Explore the docs »

View Demo · Report Bug · Request Feature

About

THIS REPO IS MOVING!

Unity-rs provides an abstracted api to interact with Unity Games at runtime. It supports both Mono & Il2cpp, and will automatically detect which the game is running in.
By using this library, you will mostly not have to concern yourself with the specifics of the implementation, and can just interact with the game. Of course, we also expose internal things, such as function pointers to mono/il2cpp functions, in case you need to hook them.

(back to top)

Getting Started

This project is mostly aimed at the use case for modding, so please take care of injecting a rust cdylib into the unity game.

Installation

Simply add it to your Cargo.toml:

unity-rs = { git = "https://github.com/RinLovesYou/unity-rs.git" }

The Project is currently not in a state where i am confident to publish to Crates.io

(back to top)

Usage

Under Construction

(back to top)

Roadmap

• Mono/Old Mono
• Il2cpp
• Custom Dobby wrapper, with integration

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the Apache-2.0 License. See LICENSE.txt for more information.

(back to top)

Contact

RinLovesYou - @does_rin - [email protected] - Rin#6969 (Discord)

(back to top)