Plugin: Archivist - fredjk-gh/ObservatoryPlugins GitHub Wiki

The Archivist plugin captures exploration related journals and stores them in a database for later re-use either by re-sending journal entries to other plugins or by allowing you to search/browse the journal entries yourself (pretty printed) and copy them out for other uses.

The themable UI features a tabbed control with two tabs:

  • "Current System": Shows the current system, commander and the latest captured journal entry (pretty printed). From here, you can open a separate JSON viewer window or open the system in the Search tab to view other records.
  • "Search": Allows you to search the database for a particular system. Enter a system name in the "Find System" box and press enter to search. Enter text into the "Text Filter" box to find specific entries within the results for a system (ie. to find only a specific body or journal type). If the system has been visited by more than one commander, use the "Commander Filter" to select a particular commander's results. The results view has a context menu allowing you to open a particular entry in a pop-out viewer or copy it to the clipboard. There is also a list of recently visited systems by the current commander from which you can pick a system to search for. Handy for re-visiting recent systems. At the bottom, there is a "Resend All" button which tells Core to resend all records for the system to ALL enabled plugins. This is experimental and can mess with things. See the tip below for how to avoid notification spam.

Below the tab panel is a convenient settings button (to avoid having to switch to the Core tab to change a setting).

Multiple commanders are supported.

image

image

Json viewer:

image

Settings

There's only 1 setting here at the moment and it's not currently functional. In the future, this will control if Archivist sends records for known systems via the plugin message bus to plugins who may want to re-hydrate data from these records. Currently highly experimental.

Tips

  • Resending records is highly experimental; use with caution. It can spawn dozens of notifications and mess up stored data for other plugins. I recommend disabling (using the checkboxes in Core's plugin list) any plugins you don't want results from and maybe even disabling notifications. You may have to re-read all to fix things after resending records. Your mileage may vary.
  • In fact, consider disabling Archivist itself, to avoid it ingesting duplicate records. Known issue; fixed in next release.

Changelog

Release notes: v1.0.3.32704-beta - Nov 22, 2024

  • Avoid ingesting duplicate records by tracking when we are resending records.
  • De-duplicate new entries in the recent systems list.
  • Show the current commander above the recent systems list.
  • Fix incorrect lookup key which caused revisits to overwrite original visit.
  • Remove settings cog from UI.
  • Fix theming of icon buttons.
  • Updates for ObsCore 1.2 (in preview).

Release notes: v1.0.0.30804-beta - November 3, 2024

Some refinement and bug fixes, UI improvements including new icon-based buttons and tooltips and recent system list. This also detects a cancelled read-all and warns of incomplete data. Read all performance has also been improved significantly.

Requires read-all after installation.

Release Notes: v0.24.143.0119-beta - May 21, 2024

Initial release. This plugin includes:

  • Support for multiple commanders.
  • A UI to view new records as they arrive (pretty printed) with a pop-out viewer window and a search functionality to find entries for a previously visited system, with filtering options to help narrow down the results.
  • Experimental support for resending records from search results to all enabled plugins.

Requires running a "Read All" to backfill the database after installation!