aklive2d/README.md

aklive2d

A project that builds showcase webpage for Arknights Live2D-equipped operators. Showcase webpage can be used as a wallpaper for Wallpaper Engine on Windows or Plash on macOS (not tested).

Important Notice

Since ArknightsGameData failed to update in-game data due to new content structure, I will suspend the update of new wallpapers until new data sources or new solutions are found for voice lines. Otherwise, new wallpaper will no longer contain voice lines as well as new background and music.

Upcoming Updates

Version: 4th Anniversary

• Operator: Muelsyse
• Skin: Born as One / Specter the Unchained
• Skin: Ten Thousand Mountains / Ch'en/Chen the Holungday
• Skin: Remnant / Kal'tsit (probably with new voice)
• Background and Music Update
• Voice: Chinese Topolect for Lee

Softwares

• For Windows users: Use Wallpaper Engine or other softwares that support using webpage as desktop wallpaper.
• For macOS users: Use Plash, however, I don't have macOS machine, so your mileage may vary.
• For Linux users: You power user should be able to find your solutions!

Usage

Command Line Tool

$ npm run generate {operator_name}
To generate operator assets for showcase page

$ npm run dev {operator_name}
Live showcase page server for development

$ npm run build {operator_name}
Build showcase webpage for an operator

$ npm run build-all
To generate all operator assets for showcase page

$ npm run init {operator_name}
To initialize folder and config file for an operator

$ npm run readme {operator_name}
To add operator info to README.md

$ npm run directory
To generate directory.json

$ npm run charword
To generate the latest charword_table.json

Webpage & JavaScript

Add query string settings to bring up the settings panel to adjust your settings. Then use appropriate JavaScript code to load your settings

settings.setFPS(integer) // set FPS
settings.setLogoDisplay(boolean) // display logo or not
settings.setLogoRatio(float) // the ratio of the logo
settings.setLogoOpacity(float) // the opacity of the logo
settings.setLogo(url) // change the logo, url: image url, removeInvert: boolean
settings.resetLogoImage() // reset to the default logo
settings.setDefaultBackground(url) // change the default background, url: image filename from `background` folder
settings.setBackgoundImage(url) // change the background, url: image url
settings.resetBackground() // reset to the default background
settings.positionPadding("left", integer) // left padding
settings.positionPadding("right", integer) // right padding
settings.positionPadding("top", integer) // top padding
settings.positionPadding("bottom", integer) // bottom padding
settings.positionReset() // reset the position

settings.open() // open settings panel
settings.close() // close settings panel
settings.reset() // reset settings

Config

General Config

folder: 
  operator: ./operator/ # folder for operator assets
  release: ./release/ # folder for released showcase page
operators:
  chen: !include config/chen.yaml # include the config for the operator under folder `config/chen.yaml`
  dusk: !include config/dusk.yaml
  dusk_everything_is_a_miracle: !include config/dusk_everything_is_a_miracle.yaml
  ling: !include config/ling.yaml
  nearl: !include config/nearl.yaml
  nian: !include config/nian.yaml
  nian_unfettered_freedom: !include config/nian_unfettered_freedom.yaml
  phatom_focus: !include config/phatom_focus.yaml
  rosmontis: !include config/rosmontis.yaml
  skadi: !include config/skadi.yaml
  skadi_sublimation: !include config/skadi_sublimation.yaml
  w: !include config/w.yaml
  w_fugue: !include config/w_fugue.yaml
  specter: !include config/specter.yaml
  gavial: !include config/gavial.yaml
  surtr_colorful_wonderland: !include config/surtr_colorful_wonderland.yaml
  lee_trust_your_eyes: !include config/lee_trust_your_eyes.yaml
  texas_the_omertosa: !include config/texas_the_omertosa.yaml
  nearl_relight: !include config/nearl_relight.yaml
  rosmontis_become_anew: !include config/rosmontis_become_anew.yaml
  passager_dream_in_a_moment: !include config/passager_dream_in_a_moment.yaml
  mizuki_summer_feast: !include config/mizuki_summer_feast.yaml

Operator Config

link: chen # the link to access showcase page for this operator
type: operator # operator live2d or skin live2d
date: 2021/08 # release date
title: 'Arknights: Ch''en/Chen the Holungday - 明日方舟：假日威龙陈' # page title
filename: dyn_illust_char_1013_chen2 # live2d assets name
logo: logo_rhodes_override # operator logo
fallback_name: char_1013_chen2_2 # fallback image name
viewport_left: 0 # live2d view port settings
viewport_right: 0
viewport_top: 1
viewport_bottom: 1
invert_filter: false # operator logo invert filter

LICENSE

The LICENSE file applies to all files unless listed specifically.

LICENSE_SPINE file applies to following files including adapted code for this repo:

• src/libs/spine-player.css
• src/libs/spine-player.js

Copyright © 2017 - 2023 Arknights/Hypergryph Co., Ltd applies to following files:

• all files under operator folder and its sub-folders

Instructions on Extracting In-Game Assets

I'm still struggling to find a command-line tool to extract in-game assets. But AssetRipper seems to have a command-line interface, I'm too lazy to have a deeper inverstigation.

Assets Name	Location	Type
Logos	spritepack/ui_camp_logo_h2_0.ab	Sprite
Logos for collaboration	spritepack/ui_camp_logo_h2_linkage_0.ab	Sprite
Dynaimc Character	arts/dynchars/	Texture2D & TextAsset
Static Image	Operator: chararts/ ; Skin: skinpack/	Texture2D
Background	arts/ui/homebackground/wrapper/	Sprite
Voice Clips	audio/sound_beta_2/voice{_*}/	AudioClip
Voice Lines3	gamedata/excel/charword_table.ab	TextAsset
Portrait Images1	arts/charportraits	Texture2D
Home Music2	audio/sound_beta_2/music	AudioClip

¹: portrait_hub is required to locate the image

²: gamedata/excel/display_meta_table.json->homeBackgroundData³ is required to locate the music. A more detailed mapping can be found at 音乐鉴赏/游戏内音乐一览 - PRTS.wiki and 首页场景一览 - PRTS.wiki

³: Data is encryped, decryped version can be obtained from ArknightsGameData

Supported Operators

Operator	Live Preview	Steam Workshop
Nian	Link	Link
Unfettered Freedom / Nian	Link	Link
Focus / Phatom	Link	Link
W	Link	Link
Wonder / W	Link	Link
Rosmontis	Link	Link
Dusk	Link	Link
Everything is a Miracle / Dusk	Link	Link
Skadi the Corrupting Heart	Link	Link
Sublimation / Skadi the Corrupting Heart	Link	Link
Ch'en the Holungday	Link	Link
Nearl the Radiant Knight	Link	Link
Ling	Link	Link
Specter the Unchained	Link	Link
Gavial the Invincible	Link	Link
Colorful Wonderland / Surtr	Link	Link
Trust Your Eyes / Lee	Link	Link
Texas the Omertosa	Link	Link
Relight / Nearl	Link	Link
Become Anew / Rosmontis	Link	Link
Dream in a Moment / Passager	Link	Link
Summer Feast / Mizuki	Link	Link
Chongyue	Link	Link
It Does Wash the Strings / Ling	Link	Link
Snowy Plains in Words / Позёмка	Link	Link