@lycoristech/azurapi 0.0.4 → 0.1.0
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.
- package/LICENSE +674 -21
- package/README.md +16 -6
- package/data/id-map.json +24 -0
- package/data/ship-list.json +36 -0
- package/data/ships.json +882 -10
- package/data/version.json +2 -2
- package/dist/cjs/config.js +2 -2
- package/dist/config.d.ts +1 -1
- package/dist/config.d.ts.map +1 -1
- package/dist/config.js +2 -2
- package/dist/config.js.map +1 -1
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
<img src="https://github.com/iujab/azurlane-images/blob/main/banner.png" />
|
|
2
2
|
|
|
3
|
-
# AzurAPI
|
|
3
|
+
# LycorisTech/AzurAPI
|
|
4
4
|
|
|
5
5
|
A self-maintained, current Azur Lane data library. Drop-in replacement for the `@azurapi/azurapi` package.
|
|
6
6
|
|
|
7
7
|
## Why?
|
|
8
8
|
|
|
9
|
-
The older and amazing `@azurapi/azurapi` ecosystem is now 3+ years stale. I have fond memories starting off my computer science hobby building a discord bot using that API. Recently, when revisiting
|
|
9
|
+
The older and amazing `@azurapi/azurapi` ecosystem is now 3+ years stale. I have fond memories starting off my computer science hobby building a discord bot using that API. Recently, when revisiting my old discord bot, I noticed that the azurapi package was years out of date, likely due to the wiki scraper method no longer being viable. This AzurAPI builds on the [AzurLaneTools/AzurLaneData](https://github.com/AzurLaneTools/AzurLaneData) and [nobbyfix/AzurLane-AssetDownloader](https://github.com/nobbyfix/AzurLane-AssetDownloader) repos so our data stays fresh within hours of each game patch.
|
|
10
10
|
|
|
11
11
|
## Installation
|
|
12
12
|
|
|
@@ -43,6 +43,14 @@ const results = azur.ships.search("Enterp", 5); // top 5 matches
|
|
|
43
43
|
|
|
44
44
|
That's it. The `ships.get()` API is compatible. Ship objects match the same schema!
|
|
45
45
|
|
|
46
|
+
### Relationship to the original AzurAPI project
|
|
47
|
+
|
|
48
|
+
This library is a **schema-compatible successor** to [`@azurapi/azurapi`](https://github.com/AzurAPI/azurapi-js) (GPL-3.0) and its sister data repo [`AzurAPI/azurapi-js-setup`](https://github.com/AzurAPI/azurapi-js-setup) (AGPL-3.0).
|
|
49
|
+
|
|
50
|
+
This project is not a fork and does not contain any code from those repositories. It is an independent rewrite built from scratch against the decompiled game data from [AzurLaneTools/AzurLaneData](https://github.com/AzurLaneTools/AzurLaneData).
|
|
51
|
+
|
|
52
|
+
The output JSON schema (field names, structure, rarity values, etc.) is deliberately kept shape-compatible with the original so existing devs can migrate with a single import change.
|
|
53
|
+
|
|
46
54
|
## Data Freshness
|
|
47
55
|
|
|
48
56
|
Data is auto-refreshed weekly (every Monday) via GitHub Actions from [AzurLaneTools/AzurLaneData](https://github.com/AzurLaneTools/AzurLaneData) (EN + CN + JP regions). The refresh pipeline:
|
|
@@ -71,7 +79,7 @@ Ships have the full AzurAPI-compatible shape including:
|
|
|
71
79
|
The committed `data/ships.json` is fetchable via GitHub raw URL:
|
|
72
80
|
|
|
73
81
|
```
|
|
74
|
-
https://raw.githubusercontent.com/iujab/AzurAPI/main/data/ships.json
|
|
82
|
+
https://raw.githubusercontent.com/iujab/Lycoris-AzurAPI/main/data/ships.json
|
|
75
83
|
```
|
|
76
84
|
|
|
77
85
|
Also available: `ship-list.json` (minimal index), `id-map.json` (name→id lookup), `version.json`.
|
|
@@ -102,12 +110,14 @@ Ship paintings and thumbnails are hosted in a separate GitHub repo: [iujab/azurl
|
|
|
102
110
|
- **Paintings** — skin art in WebP format (`paintings/{asset_name}.webp`)
|
|
103
111
|
- **Thumbnails** — shipyard icons in PNG format (`thumbnails/{group_type}.png`)
|
|
104
112
|
|
|
105
|
-
## License
|
|
113
|
+
## License and Rights
|
|
114
|
+
|
|
115
|
+
This software is licensed under the **GNU General Public License v3.0** — see [LICENSE](LICENSE).
|
|
106
116
|
|
|
107
|
-
|
|
117
|
+
This is an **unofficial, non-commercial, community-maintained fan project**. It is not developed, endorsed, sponsored, or in any way affiliated with Manjuu, Yongshi, Yostar, or any of their subsidiaries.
|
|
108
118
|
|
|
109
119
|
## Acknowledgments
|
|
110
120
|
|
|
111
121
|
- [AzurLaneTools/AzurLaneData](https://github.com/AzurLaneTools/AzurLaneData) — upstream auto-updating game data
|
|
112
122
|
- [nobbyfix/AzurLane-AssetDownloader](https://github.com/nobbyfix/AzurLane-AssetDownloader) — game asset extraction
|
|
113
|
-
- [AzurAPI/azurapi-js](https://github.com/AzurAPI/azurapi-js) — the original library whose schema we replicate, and
|
|
123
|
+
- [AzurAPI/azurapi-js](https://github.com/AzurAPI/azurapi-js) — the original library whose schema we replicate, and the base inspiration for this project!❤️
|
package/data/id-map.json
CHANGED
|
@@ -661,6 +661,12 @@
|
|
|
661
661
|
"10154": "1150004",
|
|
662
662
|
"10155": "1150005",
|
|
663
663
|
"10156": "1150006",
|
|
664
|
+
"10990": "1060010",
|
|
665
|
+
"10991": "1060011",
|
|
666
|
+
"10992": "1060012",
|
|
667
|
+
"10993": "1060013",
|
|
668
|
+
"10994": "1060014",
|
|
669
|
+
"10995": "1060015",
|
|
664
670
|
"20001": "29901",
|
|
665
671
|
"20002": "29902",
|
|
666
672
|
"20003": "39901",
|
|
@@ -3300,6 +3306,24 @@
|
|
|
3300
3306
|
"Tamaki": "1060009",
|
|
3301
3307
|
"环": "1060009",
|
|
3302
3308
|
"たまき": "1060009",
|
|
3309
|
+
"Elise": "1060010",
|
|
3310
|
+
"伊莉丝": "1060010",
|
|
3311
|
+
"エリーゼ": "1060010",
|
|
3312
|
+
"Shizuku": "1060011",
|
|
3313
|
+
"雫": "1060011",
|
|
3314
|
+
"しずく": "1060011",
|
|
3315
|
+
"Shandy": "1060012",
|
|
3316
|
+
"香迪": "1060012",
|
|
3317
|
+
"シャンディ": "1060012",
|
|
3318
|
+
"Tsukushi": "1060013",
|
|
3319
|
+
"筑紫 ": "1060013",
|
|
3320
|
+
"つくし": "1060013",
|
|
3321
|
+
"Patty": "1060014",
|
|
3322
|
+
"派蒂": "1060014",
|
|
3323
|
+
"パティ": "1060014",
|
|
3324
|
+
"Yukino": "1060015",
|
|
3325
|
+
"千乃": "1060015",
|
|
3326
|
+
"ゆきの": "1060015",
|
|
3303
3327
|
"Haruka Amami": "1070001",
|
|
3304
3328
|
"天海春香": "1070001",
|
|
3305
3329
|
"Chihaya Kisaragi": "1070002",
|
package/data/ship-list.json
CHANGED
|
@@ -4181,6 +4181,42 @@
|
|
|
4181
4181
|
"hullType": "Battlecruiser",
|
|
4182
4182
|
"rarity": "Super Rare"
|
|
4183
4183
|
},
|
|
4184
|
+
{
|
|
4185
|
+
"id": "1060010",
|
|
4186
|
+
"name": "Elise",
|
|
4187
|
+
"hullType": "Aircraft Carrier",
|
|
4188
|
+
"rarity": "Super Rare"
|
|
4189
|
+
},
|
|
4190
|
+
{
|
|
4191
|
+
"id": "1060011",
|
|
4192
|
+
"name": "Shizuku",
|
|
4193
|
+
"hullType": "Battleship",
|
|
4194
|
+
"rarity": "Super Rare"
|
|
4195
|
+
},
|
|
4196
|
+
{
|
|
4197
|
+
"id": "1060012",
|
|
4198
|
+
"name": "Shandy",
|
|
4199
|
+
"hullType": "Heavy Cruiser",
|
|
4200
|
+
"rarity": "Super Rare"
|
|
4201
|
+
},
|
|
4202
|
+
{
|
|
4203
|
+
"id": "1060013",
|
|
4204
|
+
"name": "Tsukushi",
|
|
4205
|
+
"hullType": "Destroyer",
|
|
4206
|
+
"rarity": "Super Rare"
|
|
4207
|
+
},
|
|
4208
|
+
{
|
|
4209
|
+
"id": "1060014",
|
|
4210
|
+
"name": "Patty",
|
|
4211
|
+
"hullType": "Submarine",
|
|
4212
|
+
"rarity": "Super Rare"
|
|
4213
|
+
},
|
|
4214
|
+
{
|
|
4215
|
+
"id": "1060015",
|
|
4216
|
+
"name": "Yukino",
|
|
4217
|
+
"hullType": "Light Cruiser",
|
|
4218
|
+
"rarity": "Super Rare"
|
|
4219
|
+
},
|
|
4184
4220
|
{
|
|
4185
4221
|
"id": "1070001",
|
|
4186
4222
|
"name": "Haruka Amami",
|