ed-mcp 0.2.0 → 0.3.1

package/NOTICE

@@ -8,5 +8,45 @@ Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0).
 A copy of the licence is in LICENSES/Apache-2.0.txt.
 The data was converted from C# to JSON.
 
+test/fixtures/builds/coriolis-exports/ holds builds and statistics from the Coriolis
+test fixtures (https://github.com/EDCD/coriolis, __tests__/fixtures/), Copyright (c)
+2015 Coriolis.io, Colin McLeod, licensed under the MIT License. They were cut down to the
+components and statistics that the tests use.
+
+The ship calculations in src/ships/ (mass, jump range, power, speed, shields, armour and
+weapon damage) are ported from Coriolis (https://github.com/EDCD/coriolis),
+src/app/shipyard/Calculations.js, Module.js, Ship.js, Constants.js and ModuleUtils.js, and
+src/app/utils/JournalUtils.js and BlueprintFunctions.js. The Coriolis licence
+(LICENSE.md) follows, verbatim:
+
+  All Data and [associated JSON](https://github.com/EDCD/coriolis-data) files are intellectual property and copyright of Frontier Developments plc ('Frontier', 'Frontier Developments') and are subject to their
+  [terms and conditions](https://www.frontierstore.net/terms-and-conditions/).
+
+  The code (Javascript, CSS, HTML, and SVG files only) specificially for Coriolis.io is released under the MIT License.
+
+  Copyright (c) 2015 Coriolis.io, Colin McLeod
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software (Javascript, CSS, HTML, and SVG files only), and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in
+  all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+  THE SOFTWARE.
+
+build_stats uses ship, module and blueprint data from coriolis-data
+(https://github.com/EDCD/coriolis-data). ed-mcp downloads it at run time and does not
+include it. The test fixtures in test/fixtures/builds/ hold small extracts of it.
+
 Elite Dangerous game data is the intellectual property of Frontier Developments plc.
 This project is not affiliated with Frontier Developments, Inara, EDSM, Spansh or EDCD.

package/README.md

@@ -5,6 +5,7 @@ ed-mcp connects Claude to Elite Dangerous. Claude can then read your commander d
 With ed-mcp, Claude can:
 
 - plan a ship build: the modules to buy, the engineering, the materials and the engineers to visit, and the route to all of them,
+- model a ship build: jump range, power, defences and damage, and the effect of changes,
 - work out which materials you are short of and the trades that cover them,
 - find the best station for a module, ship or service, ranked by travel time and price,
 - plan trade runs and loops, and find where to sell or buy a commodity,
@@ -22,11 +23,14 @@ ed-mcp is not affiliated with Frontier Developments, Inara, EDSM or Spansh.
 ## What you can ask
 
 - "Here is my build from EDSY. Make a plan for the modules I need to buy or engineer. Tell me the materials I am short of and where to trade for them."
+- "What jump range do I get if I fit a 5A FSD with grade 5 increased range?"
 - "Where is the nearest Guardian technology broker?"
 - "What do I need for grade 5 dirty drives?"
 - "Find me a trade route from here. I have 400 t of cargo."
 - "Where can I sell 200 t of gold near Atlas?"
 - "Find me a trade loop from this station that I can run for an hour."
+- "What does this station sell, and is anything cheap?"
+- "Which modules can I buy at this outfitting?"
 - "Plan the best order for my passenger missions."
 - "Plan the route for my Corsair build plan."
 - "From now on, ignore stations more than 2,000 ls from the star."
@@ -107,6 +111,8 @@ Elite Dangerous writes a journal while you play. ed-mcp reads it and never chang
 
 Do not share `%LOCALAPPDATA%\Frontier Developments\Elite Dangerous`. That folder has the same name, but it holds only the game's settings. If you share it by mistake, the journal status tells you.
 
+The game also writes `Market.json`, `Outfitting.json` and `Shipyard.json` to the same folder when you open those screens. ed-mcp reads them to show what the station you last opened sells, with current prices.
+
 The journal tools warn you when the newest entry is more than 30 minutes old. Then the game is not running, or Syncthing has stopped.
 
 ## Plans
@@ -124,6 +130,7 @@ ed-mcp ranks stations by travel time and price. Your preferences control which s
 | Fleet carriers                   | Excluded                                                                   |
 | Megaships                        | Allowed                                                                    |
 | Landing pad size                 | Taken from your current ship                                               |
+| Permit-locked systems            | Excluded, for example Sol. Tell Claude when you hold a permit.             |
 | Jump range                       | Taken from your current ship (85% of its best range)                      |
 | Value of your time               | 20M credits an hour                                                        |
 
@@ -158,13 +165,23 @@ The files are in these folders:
 | Windows | `%APPDATA%\ed-mcp\Config`      | `%LOCALAPPDATA%\ed-mcp\Cache`      |
 | Linux   | `~/.config/ed-mcp`             | `~/.cache/ed-mcp`                  |
 
-ed-mcp sends your API keys only to the service that they belong to. On first use, it downloads game data (modules, blueprints and materials) from the coriolis-data and FDevIDs projects on GitHub. Then it looks for new versions once a week. To get new data at once, ask Claude to refresh the game data.
+ed-mcp sends your API keys only to the service that they belong to. On first use, it downloads game data from the coriolis-data and FDevIDs projects on GitHub: modules, blueprints and materials, and the ship and module data for build statistics. Then it looks for new versions once a week. To get new data at once, ask Claude to refresh the game data.
 
 ## More information
 
 - [Tool reference](docs/tools.md): what each tool does, its inputs and its results.
 - [Contributing](CONTRIBUTING.md): development, releases and service registrations.
 
+## Acknowledgements
+
+- **Coriolis** ([coriolis.io](https://coriolis.io), [GitHub](https://github.com/EDCD/coriolis)): `build_stats` ports the Coriolis ship calculations for jump range, power, speed, shields, armour and weapon damage. The Coriolis test builds check our results. Thank you to Colin McLeod and the Coriolis contributors. The Coriolis code is MIT licensed. `NOTICE` holds its licence, and we credit it here too.
+- **coriolis-data** ([EDCD](https://github.com/EDCD/coriolis-data)): the ship, module and blueprint data. ed-mcp downloads it at run time. The data is the intellectual property of Frontier Developments.
+- **EDCD FDevIDs** ([GitHub](https://github.com/EDCD/FDevIDs)): the material and outfitting names.
+- **EliteDangerousCore** ([EDDiscovery](https://github.com/EDDiscovery/EliteDangerousCore)): the engineer table, under the Apache-2.0 licence (see `NOTICE`).
+- **Spansh, Inara and EDSM**: the services that ed-mcp reads from.
+- **The Elite Dangerous community wikis** (Alioth): the material trader rules.
+- **Elite Dangerous** is a trademark of Frontier Developments plc. ed-mcp is not affiliated with Frontier Developments.
+
 ## Licence
 
 MIT. See `NOTICE` for third-party data.