The input are several data-files provided by EVE Online, together with a ship fit. The output are all the Dogma attributes, containing all the details of the ship.

Implementation

This Dogma engine implements a multi-pass approach.

pass 1: collect all the Dogma attributes of the hull and modules.
pass 2: collect all the Dogma effects of the hull and modules.
pass 3: apply all the Dogma effects to the hull/modules, calculating the actual Dogma attribute values.
pass 4: augment the Dogma attributes with EVEShip.fit specific attributes, that are too complex for the Dogma itself to handle.

EVEShip.fit's specific attributes

Pass 4 create Dogma attributes that do not exist in-game, but are rather complicated to calculate. To make rendering a fit easier, these are calculated by this library, and presented as new Dogma attributes.

Their identifier is always a negative value, to visually separate them. What additional attributes exist are defined in EVEShipFit/data repository.

Development

Make sure you have Rust installed.

Next, we have to fetch the latest Protobuf definition and data files. These can be installed via the NPM package @eveshipfit/data:

npm i -U

After that, we can run the application.

cargo run --release --no-default-features --features rust

Integration

Javascript (WebAssembly)

The primary goal of this library is to build a WebAssembly variant that can easily be used in the browser. This means that there is no need for a server-component, and everything can be calculated in the browser.

This is done with wasm-pack:

cargo install wasm-pack
wasm-pack build --release -- --no-default-features --features wasm

In the pkg folder is now a NPM module to use.

To make sure that EVEShip.fit is as fast as possible, all data-files are read by Javascript, and made available to this library by callbacks. Transferring all data-files from Javascript to Rust is simply too expensive.

In result, Javascript needs to have the following functions defined:

get_dogma_attributes(type_id) - To get a list of all Dogma attributes for a given item.
get_dogma_attribute(attribute_id) - To get all the details of a single Dogma attribute.
get_dogma_effects(type_id) - To get a list of all Dogma effects for a given item.
get_dogma_effect(effect_id) - To get all the details of a single Dogma effect.
get_type(type_id) - To get all the details of a single item.
attribute_name_to_id(attribute_name) -> To get the ID of the attribute by given name.
type_name_to_id(type_name) - To get the ID of the type by given name;

The returning value should be a Javascript object. The fields are defined in in data_types.rs.