Ferrex

<!-- Improved compatibility of back to top link: See: https://github.com/RinLovesYou/Ferrex/pull/73 -->

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

<!-- *** Thanks for checking out the Best-README-Template. If you have a suggestion *** that would make this better, please fork the repo and create a pull request *** or simply open an issue with the tag "enhancement". *** Don't forget to give the project a star! *** Thanks again! Now go create something AMAZING! :D --> <!-- PROJECT SHIELDS --> <!-- *** I'm using markdown "reference style" links for readability. *** Reference links are enclosed in brackets [ ] instead of parentheses ( ). *** See the bottom of this document for the declaration of the reference variables *** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use. *** https://www.markdownguide.org/basic-syntax/#reference-style-links -->

<!-- PROJECT LOGO --> <br /> <div align="center"> <a href="https://github.com/RinLovesYou/Ferrex"> <img src="images/logo.png" alt="Logo" width="80" height="80"> </a> <h3 align="center">Ferrex</h3> <p align="center"> A Cross-Platform Unity Modding framework written in pure Rust <br /> <a href="https://github.com/RinLovesYou/Ferrex"><strong>Explore the docs »</strong></a> <br /> <br /> <a href="https://github.com/RinLovesYou/Ferrex">View Demo</a> · <a href="https://github.com/RinLovesYou/Ferrex/issues">Report Bug</a> · <a href="https://github.com/RinLovesYou/Ferrex/issues">Request Feature</a> </p> </div> <!-- ABOUT THE PROJECT -->

About

Ferrex is a work in progress cross-platform unity modding framework written entirely in rust

<!-- GETTING STARTED -->

Getting Started

TODO

Installation

TODO

<!-- USAGE EXAMPLES -->

Usage

TODO

<!-- ROADMAP -->

Roadmap

• [x] Injection
• [ ] Modding API

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

<!-- CONTRIBUTING -->

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

<!-- CONTACT -->

Contact

RinLovesYou - @does_rin - rin@pepsi.group - Rin#6969 (Discord)

<!-- MARKDOWN LINKS & IMAGES --> <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->