Version 0.6.3

What's Changed

• Update LegalStatus enum; Add name_localised field; by @qiaoruntao in #104

Full Changelog: 0.6.2...0.6.3

Version 0.6.2

What's Changed

• Fix missing reexport for JournalDirWatcherError by @Somfic in #102
• Fix missing reexports for guardian codex entries

Full Changelog: 0.6.1...0.6.2

Version 0.6.1

Change log

• Derive Serialize for JournalEvent by @Somfic in #101
• Fix issue where LogEventContentKind wasn't made available.

Full Changelog: 0.6.0...0.6.1

Version 0.6.0

What's Changed

This update doesn't bring a lot of new things, instead lots of work has gone into further improving stability and usability. Documentation has been expanded a lot and lots of models now have doc comments, however there are also still a lot of models that do not have doc comments as it's still an ongoing process of adding these to everything.

State has also seen some major changes in how events are processed. Some fields have moved around a bit, but overall changes are mostly in the internal code.

There have also been some changes to better support pre-v4 log files. This includes some defaults and some fields that have been made optional. Some events that have larges differences have been given a legacy variant which is behind a new feature flag called legacy. Note however that these are just a best-effort endeavor and might not always yield correct results or might not parse at all.

Lastly as always there have been fixes and changes to allow for better log parsing. Most of these changes and fixes have been contributed by various (new) contributors. Thank you!

Change log

• Added doc comments to a lot of models. This is still an on-going effort though and there is still a lot of work to be done, but this will come in the future.
• Added better support for pre-v4 logs by @BafDyce. Some events have been given defaults, some have been made optional and some legacy events have been added behind the new legacy feature flag.
• Major changes to how state works internally which makes the different versions of state less dependent on each other. As a part of this some fields have moved around a bit, specifically moving information related to commanders out of the LogState and into both GameState and JournalState individually.
• Added missing variant Prison to Economy enum by @technologicalMayhem,
• Added missing variant Civilisations to CodexEntryEventCategory enum by @technologicalMayhem,
• Added missing variant Thargoid to CodexEntryEventCategory enum by @technologicalMayhem,
• Added missing variant UnknownUplink to DataScannedEventType enum by @technologicalMayhem,
• Added missing variants OutbreakStationIncrease and OutbreakStationDecrease to MissionCompletedEventFactionEffect enum by @technologicalMayhem,
• Major changes to how codex entries are handles which should specifically improve parsing the CodexEntryEvent. Not all entries are matched though; progress is tracked in #91
• Removed strict feature flag and replaced it with allow-unknown feature flag. This means that loose handling of variants can now be enabled without needing to disable default features.
• Some enums have been given the non_exhaustive flag which should improve compatibility when changes are made between versions of ED. This is disabled however when using the allow-unknown feature as in that case those are covered by the unknown variants.
• Renamed small module to partials and renamed structs to start with 'Partial' instead of 'Small'.
• Renamed is_live field of LogDirReader to reading_latest.
• Fixed some enums related to Odyssey suits not being correctly matched by @qiaoruntao
• Fixed two fields in CarrierFinanceEvent to allow for negative values for when a carrier is in debt by @qiaoruntao
• Fixed some incorrect base credit values for some species.
• Species parsing is now case insensitive.
• Optimized spawn conditions
• Lots of models now have the Serialize and Clone traits derived.

New Contributors

• @BafDyce made their first contribution in #93
• @qiaoruntao made their first contribution in #99

Full Changelog: 0.5.1...0.6.0

Version 0.5.1

What's Changed

This is a small release to fix some smaller issues while waiting for some of the larger changes which are still being worked on.

Change log

• Rework status.json models to work a lot better when working with ships vs on-foot status.
• Fixed an oversight where the fields in ApproachBodyEvent were private by @technologicalMayhem

New Contributors

• @technologicalMayhem made their first contribution in #82

Full Changelog: 0.5.0...0.5.1

Version 0.5.0

What's Changed

This update largely focusses on stability: adding missing variants and models and overal making it a lot less likely for there to be parse errors due to missing data. State also again got some love with some changes to how input for exobiology predictions is constructed which should make it easier to use in more scenarios and state overal just tracks a bit more stuff.

Change log

