Skip to content

Latest commit

 

History

History
147 lines (96 loc) · 8.98 KB

README.md

File metadata and controls

147 lines (96 loc) · 8.98 KB
Raw

Media Preservation Frontend (MPF)

Redumper/Aaru/DiscImageCreator UI in C#

Build status UI Build CLI Build Check Build

This is a community project, so if you have some time and knowledge to give, we'll be glad to add you as a contributor to this project. If you have any suggestions, issues, bugs, or crashes, please look at the Issues page first to see if it has been reported before and try out the latest AppVeyor WIP build below to see if it has already been addressed. If it hasn't, please open an issue that's as descriptive as you can be. Help me make this a better program for everyone :)

Releases

For the most recent stable build, download the latest release here: Releases Page

For the latest WIP build here: Rolling Release

Media Preservation Frontend UI (MPF.UI)

MPF is the main, UI-centric application of the MPF suite. This program allows users to use Redumper, Aaru, or DiscImageCreator in a more user-friendly way. Each backend dumping program is supported as fully as possible to ensure that all information is captured on output. There are many customization options and quality of life settings that can be access through the Options menu.

UI Support Limitations

The main UI has some known limitations that are documented in code and in some prior support tickets:

  • Windows-only due to reliance on WPF and Winforms
    • MAUI is not a viable alternative due to lack of out-of-box support for Linux
    • Avalonia is being heavily considered as an alternative
  • For those who need .NET Framework 4.8, there is an official fork: MPF Legacy
  • For those who require broader archive/installer compatibility for protection scanning (Windows-only), please use the x86 builds as there are some specific scanning libraries that only work with that build
    • This is actively being worked on as part of Binary Object Scanner
    • Please consider contributing if you have experience in dealing with multiple archive and installer types
    • Consider using a third-party scanning tool, such as Protection ID, if this is not sufficient for your needs
    • See Compatibility Notes for more details

Media Preservation Frontend CLI (MPF.CLI)

MPF.CLI is a commandline-only program that allows users to use Redumper, Aaru, or DiscImageCreator in a more user-friendly way. Each backend dumping program is supported as fully as possible to ensure that all information is captured on output. There are many customization options and quality of life settings that can be access through the config.json file.

CLI Support Limitations

The main CLI has some known limitations that are documented in code and in some prior support tickets:

  • No programs are bundled by default
    • This is the result of the extremely varied builds that are allowed
  • For those who require broader archive/installer compatibility for protection scanning (Windows-only), please use the x86 builds as there are some specific scanning libraries that only work with that build
    • This is actively being worked on as part of Binary Object Scanner
    • Please consider contributing if you have experience in dealing with multiple archive and installer types
    • Consider using a third-party scanning tool, such as Protection ID, if this is not sufficient for your needs
    • See Compatibility Notes for more details

Media Preservation Frontend Checker (MPF.Check)

MPF.Check is a commandline-only program that allows users to generate submission information from their personal rips. This program supports the outputs from Redumper, Aaru, DiscImageCreator, Cleanrip, and UmdImageCreator. Running this program without any parameters will display the help text, including all supported parameters.

System Requirements

MPF.UI, MPF.CLI, and MPF.Check have the same system requirements for running, with the exception that MPF.UI is Windows-only.

Ensure that your operating system and runtimes are as up-to-date as possible, since some features may rely on those updates.

Build Instructions

To build for .NET 9.0, ensure that the .NET 9.0 SDK (or later) is installed and included in your PATH. Then, run the following commands from command prompt, Powershell, Terminal, or shell:

MPF.UI (Windows only):

dotnet build MPF/MPF.csproj --framework net9.0-windows --runtime [win-x86|win-x64]

MPF.CLI (Windows, OSX, Linux):

dotnet build MPF.CLI/MPF.CLI.csproj --framework net9.0 --runtime [win-x86|win-x64|win-arm64|linux-x64|linux-arm64|osx-x64|osx-arm64]

MPF.Check (Windows, OSX, Linux):

dotnet build MPF.Check/MPF.Check.csproj --framework net9.0 --runtime [win-x86|win-x64|win-arm64|linux-x64|linux-arm64|osx-x64|osx-arm64]

Choose one of win-x86, win-x64, win-arm64, linux-x64, linux-arm64, osx-x64, or osx-arm64 depending on the machine you are targeting.

Build Scripts

Windows users may run publish-win.ps1 and Linux users may run publish-nix.sh to perform a full release build. Both scripts will build and package all variants of MPF.UI, MPF.CLI, and MPF.Check with commandline switches to control what is included.

Information

For all additional information, including information about the individual components included in the project and what dumping programs are supported, please see the wiki for more details.

Changelist

A list of all changes in each stable release and current WIP builds can now be found here.

External Libraries

MPF uses some external libraries to assist with additional information gathering after the dumping process.

  • Binary Object Scanner - Protection scanning - GitHub
  • WPFCustomMessageBox.thabse - Custom message boxes in UI - GitHub

Contributors

Here are the talented people who have contributed to the project so far in ways that GitHub doesn't like to track:

  • ReignStumble - Former Project Lead / UI Design
  • Shadów - UI Support

For all others who have contributed in some way, please see here.

Notable Testers

These are the tireless individuals who have dedicated countless hours to help test the many features of MPF and have worked with the development team closely:

Community Shout-Outs

Thanks to these communities for their use, testing, and feedback. I can't even hope to be able to thank everyone individually.