Skip to content

data-accuracy-notes.md

Latest commit

 

History

History
78 lines (56 loc) · 2.94 KB

data-accuracy-notes.md

File metadata and controls

78 lines (56 loc) · 2.94 KB

Data Accuracy Notes

⚠️ Disclaimer

THIS IS A DEVELOPMENT/HOBBY PROJECT - USE AT YOUR OWN RISK

This software and its data are provided "AS IS" without warranty of any kind, express or implied. No guarantees or warranties are given regarding data accuracy, completeness, or fitness for any purpose. The authors and contributors are not liable for any damages arising from use of this software or its data. See the LICENSE file for full terms.

Legality Data Sources

The legality information for rare goods in this application is manually curated from Inara.cz.

Why Manual Curation?

Unfortunately, there are no public APIs available that provide rare goods legality data:

  • Inara.cz: Does not provide a public API for commodity legality data
  • EDSM: Provides system coordinates and basic system info, but not commodity legality
  • Spansh: Focuses on route planning, not commodity legality data

How to Update Legality Data

  1. Visit the Inara page for each rare good:

  2. Find the "Legal in systems" section which shows restrictions

  3. Update the data in src/data/rares.ts based on Inara's notes:

    Field: illegalInSuperpowers

    • Use when Inara says "illegal in [Superpower] space" or "illegal in all [Superpower] systems"
    • Example: illegalInSuperpowers: ["Federation"]

    Field: illegalInGovs

    • Use when Inara says "illegal in [Government] systems" without mentioning a superpower
    • Example: illegalInGovs: ["Prison Colony", "Theocracy"]

    Field: illegalInSuperpowerGovs

    • Use when Inara mentions a specific combination like "Federal Democracy" or "Imperial Theocracy"
    • Example: illegalInSuperpowerGovs: [{ superpower: "Federation", government: "Democracy" }]

Examples

Example 1: Kamitra Cigars

  • Inara note: "This rare good is legal in all systems except for Prison Colony, Theocracy and Corporate systems and Federal Democracy systems."
  • Translation: 
    illegalInGovs: ['Prison Colony', 'Theocracy', 'Corporate'],
illegalInSuperpowerGovs: [
  { superpower: 'Federation', government: 'Democracy' },
],

Example 2: Centauri Mega Gin

  • Inara note: "This rare good is legal in all systems except for Prison Colony systems and Federal Theocracy systems."
  • Translation: 
    illegalInGovs: ['Prison Colony'],
illegalInSuperpowerGovs: [
  { superpower: 'Federation', government: 'Theocracy' },
],

Verification

After updating data, verify by:

  1. Running the application
  2. Scanning for rares near a system with the restricted government/superpower
  3. Checking that the legality badge and details match Inara's information

Contributing

If you find inaccuracies:

  1. Check Inara.cz for the current legality information
  2. Update the data in src/data/rares.ts
  3. Submit a pull request with the correction