• Added base species exploration values.
• Added more remaining matches for species color variants except the ones tracked in #68
• Added missing 'PlanetAnomaly' planet signal type.
• Added BBlueWhiteSuperGiant and GWhiteSuperGiant star classes.
• Added Engineer enum which is now used in some log models.
• Added ids to some models. This is still an on-going effort which is tracked in #69
• Added grade_storage_limit method to MaterialGrade model.
• Added the remaining module blueprints.
• Added remaining commodities and fixed some incorrect matches.
• Added more variants to the Superpower model.
• Added Lawless variant to the SystemSecurity model.
• Special cases have been added for some ShipModule grades which should now correctly reflect the in-game grades.
• Expanded what is tracked by state and made some changes.
• Changed how exobiology input is constructed.
• StarClass and StarLuminosity now implement the Display trait.
• DistanceLS has been split into LocalDistance and GalacticDistance.
• Gravity model has been moved to the galaxy module.
• CommitCrimeEventType has been renamed to Crime and moved to the civilization module.
• Renamed FactionHappiness::Content to FactionHappiness::Discontent to align with the in-game texts.
• Make some small changes to help with interoperability with other tools.

Full Changelog: 0.4.0...0.5.0

Version 0.4.0

What's Changed

• Added all remaining species, though most of the ones added are not yet backed by tests so they may not be matched correctly just yet.
• Also removed some of the Anemone species which does not seem to exist at all.
• Added all of the minimum sample distances to the species.
• Added some utility functions to the galaxy module.
• Changed JournalEvent to include a flag for whether the event is a live event or not.
• Changed and added some log models thanks to some new journals contributed by @batshalregmi
• Change the structure of the logs module for shorter use statements.
• Fixed some issues with live journal reader on Windows.
• Fixed an issue where MixedCommodity would be parsed incorrectly when the strict feature was not enabled.

New Contributors

• @batshalregmi made their first contribution in #45

Full Changelog: 0.3.0...0.4.0

Version 0.3.0

What's Changed

• Added asynchronous readers and functions for when working in an async environment like Tokio. To enable this use the asynchronous feature flag.
• Added readers, functions and models for working work .json files.
• Added State which can be used to aggregate the logs from the .log files into a representation that is a lot easier to query and reason with. This feature is still work in progress and I expect some large changes to happen in the future.
• Added state for predicting exobiology species by @Somfic
• Added functions for estimating scan worth by @Somfic
• Added live journal reader for listening to all events that happen within the log directory, detecting both changes to .log files and .json files.
• Added the remaining internal and hardpoint modules.
• Added missing ship slots and modules for cosmetic items.
• Added the remaining
• Added function for automatically locating the journal directory on the user's device.
• The Display trait has been implemented for a lot of shared models.
• Almost all of the genuses and species are now getting matched, with some of the more exotic species requiring some more testing.
• Fix duplicate SulphurDioxide variants in AtmosphereType.
• Some large restructuring of modules has been made. Modules have been moved around and things are more logically structured.
• Some other smaller changes have been made as a result of new journal files.

New Contributors

• @Somfic made their first contribution in #2

Full Changelog: 0.2.0...0.3.0

Version 0.2.0

Full Changelog: 0.1.2...0.2.0

• Added all the event types that were missing before. These are not tested as they are not yet covered by a journal test file.
• Added a lot of missing Items.
• Added LiveJournalFileReader for reading active journal log files.
• Added LiveJournalDirReader for reading log files and automatically handling the active journal file without having to specify a specific path yourself.
• Added variants to some enums even though they are probably not correctly matched yet, but this should hopefully cause less issues between versions.
• Added variants to ShipType and renamed some variants.
• Ship cosmetic slots and 'modules' are now parsed.
• Implemented the Display trait for some of the shared models.
• A JournalDir is now constructed with a new method instead of using try_from.
• Some journal contents events fields were represented as strings where it now uses specific models.
• Renamed JournalReader to JournalFileReader
• Renamed EDLogDirError to JournalDirError
• Renamed journal content fields that ended with _localised to end in _localized
• Renamed MicroWeaveCollingHoses to MicroWeaveCoolingHoses to fix typo.
• Fixed cockpit module not getting parsed correctly in some cases.

Version 0.1.2

Full Changelog: https://github.com/rster2002/ed-journals/commits/0.1.2