v10.0.0

Changes

• Instead of using booleans for processing options like romanize, trim etc. introduced BaseFlags bitflags.
• with_flags function of processors now accepts BaseFlags parameter, FileFlags version was moved into a with_files method.
• Hugely improved documentation.

v9.0.4

Changes

• Fixed error when passing MZ file data to get_system_title function
• When generating JSON, scripts are now generated as .txt source code file

v9.0.3

Changes

• Fixed panic on purging for the first time.
• Fixed empty ignore entries if they didn't exist before purging.
• Fixed setting wrong ignore entries.
• Fixed wrong purging of the system file.

Known issues

• Sometimes reading with append mode puts some lines to wrong entries.

v9.0.2

Changes

• From v9.0.1
  • Added documentation about serialization.
  • Implemented FileFlags serialization as u8.
• From v9.0.2
  • Fixed incorrect translation parsing on write, which led to untranslated multiline strings.
  • Fixed panic on non-existent output_dir argument in generate and write functions of json module.
  • Fixed non-working writing of scripts.
  • Fixed wrong writing of other (actors, armors, items, classes, enemies, skills, states, weapons) files, when the whole entry might end up unwritten, if its name has no translation, but other strings (like description) ARE translated.

v9.0.0

ANOTHER MAJOR RELEASE

Changes

• Separated IO logic and library core logic. Now, it's possible to process files directly with core.
• Removed serde feature, now it's built-in, because serde is used in the library anyways.
• Removed this whole hell with Results. Reader, Writer and Purger results will return Error upon the first fail.

v8.0.0

Changes

• Rewritten the API to return Results instead of panicking.
• Rewritten the logging to use log crate and remove the log feature, so all users must set up logging in their binaries from now on.
• Added documentation for json module functions, renamed generate_json and write_json to generate and write respectively.
• Added handling of \nblt prefix in LisaRPG custom processing.
• Added skipping of unused maps in-game, which is determined by checking if map's ID exist in Mapinfos.
• Added skipping of entries with no translation when writing.
• Improved speed by using Regex's replace_all function, which copies the data only if there's something to replace in string.
• Improved documentation.

v7.0.0

Previous release didn't actually state much changes, so this release will contain the changes made in v6 and v7 summarized.

Changes

• Made code much more maintainable, reduced a crazy amount of repetitiveness.
• Fixed json module.
• Removed sorting feature.
• Instead of MapReader, OtherReader, etc. structs, rvpacker-txt-rs-lib now uses approach of unified structs. There's now three structs: Reader, Writer, Purger which API differ from v5. Consult with the newer API.
• Renamed MapsProcessingMode to DuplicateMode. Its variants were changed to DuplicateMode::Remove and DuplicateMode::Allow, which are equivalent to MapsProcessingMode::Default and MapsProcessingMode::Separate respectively.
• Now, DuplicateMode affects parsing for all files except system and plugins/scripts.
• Rewritten purge behavior: Now it can only be used for purging lines with empty translation.
• Comments:
  • maps.txt entries will now always include the following comments: Map ID, map order, map name, map display name.
  • Files, except maps.txt and system.txt will now always include the following comments: Event ID, event name.
  • system.txt will now always include the system entry comments.
  • Note, that Event ID comment is essential for writing files. That makes your existing files obsolete, and writing simply won't work. You should re-read the source files and then reapply your translation to them.
• Now, when reading with append read mode, it will automatically sort your translation chronologically and discard lines, that are no longer present in-game. Make sure you have a version control system set up to not lose anything important.
• Removed parallelism, which degraded the speed. The reason is maintenance difficulties. Now read/write takes around 5-10s, instead of 1-3s like before.
• Fixed A LOT of possible bugs and misbehaviors.

v6.0.0

Changes

• Completely rewritten the project, eliminating a lot of repetition.
• Changed a lot of names.
• Incompatible with all old projects.
• Go to examples and see what's changed.

v5.1.4

Changes

• Fixes wrong trim argument for parse_translation calls in structs.
• Added additional \n line break for descriptions in Termina.

v5.1.3

Changes

• Plugins now don't require correct ordering of lines in translation file.
• Fixed incorrect plugins writing because lines were trimmed, but they shouldn't have been.
• Miscellaneous fixes for F&H 2: Termina.