spacing-guild v1.0.0-alpha.0

Spacing Guild

A library of useful features for SpaceTraders API

Contents

• Installation
• Usage
  • Using Navigator
  • Using Mentat
• Build
• Documentation
  • Navigator
  • Mentat

Installation

npm i spacing-guild --save

Usage

Using Navigator

import { Navigator, ITradeRoute } from "spacing-guild";

// ...

const edric: Navigator = new Navigator(locations, ship);
const route: ITradeRoute = edric.navigate();

Example result

{
  "destination": "OE-PM",
  "cargo": [
    { "good": "FUEL", "quantity": 3, "totalVolume": 3 },
    { "good": "METALS", "quantity": 10, "totalVolume": 10 },
    { "good": "DRONES", "quantity": 2, "totalVolume": 4 },
    { "good": "FUEL", "quantity": 33, "totalVolume": 33 }
  ]
}

Using Mentat

import { Mentat } from "spacing-guild";

// ...

const distance: number = Mentat.calculateLocationDistance(locationA, locationB);
const inRange: number = Mentat.validateRange(ship, range, location);

Build

npm i

npm run build

Documentation

Navigator

The Navigator class is will decide the most profitable, possible trade from the ship's current location

It will return an object with 2 properties: Destination and Cargo

• Destination is a location type object that can be used when setting the flight plan.
• Cargo contains all the goods that should be bought from current marketplace and in what quantities, as well as the FUEL required for the trip. These goods should then be sold at the destination's marketplace.

Navigator class takes 2 arguments

• locations : A list of location objects to parse through
• ship : The ship object

Once a Navigator object is created, it automatically parses the locations and sets a list of all available trades. This list will then be used in the navigate() method to narrow down the possible trades based on the method's arguments.

note: In the following table, the column Type will contain some custom interfaces. Please refer to the Interfaces typescript file for information

NOTES

• If one of the profitable trades happens to be FUEL, it adds an extra entry with FUEL.
• This should not be sold as it can be used for further traveling and save costs because it was bought in a better price.
• If there is space left and no more available trades on destination, the remaining space will be empty.
• Currently this only works within the ship's system. Intersystem route plotting is the future. #TODO

Mentat

The Mentat class is solely responsible for various calculations. All methods are public static and return either a number or a boolean.

note: In the following table, the column Type will contain some custom interfaces. Please refer to the Interfaces typescript file for information