arkwaifu

README

ArkWaifu (arkwaifu)

A website showing all Arknights assets (including AVG images and backgrounds currently).

This project is currently under development.

This project is now available online! Check it at ArkWaifu (https://arkwaifu.cc/)! 🎉

TODOs V1

• Beautify the frontend. (Done, probably uglified)
• List assets which aren't included in AVGs. e.g., assets appeared in mode Integrated Strategies.
• Use cache to speed up website (backend).
• Use cache to speed up website (frontend).
• Pull only differences every update loop.
• I18N 🌏! Add Chinese support.
• Extract gamedata directly from resources.
• Provide API to manually update resources.
• Assets image super-resolution. (Real-ESGRAN or Real-CUGAN) (Partially Done)
• Rewrite controller interface. (Partially Done)
• Advertise ArkWaifu on Bilibili or somewhere...
• Create a statistic module to show how many times the website is requested.
• //...

Design

For the design documentation, view here (DESIGN.md).

Acknowledgements

Thanks to my friend Galvin Gao! He helped me a lot in the front-end development and choosing frameworks. I really appreciate the "getting hand dirty" methodology very much.

Thanks to my friend Lily! She drew the fascinating Phantom logo of this project.

Thanks to Penguin Statistics! The prototype of this project referenced and is inspired by Penguin Statistics' backend v3.

License

The source code of this project is licensed under the MIT License.

The assets of this project are licensed under Attribution-NonCommercial 4.0 International (CC BY-NC 4.0).

This project utilizes resources and other works from the game Arknights. The copyright of such works belongs to the provider of the game, 上海鹰角网络科技有限公司 (Shanghai Hypergryph Network Technology Co., Ltd).

Some initial template source code of this project is inspired by the backend v3 of Penguin Statistics, which is licensed under the MIT License.

[x] TODOs V0

• Follow the package style guideline. While I'm currently working on making this app running, therefore this project isn't following the package style guideline (https://github.com/danceyoung/paper-code/blob/master/package-style-guideline/packagestyleguideline.md)
• Complete the updateloop. The updateloop updates the resources and gamedata continuously; it ensures the data is always up-to-date.
• Complete the AVG part of ArkWaifu. In brief, the AVG part handles the requests related to gamedata (i.e., anything except for image resources).
• Complete the Resource part of ArkWaifu. The resource part handles the requests of static resources, like image files and background files.
• Complete the frontend of ArkWaifu. There should be a sidebar with categories: AVGs or ALL. The AVGs shows all AVG groups, and there are AVG stories under the AVG groups. The frontend shows all AVG resources under the user chosen group or story. Under the ALL category, the frontend simply shows all existing resources.
• Dockerize ArkWaifu with CI (GitHub actions).
• Make ArkWaifu go live!