Skip to content

madisoncfallin/ModFinder

 
 

Repository files navigation

ModFinder

Download zip Latest Release

A tool for browsing and managing Pathfinder: Wrath of the Righteous mods and their dependencies.

Screenshot

Features

  • Browse mods hosted on Nexus and GitHub
  • Detects out of date mods
  • Automatically installs mods hosted on GitHub
  • Enable / disable mods
  • Detects missing dependencies, enabling one-click install (mods on GitHub) or download link (mods on Nexus)
  • Uninstall mods
  • Rollback mod updates
  • And more

For Users

Download zip the latest release, extract the folder, and run ModFinder.exe!

You must have .NET Destkop Runtime 5.0 or later installed.

You must have installed UnityModManager.

If it doesn't work, see Troubleshooting.

Tips:

  • Searching checks mod name and author by default
  • You can search specifically name, author, or tag:
    • a:bub to include authors with "bub" in their name, or -a:bub to exclude them
    • n:super to include mods with "super" in the name, or -n:super to exclude them
    • t:game to include tags with "game" in their name, or -n:game to exclude them
  • Version updates are checked every 30 minutes, but you need to restart the app to get the latest version data
    • If the latest version is for a more recent game version (e.g beta) it will install it even if it doesn't work with your local version
  • When you open it mods missing pre-requisites are shown first, followed by mods with an update available
  • The overflow menu has more functionality like viewing the changelog, description, and homepage
  • When you update a mod using ModFinder you can revert to the previous version, open the overflow menu and select "Rollback"

Missing a mod?

Ask the mod developer to add it or file an issue.

For Mod Devs

Currently ModFinder only supports UMM mods hosted on Nexus or GitHub.

To add (or change details about) your mod:

  1. Update internal_manifest.json
    • Don't include any version data or description, this is automatically updated roughly every 2 hours
    • You can submit a PR or file an issue

That's it! The manifest format is documented in the code.

Make sure to apply the appropriate tags so users can find your mod.

Assumptions for GitHub:

  • The first release asset is a zip file containing the mod (i.e. what a user would drag into UMM)
  • Your releases are tagged with a version string in the format 1.2.3e. Prefixes are ignored.
    • If there's a mismatch between your GitHub tag version and Info.json version it will think the mod is always out of date

If necessary you can host your own ModManifest JSON file by adding a direct download link to ExternalManifestUrls in master_manifest.json. Keep in mind, this will not be automatically updated so it is up to you to populate description and version info.

Want your mod removed from the list?

File an issue or submit a PR.

Troubleshooting

  • Make sure you have UnityModManager installed
    • Run it and set it up for use with Wrath
  • Make sure you have .NET Destkop Runtime 5.0 or later installed
    • .NET 6.0 and soon .NET 7.0 should work as well, but if not try the link above
    • .NET 5.0 is not the same thing as the .NET Runtime 5.0 which is not the same thing as the .NET Desktop Runtime 5.0; if you think already have .NET 5.0 or 6.0 installed and it isn't working, try that specific link
  • Try running it as an Administrator
  • Make sure your anti-virus is not blocking it
    • Some anti-virus flags it as a trojan
      • ModFinder sends requests to GitHub to download mod metadata and mods themselves
      • ModFinder also writes files (logs) and deletes, moves, and unzips files related to mods you have installed
    • Update changelog includes a sha1 hash you can use to verify your download
    • Here are the scan results for v1.1 on VirusTotal
  • File an issue or reach out on Discord
    • Share your log file: %UserProfile%\AppData\Local\Modfinder\Log.txt

Problems with a mod?

If there's an issue installing, downloading, displaying information about, or anything else regarding a specific mod file an issue. That includes mods that no longer work and are abandoned.

Other issues?

You guessed it: file an issue. Include your log file: %UserProfile%\AppData\Local\Modfinder\Log.txt.

Acknowledgements

  • Barley for starting this project in the first place (ModFinder_WOTR) and working with Bubbles to complete like 80% before I decided to finish it
  • Bubbles for his excellent work on the UI styling and Barley for handling the GitHub action setup
  • The modding community on Discord, an invaluable and supportive resource for help modding.
  • All the Owlcat modders who came before me, wrote documents, and open sourced their code.

Interested in modding?

About

A tool for installing Pathfinder: Wrath of the Righteous mods and their dependencies.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 99.9%
  • HTML 0.1%