parkerokonek / paradoxpatcher Goto Github PK

Diff Match Patch will reliably patch conflicting file changes without issue. This causes some information to be lost and for malformed files.

For example, patching Bob to Bib and Bob to Beb results in Bob being Beb, not a failure to patch.

In Ck2, text files for mods are expected to be in Windows-1252 encoding, certain mods or base game files (on Linux or MacOS) may be encoded in UTF-8. In the base game and with unmerged mods this poses no issue, but all mods need to be transliterated into a standard encoding (UTF-8) for doing file comparisons before being exported into the preferred encoding for each game.

For the GUI, there should be a mod organizer style screen where users can enable which mods they wish to use. As the purpose of the program is to resolve conflicts, not do load order, no load order will be available.

Allow for stand-alone files in mod structure or in-line commented out code in otherwise typical Paradox mod files that allow for:

• defining flags/mod presence (DEFINE flag_name, LET a = 0, INCR 0, SET a = 3, etc)
• Making conditionals based off the presence of these flags or values (IFDEF, IFNDEF, IF, ELSE, NOR, etc)
• execute regex or uncomment/comment specific strips of code scoped to certain files or folders (REPLACE orthodox heterodox)

Currently the tool is built around Paradox's old launcher, this is fine for games like CK2 or Vic2, but will need to be changed to support games like EU4. This may be possible with a weird config set-up with the current tool, but this should be built-in functionality.

Currently function parameters are a bit of a mess and could use standardization. At minimum all public facing options should only really call the current configuration option. The Arguments for a per run should either be solidified as the main application options (and include the configuration in them) or be integrated with the current configuration with a builder or similar.

For ease of use, the program should have a UI.

Allow mods to contain diffs or patches of vanilla files instead of the literal file text.

There does exist an implementation/wrapper for Diff Match Patch for Rust, here.

Need to try rewriting with this crate to reduce the number of explicitly installed requirements for users, and decreasing over all code spaghetti factor.

Rayon is one library for data parallelism that could be useful for speeding up the merging and conflict detection on mods. Not sure that this would have any improvement for indexing or generating the initial mod list, that is mostly file IO.

Right now the main library is a lot of spaghetti with only small bits of comment in between.

Tests need to be updated to reflect newly added functionality and to cover all of main library files.

Had some issues when merging files from mods in folders (Paradox Forums). Will need to see if there is an issue in the directory walking code, single file read code, or the all path read code.

To-do functionality:

• Conflict scanning
• Displaying which mods conflict where
• UI for adding and modifying game presets
• folder search dialog for patch output
• warnings for when mods fail to load/patch
• save user load order to launcher files