Pickysaurus commented 2 months ago

This ticket is to keep a running list of features/considerations for adding Collections to the app. This may be broken up into separate tickets when work on this feature starts.

Downloading Collection Metadata

[ ] Interpreting the nxm:// links containing a collection payload.
[ ] Requesting the collection bundle from the Graph API.
[ ] Inspecting the collection bundle to identify the manifest file.
[ ] Inspecting the collection bundle to identify any supplementary metadata.
[ ] Inspecting the collection bundle to identify any bundled mods.
[ ] Show the pre-install instructions.
[ ] Check the user's game version against the one used to make the collection.

Downloading Collection Mods

[ ] Resolve a downloadable file on Nexus Mods for "Exact only".
[ ] Resolve a downloadable file on Nexus Mods for "Prefer Exact".
[ ] Resolve a downloadable file on Nexus Mods for "Latest".
[ ] Resolve a downloadable file from an external website based on a direct link.
[ ] Resolve a downloadable file from an external website where the user must browse to start the download.
[ ] Import mods bundled with the collection.
[ ] Handle errors resolving downloads.

Installing Collection Mods

[ ] Understand the difference between a required and optional mod.
[ ] Understand the concept of "Phases" when installing mods. (An apply action must be completed before any mods in the next phase can be installed).
[ ] Auto-select FOMOD options based on the choices saved in the collection (where applicable).
[ ] Replicate the file structure exported with the collection for a specific mod.
[ ] Apply binary patches to edited mod files.
[ ] Handle errors resolving customised mods.
[ ] Present instructions for mods to the user.
[ ] Allow the user to review optional mods and select the ones they want to use.

Installing Collection Metadata

[ ] Check collection-specific functionality for all games supported by Vortex.
[ ] Apply rules for mod asset priority. (mod level and file level)
[ ] Apply plugin load order rules or static list for load order (varies by game).
[ ] Apply INI Tweaks (Bethesda games).
[ ] Set up shortcuts to tools included with the collection (if they don't already exist).
[ ] Import script merges from the collection (Witcher 3)

Updating Collections

[ ] Check for updates.
[ ] Download the new collection bundle.
[ ] Compare the installed revision to the new revision.
[ ] Display the Collection changelogs to the user.

Social features

[ ] Allow rating of a collection.
[ ] Allow endorsing of a collection.
[ ] Allow the user to browse the collection page to report a bug/leave a comment.

LukeNexusMods commented 2 months ago

Thanks Mike

erri120 commented 2 months ago

As discussed previously, we need to do a technical analysis of collections to know what's feasible and how.

Nexus-Mods / NexusMods.App

Downloading Collections - Feature List [WIP] #1667