@eveshipfit/dogma-engine 8.1.0 → 10.0.1

package/README.md

@@ -1,18 +1,80 @@
 # EVEShip.fit's Dogma Engine
 
+[![crates.io](https://img.shields.io/crates/v/esf-dogma-engine.svg)](https://crates.io/crates/esf-dogma-engine)
+[![npm](https://img.shields.io/npm/v/%40eveshipfit%2Fdogma-engine.svg)](https://www.npmjs.com/package/@eveshipfit/dogma-engine)
+[![CI](https://github.com/EVEShipFit/dogma-engine/actions/workflows/testing.yml/badge.svg)](https://github.com/EVEShipFit/dogma-engine/actions/workflows/testing.yml)
+[![docs.rs](https://img.shields.io/docsrs/esf-dogma-engine)](https://docs.rs/esf-dogma-engine)
+
+[![Discord](https://img.shields.io/badge/Discord-Join-5865F2?logo=discord&logoColor=white)](https://discord.gg/S5V5BkvNf7)
+
 This library calculates accurately statistics of an EVE Online ship fit.
 
 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.
+The output are all the Dogma attributes of the ship, its items and the character.
 
 ## Implementation
 
 This Dogma engine implements a multi-pass approach.
 
-- [pass 1](./src/calculate/pass_1.rs): collect all the Dogma attributes of the hull and modules.
-- [pass 2](./src/calculate/pass_2.rs): collect all the Dogma effects of the hull and modules.
-- [pass 3](./src/calculate/pass_3.rs): apply all the Dogma effects to the hull/modules, calculating the actual Dogma attribute values.
-- [pass 4](./src/calculate/pass_4.rs): augment the Dogma attributes with EVEShip.fit specific attributes, that are too complex for the Dogma itself to handle.
+- [pass 1](./crates/esf-dogma-engine/src/calculate/pass_1.rs): collect all the Dogma attributes of the hull and modules.
+- [pass 2](./crates/esf-dogma-engine/src/calculate/pass_2.rs): collect all the Dogma effects of the hull and modules.
+- [pass 3](./crates/esf-dogma-engine/src/calculate/pass_3.rs): apply all the Dogma effects to the hull/modules, calculating the actual Dogma attribute values.
+- [pass 4](./crates/esf-dogma-engine/src/calculate/pass_4.rs): augment the Dogma attributes with EVEShip.fit specific attributes, that are too complex for the Dogma itself to handle.
+
+## Input and output
+
+`calculate` takes a fit and options, and returns a calculation.
+All identifiers are those from the SDE.
+
+### Fit
+
+- `name` (optional): name of the fit.
+- `ship`: the ship being fitted.
+  - `type_id`: its type.
+- `items`: everything fitted or carried. Each item has:
+  - `type_id`: its type.
+  - `slot`: where the item is.
+    - `type`: `high`, `medium`, `low`, `rig`, `subsystem`, `service`, `drone_bay` or `cargo`.
+      _`cargo` is carried, but not calculated._
+    - `index`: position within that slot type, starting at 0. Absent for `drone_bay` and `cargo`.
+  - `quantity` (optional, default 1): stack size for drones and cargo.
+  - `state`: requested state; `offline`, `online`, `active` or `overload`.
+  - `charge` (optional): the loaded charge, as `type_id`.
+- `character` (optional):
+  - `skills`: level (0 to 5) per skill type ID. A missing skill gives no bonuses.
+
+### Options
+
+- `sources` (optional, default false): report per attribute what its value was calculated from.
+  Leave it off unless you show it; it makes the calculation several times bigger.
+
+### Calculation
+
+- `ship`: result for the ship.
+- `items`: one result per item of the fit, in the same order.
+- `character`: result for the character.
+
+Each result has:
+
+- `attributes`: per attribute ID, its `base` value before effects and its final `value`.
+  With the `sources` option, also `sources`: every modifier on it, in the order they were applied. Each has:
+  - `from`: where it comes from; `type` is `ship`, `character`, `item` or `charge` (with the `index` into `items`), or `skill` (with its `type_id`).
+  - `effect_id`: the effect that modifies.
+  - `source_attribute_id`: the attribute on the source that holds `value`.
+  - `operator`: `pre_assign`, `pre_mul`, `pre_div`, `mod_add`, `mod_sub`, `post_mul`, `post_div`, `post_percent` or `post_assign`.
+  - `value`: the value of the modifying attribute.
+  - `quantity`: how many times it counts. A stacking penalised stack is listed once per item instead.
+  - `penalty`: the stacking penalty factor it got, or `null` if not penalised.
+  - `applied`: false when the source's state is too low for the effect.
+
+  How much each source added is not reported: multiplications compound and stacking penalties depend on order, so there is no single answer.
+- `state`: the state the item reached, which can be lower than requested.
+- `max_state`: the highest state the item can reach.
+- `charge`: result for its charge, if it has one.
+
+### Things to know
+
+- A stack, like five drones, has the attributes of a single item; its bonuses count once per item in the stack.
 
 ## EVEShip.fit's specific attributes
 
@@ -42,8 +104,8 @@ English names live in `sde.dat`, so an EFT-fit written in English imports withou
 After that, we can run the application.
 
 ```bash
-flatc --rust --gen-onefile -o src/sde/ node_modules/@eveshipfit/sde/specs/eve.fbs node_modules/@eveshipfit/sde/specs/names.fbs
-cargo run --release --no-default-features --features rust
+flatc --rust --gen-onefile -o crates/esf-data/src/sde/ node_modules/@eveshipfit/sde/specs/eve.fbs node_modules/@eveshipfit/sde/specs/names.fbs
+cargo run --release -p esf-cli
 ```
 
 The regression suite reads the same paths; set `ESF_SDE` and `ESF_NAMES` to point it elsewhere.
@@ -75,7 +137,7 @@ This is done with [wasm-pack](https://rustwasm.github.io/wasm-pack/):
 
 ```bash
 cargo install wasm-pack
-wasm-pack build --release -- --no-default-features --features wasm
+wasm-pack build crates/esf-wasm --release --out-dir ../../pkg
 ```
 
 In the `pkg` folder is now a NPM module to use.
@@ -91,6 +153,13 @@ initPanicHook();
 
 const sde = await fetch("/sde.dat").then((response) => response.arrayBuffer());
 const buildNumber = load_sde(new Uint8Array(sde));
-
-const statistics = calculate(fit, skills);
+const fit = {
+  ship: { type_id: 587 },
+  items: [{ type_id: 2873, slot: { type: "high", index: 0 }, state: "active", charge: { type_id: 185 } }],
+  character: { skills: { 3300: 5 } },
+};
+
+const calculation = calculate(fit);
+/* Or if you want to know the source of the effects: */
+const withSources = calculate(fit, { sources: true });
 ```

package/esf_dogma_engine.d.ts

@@ -1,7 +1,10 @@
 /* tslint:disable */
 /* eslint-disable */
 
-export function calculate(js_esf_fit: any, js_skills: any): any;
+/**
+ * `js_options` may be left out; it then uses the defaults.
+ */
+export function calculate(js_fit: any, js_options: any): any;
 
 export function init(): void;
 

package/esf_dogma_engine_bg.js

@@ -1,10 +1,11 @@
 /**
- * @param {any} js_esf_fit
- * @param {any} js_skills
+ * `js_options` may be left out; it then uses the defaults.
+ * @param {any} js_fit
+ * @param {any} js_options
  * @returns {any}
  */
-export function calculate(js_esf_fit, js_skills) {
-    const ret = wasm.calculate(js_esf_fit, js_skills);
+export function calculate(js_fit, js_options) {
+    const ret = wasm.calculate(js_fit, js_options);
     if (ret[2]) {
         throw takeFromExternrefTable0(ret[1]);
     }
@@ -45,6 +46,12 @@ export function __wbg_String_8564e559799eccda(arg0, arg1) {
     getDataViewMemory0().setInt32(arg0 + 4 * 1, len1, true);
     getDataViewMemory0().setInt32(arg0 + 4 * 0, ptr1, true);
 }
+export function __wbg___wbindgen_bigint_get_as_i64_b482365c149396c8(arg0, arg1) {
+    const v = arg1;
+    const ret = typeof(v) === 'bigint' ? v : undefined;
+    getDataViewMemory0().setBigInt64(arg0 + 8 * 1, isLikeNone(ret) ? BigInt(0) : ret, true);
+    getDataViewMemory0().setInt32(arg0 + 4 * 0, !isLikeNone(ret), true);
+}
 export function __wbg___wbindgen_boolean_get_7a12af2b3f899c5a(arg0) {
     const v = arg0;
     const ret = typeof(v) === 'boolean' ? v : undefined;
@@ -61,10 +68,18 @@ export function __wbg___wbindgen_in_50072d4d6e45c193(arg0, arg1) {
     const ret = arg0 in arg1;
     return ret;
 }
+export function __wbg___wbindgen_is_bigint_60fc0336cb14f5d7(arg0) {
+    const ret = typeof(arg0) === 'bigint';
+    return ret;
+}
 export function __wbg___wbindgen_is_function_fcda5e3902d732fe(arg0) {
     const ret = typeof(arg0) === 'function';
     return ret;
 }
+export function __wbg___wbindgen_is_null_5160b3e381865372(arg0) {
+    const ret = arg0 === null;
+    return ret;
+}
 export function __wbg___wbindgen_is_object_edb6b15aa3afe12e(arg0) {
     const val = arg0;
     const ret = typeof(val) === 'object' && val !== null;
@@ -78,6 +93,10 @@ export function __wbg___wbindgen_is_undefined_8c687d0b90d5b524(arg0) {
     const ret = arg0 === undefined;
     return ret;
 }
+export function __wbg___wbindgen_jsval_eq_9fdcd3c0a860dd3b(arg0, arg1) {
+    const ret = arg0 === arg1;
+    return ret;
+}
 export function __wbg___wbindgen_jsval_loose_eq_3c30021c243b64cd(arg0, arg1) {
     const ret = arg0 == arg1;
     return ret;
@@ -148,6 +167,16 @@ export function __wbg_instanceof_ArrayBuffer_d4ff01f8247925ae(arg0) {
     const ret = result;
     return ret;
 }
+export function __wbg_instanceof_Map_1ff6a2b54c899f0d(arg0) {
+    let result;
+    try {
+        result = arg0 instanceof Map;
+    } catch (_) {
+        result = false;
+    }
+    const ret = result;
+    return ret;
+}
 export function __wbg_instanceof_Uint8Array_598adc0fef426aa8(arg0) {
     let result;
     try {
@@ -235,12 +264,17 @@ export function __wbindgen_generic_0000000000000001(arg0) {
     const ret = arg0;
     return ret;
 }
-export function __wbindgen_generic_0000000000000002(arg0, arg1) {
+export function __wbindgen_generic_0000000000000002(arg0) {
+    // Cast intrinsic for `I64 -> Externref`.
+    const ret = arg0;
+    return ret;
+}
+export function __wbindgen_generic_0000000000000003(arg0, arg1) {
     // Cast intrinsic for `Ref(String) -> Externref`.
     const ret = getStringFromWasm0(arg0, arg1);
     return ret;
 }
-export function __wbindgen_generic_0000000000000003(arg0) {
+export function __wbindgen_generic_0000000000000004(arg0) {
     // Cast intrinsic for `U64 -> Externref`.
     const ret = BigInt.asUintN(64, arg0);
     return ret;

package/package.json

@@ -5,7 +5,7 @@
     "EVEShipFit Team <info@eveship.fit>"
   ],
   "description": "Library to calculate statistics for EVE Online ship fits",
-  "version": "8.1.0",
+  "version": "10.0.1",
   "license": "MIT",
   "repository": {
     "type": "git",