arkwaifu

README

ArkWaifu (arkwaifu)

Arkwaifu is a website which, arranges and provides almost all picture assets extracted from Arknights (the game).

Arkwaifu also enlarges (4x) the picture assets with super-resolution neural networks, Real-ESRGAN and Real-CUGAN.

Currently, only assets, that appear in the "in-game stories" (what we call: AVG), are available, including:

• "Images". They are the exquisite arts that appear when some special events happened.
• "Backgrounds". They are the backgrounds that always appear on the bottom layer, during dialogue.
• "Characters". They are the pictures of characters that act in the play, some of them are with different emotions.

I also plan to include the artwork of characters in-game. However, by considering some technical difficulties, especially there are some animated artworks, the plan is delayed.

This project is now available online! Check it at arkwaifu.cc (main site), or cn.arkwaifu.cc (CN mirror)! 🎉

Features

• Assets are kept up-to-date automatically whenever the game is updated.
• Assets are enlarged with super-resolution neural networks (Real-ESRGAN , Real-CUGAN).
• Assets are classified into handy categories (AVG, non-AVG; main stories, activities; etc.).
• Containerized backend (microservices) and frontend.
• The backend follows microservice architecture and is split into two services: 'service', which serves the data, and 'updateloop' which updates the data automatically.

V1 Roadmap

• Beautify the frontend.
• List assets which aren't included in AVGs.
• Use cache to speed up the website (backend).
• Use cache to speed up the website (frontend).
• Pull only differences in every update loop.
• I18N 🌏! Add Chinese support.
• Extract gamedata directly from the game resources.
• Create API to manually update the resources.
• Support enlarging picture assets with neural networks.
• Redesign & Rewrite the controller interface.
• Redesign the frontend UX.
• Support assets searching.
• Provide a choice to switch the website language.
• Automatically switch the website language to user's language automatically.
• //...

Design

For the design documentation, see 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 hands dirty" methodology very much.

Thanks to my friend Martin Wang! He helped me in extracting the gamedata assets, and also in some details of automatically updating the assets from the game.

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.

Thanks to xinntao, nihui, and the other contributors of Real-ESRGAN and Real-CUGAN! They created the neural networks this project utilizes for enlarging assets.

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).

This project utilizes Real-ESRGAN and Real-ESRGAN-ncnn-vulkan, which are respectively licensed under the BSD-3-Clause license and the MIT License.

This project utilizes Real-CUGAN and Real-CUGAN-ncnn-vulkan, which are both licensed under the MIT License.

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