Predicting exobiology species on planets

.github/workflows/test-default.yaml

@@ -11,9 +11,8 @@ env:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
-
+    timeout-minutes: 5
     steps:
     - uses: actions/checkout@v3
     - name: Build

.github/workflows/test-no-default.yaml

@@ -11,9 +11,8 @@ env:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
-
+    timeout-minutes: 5
     steps:
     - uses: actions/checkout@v3
     - name: Build

.github/workflows/test-strict.yaml

@@ -11,9 +11,8 @@ env:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
-
+    timeout-minutes: 5
     steps:
     - uses: actions/checkout@v3
     - name: Build

src/lib.rs

@@ -5,27 +5,45 @@
 //! > **Warning** this project is currently in beta, which means that it is very much work in progress. Breaking
 //! > changes are likely to happen.
 //!
-//! ## Getting started
+//! ## Where to start
 //!
-//! Currently, the only files that are parsed are the log files. Models for working `Market.json`
-//! and `Status.json` etc will be added in the future. Best place to get started is the [JournalDir]
-//! model.
+//! 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](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.
 
 mod modules;
 
 pub use modules::logs;
-pub use modules::models;
 pub use modules::journal;
-pub use modules::state;
-
 pub use modules::status;
+pub use modules::state;
+pub use modules::exobiology;
+pub use modules::exploration;
 pub use modules::outfitting;
 pub use modules::shipyard;
 pub use modules::market;
 pub use modules::nav_route;
 pub use modules::modules_info;
 pub use modules::backpack;
+pub use modules::cargo;
 pub use modules::ship_locker;
