MaaAssistantArknights/tools/OverseasClients/FindMissingTemplates.py

# WHAT DOES THIS TOOL DO?
#
# In order for MAA ZH-server features to be compatible with global servers,
# crops/screenshots/templates of ZH servers with Chinese characters etc. must be
# replaced with those of corresponding global servers, which needs your help.
# This tool helps you find which templates in ZH server (usually recently added)
# have not yet had a global server version, and copy them to a separate folder
# so that you can easily .
#
# There are some ZH templates without any Chinese characters etc. which can thus
# be used across different servers. You may add them to the ignore_list.txt
# file.
#
# USAGE
#
# 1. Install Python
# 2. Run "$python diff_resource.py xxx" in the terminal where xxx is the desired
# server name i.e. YoStarJP/YoStarEN/YoStarKR/txwy
# 3. Results can be found in the missing_templates folder
#


import os
import re
import shutil
import sys

# NOTE
# Put the file names of text-less images (so that global servers use the same
# image as the ZH (ZH_CN) server does) in this file.
# Note you have to manually update the content of this file.
ignore_list_file_name = "ignore_list_of_templates.txt"

# NOTE
# You may customize here
regex_ignore_list = [
    # OVERSEAS
    # UNRELEASED THEMES
    "DahuangCity",
    # UNRELEASED I.S.
]

server_list = ["YoStarJP", "YoStarEN", "YoStarKR", "txwy"]

cur_dir = os.path.dirname(os.path.abspath(__file__))
proj_dir = os.path.join(cur_dir, "../../")


def find_missing_templates(server_name):

    zh_dir = os.path.join(proj_dir, "resource/template/")
    gl_dir = os.path.join(
        proj_dir, "resource/global/", server_name, "resource/template/"
    )

    zh_files = [
        f for f in os.listdir(zh_dir) if os.path.isfile(os.path.join(zh_dir, f))
    ]
    gl_files = [
        f for f in os.listdir(gl_dir) if os.path.isfile(os.path.join(gl_dir, f))
    ]

    with open(os.path.join(cur_dir, ignore_list_file_name)) as f:
        ignore_files = [line.rstrip("\n") for line in f]

    # ZH server pics not found in global server nor ignored will be filtered here
    diff_files = [
        f
        for f in zh_files
        if not any(map(lambda x: re.search(x, f), regex_ignore_list))
        and f not in gl_files
        and f not in ignore_files
    ]

    # These pictures will be copied to the missing_templates folder for reference.
    # Contributors of global servers may screenshot the corresponding files.
    # Note this folder is in .gitignore so it will not be uploaded.
    out_dir = os.path.join(cur_dir, "missing_templates/", server_name)
    if os.path.exists(out_dir):
        shutil.rmtree(out_dir)
    os.makedirs(out_dir)

    for f in diff_files:
        # print(f)
        shutil.copyfile(os.path.join(zh_dir, f), os.path.join(out_dir, f))

    print(
        "Pictures not included in",
        server_name,
        "server resources is copied to missing_templates/" + server_name,
    )


def main():
    # Get the server name from argument
    # try:
    #     # server_name = "YoStarJP"
    #     server_names = sys.argv[1:]
    #     for server_name in server_names:
    #         if server_name not in server_list:
    #             raise Exception(f"{server_name} is not a valid server name.")
    # except Exception as e:
    #     print(e)
    #     server_names = None
    #     while (not server_names):
    #         print("Enter one or more server names separated by space:",
    #             ", ".join(server_list))
    #         t = input()
    #         server_names = t.split() if all(name in server_list for name in t.split()) else None

    server_names = sys.argv[1:]
    if not server_names:
        server_names = server_list

    for server_name in server_names:
        find_missing_templates(server_name)


if __name__ == "__main__":
    main()