mirror of
https://github.com/daydreamer-json/ak-endfield-api-archive.git
synced 2026-04-04 14:42:25 +02:00
docs: edit readme
This commit is contained in:
56
README.md
56
README.md
@@ -1,4 +1,4 @@
|
||||
<h1 align="center">ak-endfield-api-archive</h2>
|
||||
<h1 align="center">ak-endfield-api-archive</h1>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/palmcivet/awesome-arknights-endfield"><img src="https://raw.githubusercontent.com/palmcivet/awesome-arknights-endfield/refs/heads/main/assets/badge-for-the-badge.svg" alt="Awesome Arknights Endfield" /></a>
|
||||
@@ -8,51 +8,55 @@
|
||||
<img src="https://api.cron-job.org/jobs/7183534/5f3f37a732a92096/status-0.svg" alt="Cron Job" />
|
||||
</p>
|
||||
|
||||
Monitor changes to responses from various Arknights: Endfield APIs and record them in this repository.
|
||||
This repository monitors and records changes to various Arknights: Endfield API responses.
|
||||
|
||||
Updates are checked about every 10 minutes and automatically pushed by GitHub Actions.
|
||||
Updates are checked approximately every 5 minutes and automatically pushed via GitHub Actions.
|
||||
API outputs are stored in the [`output`](/output/) directory.
|
||||
|
||||
The APIs currently being monitored are as follows:
|
||||
## [Download Library](https://ak-endfield-api-archive.daydreamer-json.cc/)
|
||||
|
||||
For a historical overview of game packages and other resources, please click the link above.
|
||||
|
||||
## Contents of the Archive
|
||||
|
||||
The following APIs are currently being monitored:
|
||||
- Launcher
|
||||
- Get latest game (Global, China)
|
||||
- Get latest game resources (Global, China)
|
||||
- Get latest launcher (Global, China)
|
||||
- Get launcher web resources (Global, China)
|
||||
- Announcement
|
||||
- Banner
|
||||
- Main background image
|
||||
- Announcements
|
||||
- Banners
|
||||
- Main background images
|
||||
- Single Ent.
|
||||
- Sidebar
|
||||
- Raw
|
||||
- Game resource json (index, patch)
|
||||
- Game resource manifests (index, patch)
|
||||
- Launcher image resources
|
||||
|
||||
Most of the raw data is provided as-is, without any modifications. Some data (`index_*.json`) has been decrypted.
|
||||
Most raw data is provided "as-is" without modification. Some files (e.g., `index_*.json`) have been decrypted for readability.
|
||||
|
||||
## Download Library
|
||||
The following data is archived in an external repository:
|
||||
- Game packages (.zip)
|
||||
- Game patch packages (.zip)
|
||||
- Game hotfix resources
|
||||
- To avoid the overhead of managing numerous small files, these are bundled into larger chunk files.
|
||||
- Launcher packages (.exe, .zip)
|
||||
|
||||
To easily view information about past versions of game packages and other items, please refer to the following page.
|
||||
For a full list of externally archived files, please refer to the mirror list JSON in the `output` directory. (Note: `*_pending` files are temporary files used during the archiving process.)
|
||||
|
||||
https://ak-endfield-api-archive.daydreamer-json.cc/
|
||||
|
||||
Previous pages created using Markdown will not be maintained.
|
||||
For users in Asia (including China, Japan, Korea): To speed up downloads, use any GitHub proxy service (such as [`gh-proxy.org`](https://gh-proxy.org/), which is cached by Cloudflare).
|
||||
|
||||
## Contributing
|
||||
|
||||
Since I can only run the game on platforms and operating systems that are available to me, there may be inaccuracies. If you have information -particularly regarding **Chinese regional game data**, beta versions, encrypted binaries such as `index_main.json` or `game_files`- or if you're able to help improve the code, or if you encounter any other issues, feel free to submit an issue or a pull request.
|
||||
|
||||
All files within the `output` folder are automatically generated by the `src` scripts. Therefore, to make changes, you must modify the scripts themselves.
|
||||
|
||||
## Disclaimer
|
||||
|
||||
This project has no affiliation with Hypergryph (GRYPHLINE) and was created solely for **private use, educational, and research purposes.**
|
||||
|
||||
I assume no responsibility whatsoever. **PLEASE USE IT AT YOUR OWN RISK.**
|
||||
As I can only test the game on the platforms and operating systems available to me, some data may contain inaccuracies. If you have information—particularly regarding **Chinese regional data** or beta versions—or if you would like to improve the code, please feel free to submit an issue or a pull request.
|
||||
|
||||
## Thanks
|
||||
|
||||
- [Vivi029](https://github.com/Vivi029): Added Windows Google Play Games channel
|
||||
- [Vivi029](https://github.com/Vivi029): Added Windows Google Play Games channel support.
|
||||
|
||||
---
|
||||
## Disclaimer
|
||||
|
||||
This project was created using `bun init` in bun v1.3.5. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
|
||||
This project is not affiliated with Hypergryph (GRYPHLINE) and was created solely for **private use, educational, and research purposes.**
|
||||
|
||||
The author assumes no responsibility for any consequences arising from the use of this project. **USE AT YOUR OWN RISK.**
|
||||
|
||||
Reference in New Issue
Block a user