Rusty Hearts MIP Tool

A c# command-line tool for compressing and decompressing Rusty Hearts Patch files (.MIP).

Preview

Getting Started

To get started with this tool, simply download the latest release from the GitHub repository.

Usage

Ensure that the input files to be compressed/decompressed are located in the "Input" folder within the program directory.
Run the program.
Choose one of the following options:
- 1. Compress to MIP: Compress files to MIP format.
- 2. Decompress MIP: Decompress MIP files.
- 3. Compress files: Compress files to ZIP format, can be used for creating client download files.
- 4. Generate filelist - Generate a filelist of files in the 'Input' folder with name, size and hash
- 5. Exit: Quit the program.
The resulting files will be located in the "Output" folder within the program directory.

Client patch

Place the MIP files and filelist in the patch directory of the Rusty Hearts API to patch the client using the Rusty Hearts Launcher.

Client ZIP files

Place the ZIP files and filelist in the download/client directory of the Rusty Hearts API to download the client using the Rusty Hearts Launcher.

Prerequisites for Building Locally/Development

The tool is built in .NET 7 and as such, the packages listed below are required to create a local and development build of the tool. Furthermore, it uses many submodules and packages outside of this, which will automatically be loaded when the user sets up a local environment of the application.

Visual Studio 2022 (Any Edition - 17.4 or later)
Windows 10 SDK (10.0.19043.0) or Windows 11 SDK (10.0.22000.0) via Visual Studio Installer
.NET: .NET Core 7 SDK (7.0.100 or later)

System Requirements for Ready-to-use build

OS: Windows 10 1809 Update (build 17763) or later / Windows 11 (Any builds)
Architecture: x64/AMD64

License

This project is licensed under the terms found in LICENSE-0BSD.

Contributing

Contributions from the community are welcome! If you encounter a bug or have a feature request, please submit an issue on GitHub. If you would like to contribute code, please fork the repository and submit a pull request.

FAQ

Q: How do I report a bug?
- A: Please submit an issue on GitHub with a detailed description of the bug and steps to reproduce it.
Q: How do I request a new feature?
- A: Please submit an issue on GitHub with a detailed description of the feature and why it would be useful.
Q: How do I contribute code?
- A: Please fork the repository, make your changes, and submit a pull request.

Credits

The following third-party libraries, tools, and resources are used in this project:

Support

If you need help with the tool, please submit an issue on GitHub.

watzeedzad / rustyhearts-miptool Goto Github PK