@eveshipfit/sde 4.3503375.2 → 4.3503375.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +31 -3
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,6 +1,7 @@
1
1
  # SDE Patched
2
2
 
3
3
  [![npm](https://img.shields.io/npm/v/%40eveshipfit%2Fsde.svg)](https://www.npmjs.com/package/@eveshipfit/sde)
4
+ [![PyPI](https://img.shields.io/pypi/v/eveshipfit-sde.svg)](https://pypi.org/project/eveshipfit-sde/)
4
5
  [![CI](https://github.com/EVEShipFit/sde-patched/actions/workflows/testing.yml/badge.svg)](https://github.com/EVEShipFit/sde-patched/actions/workflows/testing.yml)
5
6
 
6
7
  [![Discord](https://img.shields.io/badge/Discord-Join-5865F2?logo=discord&logoColor=white)](https://discord.gg/S5V5BkvNf7)
@@ -40,18 +41,40 @@ It is also not meant as "production-ready" software, but much more as "an easier
40
41
 
41
42
  ## Output
42
43
 
43
- `build` writes two flatbuffers, described in [specs/](specs/):
44
+ `build` writes two flatbuffers, described in [specs/](https://github.com/EVEShipFit/sde-patched/tree/main/specs):
44
45
  - `dist/sde.dat` holds the types, dogma, groups, categories, buffs and mutaplasmids, with English
45
46
  names only. It is all a dogma-engine needs.
46
47
  - `dist/names.dat` maps a name in any of the eight languages EVE supports back to
47
48
  a type ID. Only an EFT-fit importer needs it, and only ever to search.
48
49
 
49
- Both files, and their specs, are published on npm as [`@eveshipfit/sde`](https://www.npmjs.com/package/@eveshipfit/sde).
50
+ ## npm
51
+
52
+ ```sh
53
+ npm install @eveshipfit/sde
54
+ ```
55
+
56
+ [`@eveshipfit/sde`](https://www.npmjs.com/package/@eveshipfit/sde) ships both files and the schemas, under `dist/` and `specs/`.
57
+
58
+ ## Python
59
+
60
+ ```sh
61
+ pip install eveshipfit-sde
62
+ ```
63
+
64
+ [`eveshipfit-sde`](https://pypi.org/project/eveshipfit-sde/) ships both files and the schemas, and the paths to them.
65
+
66
+ ```python
67
+ from eveshipfit_sde import build_number, names_path, sde_path, specs_path
68
+
69
+ dogma.load_sde_from_file(sde_path())
70
+ ```
71
+
72
+ `build_number()` reads the SDE build straight off the version.
50
73
 
51
74
  ## Releasing
52
75
 
53
76
  Every day at 12:00 UTC, `main` is built against the latest SDE.
54
- When the result differs from the latest release, the SDE build number aside, a new release is made and published on npm.
77
+ When the result differs from the latest release, the SDE build number aside, a new release is made and published on npm and PyPI.
55
78
  A change to the patches is released this way too.
56
79
 
57
80
  ## Patches
@@ -59,3 +82,8 @@ A change to the patches is released this way too.
59
82
  The SDE describes what the EVE client needs, not what a fitting tool needs.
60
83
  Align time, for example, is not an attribute; the client works it out.
61
84
  Patches add the missing attributes and effects, so a dogma-engine can work them out instead.
85
+
86
+ ## License
87
+
88
+ All EVE Online data belongs to CCP, and is subject to [their license agreement](https://developers.eveonline.com/license-agreement).
89
+ Everything EVEShip.fit-specific is MIT.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@eveshipfit/sde",
3
- "version": "4.3503375.2",
3
+ "version": "4.3503375.4",
4
4
  "description": "A patched EVE Online SDE, as flatbuffers, for EVEShipFit's dogma-engine",
5
5
  "repository": {
6
6
  "type": "git",