+pub use modules::galaxy;
+pub use modules::civilization;
+pub use modules::commander;
+pub use modules::materials;
+pub use modules::trading;
+pub use modules::odyssey;
+pub use modules::ship;
+pub use modules::station;
+pub use modules::thargoid;
+pub use modules::small;
+pub use modules::mixed;
 
 #[cfg(test)]
 mod tests {

src/modules.rs

@@ -1,26 +1,111 @@
 /// Contains modules for working with journal log files providing readers for individual files or
 /// all files at once.
 pub mod logs;
+
+/// Allows for tracking journal directory as a whole, firing events for when logs change but also
+/// for when `.json` files are updated.
 pub mod journal;
+
+/// 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.
 pub mod status;
+
+/// 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.
 pub mod state;
+
+/// Contains models for genuses, species and variants and utilities for predicting possible
+/// biological scans for planets
 pub mod exobiology;
+
+/// Contains functions for exploration related things, like calculating estimated exploration value
+/// for stars and planets and for analysing scans for unusual data.
 pub mod exploration;
+
+/// 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.
 pub mod outfitting;
+
+/// 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.
 pub mod shipyard;
+
+/// 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.
 pub mod market;
+
+/// 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.
 pub mod nav_route;
+
+/// Utilities for working with the `ModulesInfo.json` file. This file provides information about
+/// the current state of the modules of the player's ship.
 pub mod modules_info;
+
+/// 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.
 pub mod backpack;
+
+/// 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.
 pub mod cargo;
-pub mod ship_locker;
 
-/// Contains structs and enums which are used in multiple places. Things like commodity and material
-/// names, ship types, exobiology data etc. can be found here.
-pub mod models;
+/// 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.
+pub mod ship_locker;
 
 /// Provides some utility functions and macros that are used internally.
 mod utils;
 
 /// Module for shared internal code.
 mod shared;
+
+/// Provides models for bodies like stars and planets.
+pub mod galaxy;
+
+/// This module contains models for things that have to do with civilisation and populated systems.
+/// Things like the different superpowers or economies.
+pub mod civilization;
+
+/// Contains models for models for commander ranks.
+pub mod commander;
+
+/// Models and data for materials that are used for ship engineering. For materials that are used
+/// for suit engineering, check the [odyssey] module.
+pub mod materials;
+
+/// Includes the commodity enum, which is used in various places in the library and contains all
+/// the different commodities that can be bought/acquired.
+pub mod trading;
+
+/// 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.
+pub mod odyssey;
+
+/// Contains everything that has to do with ships, including the different types of ships, but also
+/// the different modules that can be equipped.
+pub mod ship;
+
+/// Models related to stations and markets. Also contains some models that are used for fleet
+/// carriers.
+pub mod station;
+
+/// Includes models related to Thargoids. Most importantly: the different types of Thargoids that
+/// player can encounter.
+pub mod thargoid;
+
+/// 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.
+pub mod small;
+
+/// Sometimes the game reuses certain events and instead of 'ship' data it sets Odyssey related
+/// data. These mixed data types handle these differences.
+pub mod mixed;

src/modules/backpack/models/backpack_entry.rs

@@ -1,5 +1,5 @@
 use serde::Deserialize;
-use crate::models::odyssey::item::Item;
+use crate::modules::odyssey::Item;
 
 #[derive(Debug, Deserialize, PartialEq)]
 #[serde(rename_all = "PascalCase")]

src/modules/cargo/models/cargo_entry.rs

@@ -1,5 +1,5 @@
 use serde::Deserialize;
-use crate::models::trading::commodity::Commodity;
+use crate::modules::trading::Commodity;
 
 #[derive(Debug, Deserialize, PartialEq)]
 #[serde(rename_all = "PascalCase")]

src/modules/civilization/mod.rs

@@ -0,0 +1,16 @@
+mod models;
+
+pub use models::conflict::Conflict;
+pub use models::conflict::ConflictFaction;
+pub use models::conflict::ConflictWarType;
+pub use models::economy::Economy;
+pub use models::faction::Faction;
+pub use models::faction::FactionActiveState;
+pub use models::faction_happiness::FactionHappiness;
+pub use models::faction_state::FactionState;
+pub use models::government::Government;
+pub use models::superpower::Superpower;
+pub use models::location_info::LocationInfo;
+pub use models::system_security::SystemSecurity;
+pub use models::thargoid_war::ThargoidWar;
+pub use models::thargoid_war::ThargoidWarState;

src/modules/models/civilization.rs → src/modules/civilization/models.rs

@@ -2,8 +2,9 @@ pub mod conflict;
 pub mod economy;
 pub mod faction;
 pub mod faction_state;
+pub mod faction_happiness;
 pub mod government;
 pub mod superpower;
-pub mod system_info;
+pub mod location_info;
 pub mod system_security;
 pub mod thargoid_war;

src/modules/models/civilization/faction.rs → src/modules/civilization/models/faction.rs

@@ -1,11 +1,5 @@
 use serde::{Serialize, Deserialize};
-
-use crate::modules::models::civilization::faction::faction_happiness::FactionHappiness;
-use crate::modules::models::civilization::faction_state::FactionState;
-use crate::modules::models::civilization::government::Government;
-use crate::modules::models::civilization::superpower::Superpower;
-
-mod faction_happiness;
+use crate::modules::civilization::{FactionHappiness, FactionState, Government, Superpower};
 
 #[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
 #[serde(rename_all = "PascalCase")]

src/modules/models/civilization/system_info.rs → src/modules/civilization/models/location_info.rs

@@ -1,17 +1,10 @@
 use serde::{Serialize, Deserialize};
-
-use crate::modules::models::civilization::conflict::Conflict;
-use crate::modules::models::civilization::economy::Economy;
-use crate::modules::models::civilization::faction::Faction;
-use crate::modules::models::civilization::government::Government;
-use crate::modules::models::civilization::superpower::Superpower;
-use crate::modules::models::civilization::system_security::SystemSecurity;
-use crate::modules::models::civilization::thargoid_war::ThargoidWar;
-use crate::modules::models::galaxy::body_type::BodyType;
+use crate::modules::civilization::{Conflict, Economy, Faction, Government, Superpower, SystemSecurity, ThargoidWar};
+use crate::modules::galaxy::BodyType;
 
 #[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
 #[serde(rename_all = "PascalCase")]
-pub struct SystemInfo {
+pub struct LocationInfo {
     /// The name of the star system that is displayed to the player.
     pub star_system: String,
 

src/modules/commander/mod.rs

@@ -0,0 +1,16 @@
+mod models;
+
+pub use models::combat_rank::CombatRank;
+pub use models::combat_rank::CombatRankError;
+pub use models::empire_rank::EmpireRank;
+pub use models::empire_rank::EmpireRankError;
+pub use models::exobiology_rank::ExobiologyRank;
+pub use models::exobiology_rank::ExobiologyRankError;
+pub use models::exploration_rank::ExplorationRank;
+pub use models::exploration_rank::ExplorationRankError;
+pub use models::federation_rank::FederationRank;
+pub use models::federation_rank::FederationRankError;
+pub use models::mercenary_rank::MercenaryRank;
+pub use models::mercenary_rank::MercenaryRankError;
+pub use models::trade_rank::TradeRank;
+pub use models::trade_rank::TradeRankError;

src/modules/exobiology/mod.rs

@@ -1,2 +1,15 @@
-pub mod models;
-pub(crate) mod r#static;
+mod models;
+mod r#static;
+
+pub use models::genus::Genus;
+pub use models::spawn_condition::SpawnCondition;
+pub use models::spawn_source::SpawnSource;
+pub use models::spawn_source::SpawnSourceStar;
+pub use models::spawn_source::TargetPlanet;
+pub use models::species::Species;
+pub use models::variant::Variant;
+pub use models::variant::VariantError;
+pub use models::variant_color::VariantColor;
+pub use models::variant_color::VariantColorError;
+pub use models::variant_source::VariantSource;
+pub use models::variant_source::VariantSourceError;

src/modules/exobiology/models.rs

@@ -1,2 +1,7 @@
 pub mod spawn_condition;
 pub mod spawn_source;
+pub mod genus;
+pub mod species;
+pub mod variant;
+pub mod variant_color;
+pub mod variant_source;

src/modules/models/exploration/genus.rs → src/modules/exobiology/models/genus.rs

@@ -1,8 +1,7 @@
 use std::fmt::{Display, Formatter};
 
 use serde::{Serialize, Deserialize};
-
-use crate::modules::models::exploration::species::Species;
+use crate::modules::exobiology::Species;
 
 #[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
 pub enum Genus {

src/modules/exobiology/models/spawn_condition.rs

@@ -1,16 +1,16 @@
-use crate::modules::models::galaxy::atmosphere_type::AtmosphereType;
-use crate::modules::models::galaxy::planet_class::PlanetClass;
-use crate::modules::models::galaxy::star_class::StarClass;
-use crate::modules::models::galaxy::star_luminosity::StarLuminosity;
-use crate::modules::models::galaxy::volcanism_type::VolcanismType;
+use crate::materials::Material;
+use crate::modules::galaxy::{AtmosphereType, PlanetClass, StarClass, StarLuminosity, VolcanismType};
 
+#[derive(Debug)]
 pub enum SpawnCondition {
     MinMeanTemperature(f32),
     MaxMeanTemperature(f32),
     NoAtmosphere,
     AnyThinAtmosphere,
     ThinAtmosphere(AtmosphereType),
+    /// The minimum gravity the planet must have, in G
     MinGravity(f32),
+    /// The maximum gravity the planet must have, in G
     MaxGravity(f32),
     PlanetClass(PlanetClass),
     ParentStarClass(StarClass),
@@ -22,11 +22,18 @@ pub enum SpawnCondition {
     MinDistanceFromParentSun(f32),
     AnyVolcanism,
 
+    /// The maximum distance the planet needs to be from the center of a nebula in Ly
     WithinNebulaRange(f32),
 
     /// The target planet must have at least one geological signal present.
     GeologicalSignalsPresent,
 
+    MaterialPresence(Material),
+
+    RockyComposition,
+    IcyComposition,
+    MetalComposition,
+
     Any(Vec<SpawnCondition>),
     All(Vec<SpawnCondition>),
 }