@lycoristech/azurapi 0.1.3 → 0.1.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.
- package/README.md +5 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@ A self-maintained, current Azur Lane data library. Drop-in replacement for the `
|
|
|
11
11
|
|
|
12
12
|
## Why?
|
|
13
13
|
|
|
14
|
-
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/
|
|
14
|
+
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/AzurLaneLuaScripts](https://github.com/AzurLaneTools/AzurLaneLuaScripts) and [nobbyfix/AzurLane-AssetDownloader](https://github.com/nobbyfix/AzurLane-AssetDownloader) repos so our data stays fresh within hours of each game patch.
|
|
15
15
|
|
|
16
16
|
## Installation
|
|
17
17
|
|
|
@@ -52,13 +52,13 @@ That's it. The `ships.get()` API is compatible. Ship objects match the same sche
|
|
|
52
52
|
|
|
53
53
|
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).
|
|
54
54
|
|
|
55
|
-
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/
|
|
55
|
+
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/AzurLaneLuaScripts](https://github.com/AzurLaneTools/AzurLaneLuaScripts).
|
|
56
56
|
|
|
57
57
|
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.
|
|
58
58
|
|
|
59
59
|
## Data Freshness
|
|
60
60
|
|
|
61
|
-
Data is auto-refreshed weekly (every Monday)
|
|
61
|
+
Data is auto-refreshed via GitHub Actions whenever [iujab/azurlane-images](https://github.com/iujab/azurlane-images) updates, with a weekly fallback (every Monday), from [AzurLaneTools/AzurLaneLuaScripts](https://github.com/AzurLaneTools/AzurLaneLuaScripts) (EN + CN + JP regions), which tracks every game patch within hours. The refresh pipeline:
|
|
62
62
|
1. Sparse-clones the upstream Lua scripts
|
|
63
63
|
2. Converts the Lua config tables to JSON (`scripts/lua2json.py`, needs Python + `lupa`)
|
|
64
64
|
3. Normalizes raw game tables into AzurAPI-compatible JSON
|
|
@@ -135,6 +135,7 @@ This is an **unofficial, non-commercial, community-maintained fan project**. It
|
|
|
135
135
|
|
|
136
136
|
## Acknowledgments
|
|
137
137
|
|
|
138
|
-
- [AzurLaneTools/
|
|
138
|
+
- [AzurLaneTools/AzurLaneLuaScripts](https://github.com/AzurLaneTools/AzurLaneLuaScripts) — upstream auto-updating game data
|
|
139
|
+
- [AzurLaneTools/AzurLaneData](https://github.com/AzurLaneTools/AzurLaneData) — original JSON data source (until 2026-05-08)
|
|
139
140
|
- [nobbyfix/AzurLane-AssetDownloader](https://github.com/nobbyfix/AzurLane-AssetDownloader) — game asset extraction
|
|
140
141
|
- [AzurAPI/azurapi-js](https://github.com/AzurAPI/azurapi-js) — the original library whose schema we replicate, and the base inspiration for this project!❤️
|