Skip to content
This repository has been archived by the owner on Jun 9, 2022. It is now read-only.

Latest commit

 

History

History
238 lines (130 loc) · 6.5 KB

README.md

File metadata and controls

238 lines (130 loc) · 6.5 KB
Raw

dragalia-data-parse

parser-ci parser-cq-badge parser-coverage-badge parser-lgtm-alert-badge parser-lgtm-quality-badge parser-lgtm-loc-badge parser-time-badge

This parses the original Dragalia Lost assets to be the file usable for DL info website.

Developed under Python 3.9 (or higher).

Prerequisites

  • Install Python 3.9 or higher.

  • No dependencies required for now (2021/01/22).

    • If you want to develop this instead, run the below for installing the development dependencies.

      pip install -r requirements-dev.txt

  • Get all the data from the data depot.

    • This will be done by using git submodule.

      Initialize the submodule:

      git submodule init

      Update (download) the content of the submodule:

      git submoule update --remote

    • To update the data, simply run the git submodule update command:

      git submoule update --remote

Usage

Currently, there are no interactional scripts or CLI exists.

Instead, there are some express scripts. To configure them, directly modify the paramters inside.

These express scripts will be named as script_* where * will be the purpose of that script.

script_chara_overview

Get a quick overview of a certain character by specifying the character ID. Character ID should be an 8-digit number.

script_check_skill

Check if the newly added skills are all parsed.

script_data_diff

Check the data difference between different versions of the assets.

One asset will be the local version, and another will be one of the remote versions.

script_export_local

Export things (currently skills, and some enum texts) to a specific location.

Note that this is intended to export things for non-pipelining purposes, such as data viewing or correcting. For the pipelined data exporting, use script_export_pipeline instead.

script_export_pipeline

Export resources for the use of the DL info website.

For exporting things locally for viewing or other non-pipelining purposes, use script_export_local instead.

script_quest_overview

View the quest data.

script_view_hit_attr

View the data of all given hit attributes.

Credits

Main Developer

Correctness double-check

  • [OM] Andy / Toasty

  • [OM] Huang

  • [OM] Kevin Tu

  • [OM] Leo

  • [OM] Spark / AAAAA

  • [OM] Yorkwarm

Data inspection

Datamining and data deploying pipeline

  • [SimCord] qwewqa / Mustard Yellow

  • [SimCord] eave

  • [OM] Ryo

Miscellaneous discussions

  • [OM] Siena

Also thanks to everyone who had contributed to Gamepedia.

Notes

Some skill data in the tests is different from what is on Gamepedia.

Development Goals

  • This parser aims to parse all game assets correctly and automatically.

    Doing so gives the ability to automate the game data deploying process, reducing unnecessary works for every new updates.

  • As few dependencies as possible to run the parser.

    Doing so reduces the difficulty to deploy the data processing pipeline, since native Python packages seldom have cross-platform problems.

    This assumes that additional dependencies do not significantly boost the data processing speed or impact the security, which rarely happens in general.

For some asset notes or explanations, try visiting the notes section. Note that these documents may be incomplete or inaccurate.

Milestones

  • 2020/11/18 AM 11:01 CST: Project started.

  • 2020/11/19 PM 07:04 CST: First commit of the project (v0.1).

  • 2020/12/14 AM 06:09 CST: Completed attacking skills parsing (v1.0).

    This excludes Gala Laxi S2. Also, debuffs are not yet confirmed at this point.

  • 2020/12/22 PM 08:31 CST: Completed parsed data exporting (v1.1).

  • 2021/01/22 AM 10:58 CST: Completed EX ability/Co-ability parsing (v1.2).

  • 2021/01/23 PM 06:17 CST: Completed chained EX ability/Co-ability (CCA) parsing (v1.3).

  • 2021/01/24 PM 11:57 CST: Completed chained EX ability/Co-ability (CCA) exporting (v1.4).