Crate ed_journals

ED Journals

This library provides models and utilities to work with Elite Dangerous journal files.

Warning this project is currently in beta, which means that it is very much work in progress. Breaking changes are likely to happen.

Where to start

This library contains quite a large number of modules that each cover a different part of the game, but there are a couple of modules that are important to point out:

• The logs module contains readers and models for reading the Journal.log files that are stored in the games journal directory.
• State can be used to turn the logs from the Journal.log files into a single state that can then be queried and used to figure out the current or previous state of the game.
• The journal module can be used to interact with the whole journal directory and can watch the directory as a whole for changes.

Modules

• backpack
  Utilities for working with the Backpack.json file. Contains all the items that the player currently has in their backpack. This is only filled if the player has the Odyssey expansion. Updates when there are changes to the player’s backpack.
• cargo
  Utilities for working with the Cargo.json file. Includes a list of all the commodities that the player currently has in their inventory. This is updated for both the player’s ship and an SRV, so at one time it might show the inventory of the player’s ship and the next it shows the inventory of the SRV, but never both at once. Is updated when there are changes to the cargo hold or when switching between ship and SRV and vise versa.
• civilization
  This module contains models for things that have to do with civilisation and populated systems. Things like the different superpowers or economies.
• commander
  Contains models for models for commander ranks.
• exobiology
  Contains models for genuses, species and variants and utilities for predicting possible biological scans for planets
• exploration
  Contains functions for exploration related things, like calculating estimated exploration value for stars and planets and for analysing scans for unusual data.
• galaxy
  Provides models for bodies like stars and planets.
• journal
  Allows for tracking journal directory as a whole, firing events for when logs change but also for when .json files are updated.
• logs
  Contains modules for working with journal log files providing readers for individual files or all files at once.
• market
  Utilities for working with the Market.json file. Includes a list of commodities that are being sold/requested at the current location. Resets every time the player opens the commodity market.
• materials
  Models and data for materials that are used for ship engineering. For materials that are used for suit engineering, check the odyssey module.
• mixed
  Sometimes the game reuses certain events and instead of ‘ship’ data it sets Odyssey related data. These mixed data types handle these differences.
• modules_info
  Utilities for working with the ModulesInfo.json file. This file provides information about the current state of the modules of the player’s ship.
• nav_route
  Utilities for working with the NavRoute.json file. Provides the current plotted nav route for the player. Resets if the player selects a new route destination or when clearing the route.
• odyssey
  Contains models and utilities for things that have been added in the Odyssey expansion of the game. Note that exobiology is its own separate module.
• outfitting
  Utilities for working with the Outfitting.json file. Is updated when opening the outfitting menu on stations and includes all the modules that are available for purchase at that market. Is reset every time the player opens the outfitting menu.
• ship
  Contains everything that has to do with ships, including the different types of ships, but also the different modules that can be equipped.
• ship_locker
  Utilities for working with the ShipLocker.json file. This file includes all the Odyssey items the player has stored on their ship. Is updated when there are changes.
• shipyard
  Utilities for working with the Shipyard.json file. Is updated when opening the shipyard menu on stations and lists all the ships that are available to buy at that location. Resets every time the player opens the shipyard menu.
• small
  This module contains ‘small’ models that are used to create representations for certain things without needing to include all the information as it can differ quite a bit between the different events of the game.
• state
  Used to construct a state by feeding it events from the journal logs which can then be used to create relations between events and create a history. Below is a simple example on how to read logs and feed then into the state:
• station
  Models related to stations and markets. Also contains some models that are used for fleet carriers.
• status
  Utilities for working with the Status.json file. The Status.json file contains information about the current status of the player and their ship. Things like if the player is docked or landed or the location of the player on a planet.
• thargoid
  Includes models related to Thargoids. Most importantly: the different types of Thargoids that player can encounter.
• trading
  Includes the commodity enum, which is used in various places in the library and contains all the different commodities that can be bought/acquired.