Dec 22, 2024

BlockFront Managerを作った

はじめに

この記事は僕の所属するMMAというサークルでのアドベントカレンダーMMA Advent Calendar 2024 - Adventarの22日目の記事です。

昨日(12/21)の記事はgaeさんのSlackAPIを使っていろいろ入手してみようでした。 gaeさんには今後ろから拳銃(部長権限)をつきつけられているので、早く進捗ださないとなって感じです。

今回はBlockFrontというMineCraftのMODのバージョン管理ツールを作ったので、紹介します。

前提

BlockFrontについては、以下のサイト等を参考にしてくだい。

BlockFront is an action-packed Minecraft modification that allows players to immerse themselves in realistic combat during the Second World War.

https://modrinth.com/mod/blockfront

BlockFrontはネット対戦型のMODで、最新のバージョンでないと遊べないようになっています。更新はそれなりの頻度で来るのですが、手動でファイルをダウンロードし、時には前提MODであるneoforgeも更新する必要があるので大変です。今回はその作業を半自動化しました。

従来の更新手順

BlockFrontの従来の更新の際に行っていた手順をまとめます。

まず、公式Discordサーバーかゲーム内通知で最新バージョンがリリースされていることを知ります。

modrinthに行き、最新のバージョンのMODファイルをダウンロードします。ダウンロードしたファイルはMinecraft launcherで指定しているmodsフォルダ―の中に配置します。

次に、最新バージョンのBlockFrontが対応しているNeoForgeを確認し、更新が必要ならNeoforgeのインストーラーをneoforge.netからダウンロードします。その後インストーラーを使ってクライアント用NeoForgeをインストールします。

これで更新終了です。

BlockFront Manager

自分以外に使う人がいるのか分かりませんが、今回作ったものは以下で一応Publicで公開しています。

GitHub - kanakana-rcj/BlockFrontManager: my version-manager of blockfront

my version-manager of blockfront. Contribute to kanakana-rcj/BlockFrontManager development by creating an account on GitHub.

https://github.com/kanakana-rcj/BlockFrontManager

GitHub - kanakana-rcj/BlockFrontManager: my version-manager of blockfront

言語はPython, ライブラリはbeautifulsoupなどを使ってます。

ターミナル上で使う前提で作りました。一応LinuxでもWindowsでも動作するはずです。

BlockFrontが最新かどうかを調べる

まず、更新が必要なのかどうか分かるようにします。そのために現在modsフォルダにあるBlockFrontのバージョンと、modrinthで公開されている最新のバージョンが一致しているかどうかを調べます。

modrinthで公開されている最新のバージョンを得るには、スクレイピングが必要です。スクレイピングといえばpythonのbeautifulsoupが便利そうなので、pythonを用いて開発することにしました。

modrinth/blockfront/versions の一番上に書いてあるバージョン番号を取ってくればよさそうです。ここでバージョン番号のみをとってきても良いのですが、後にファイルのダウンロードも行うつもりだったので、modファイルのURLを取得することにします。

modファイルのURLはダウンロードボタンを押したときのGETリクエストの内容から確認できました。

modrinth/blockfront/versionsのHTMLを調べ、このダウンロードボタンのHTMLタグを探します。すると、arial-label:Downloadがついているaタグのhref属性に、modファイルのURLがあったので、このaタグがダウンロードボタンに設定されているものと分かりました。よって、arial-label:Downloadとされているaタグのなかで、一番上のaタグのhref属性のURLを取り出すことにします。

具体的には以下のような処理をしています。

def get_latest_blockfront_url():
    url = 'https://modrinth.com/mod/blockfront/versions'
    response = requests.get(url)
    soup = BeautifulSoup(response.text, "html.parser")

    #arial-label : Download　の aタグの中で最初のものを取得
    a_tag = soup.find('a', {'aria-label': 'Download'})

    if a_tag:
        latest_blockfront_url = a_tag.get('href')
        return latest_blockfront_url
    else:
        print("<a> tag not found")

BlockFrontのファイル名は、BlockFront-1.21.1-0.6.0.2b-RELEASE.jarのような形式で統一されているので、ファイル名からバージョンを取り出すことができます。システムにあるmodファイルについても同様に、ファイル名からバージョンを取り出します。

最後にmodsフォルダ内とサイト側のバージョン文字列を比較して、同じだったら最新と判断します。

最新のBlockFrontが要求するNeoForgeのバージョンを知る

さて、システムにあるNeoForgeが、最新のBlockFrontがサポートするNeoForgeのバージョンなのかどうかも知りたいです。

ここで一つ難点がありました。 modrinthには、一部のBlockfrontバージョンについて、サポートしているNeoForgeのバージョンが明記されていませんでした。 (全てのバージョンについてサポートするNeoforgeのバージョン範囲が明記されていると嬉しかったのですが)

仕方ないので、modrinth/blockfront/Changelogを参考にすることにしました。サポートするneoforgeのバージョン範囲が変わったときには、必ずその旨がUpdate to the latest version of NeoForge(21.xx.xx)といった形式でchangelogに書いてありました。よって、Changelogの中で最後に書かれた (21.xx.xx) を、最新のBlockFrontのNeoForge対応バージョンだと考えます。

Changelogのページをスクレイピングして、Update to the latestまでを含む行のなかで、一番上のものを取得します。 (なぜUpdate to the latestまでなのかというと、その次の単語がversionのものとreleaseのものがあったからです…😢) その行の中で括弧に囲まれた文字列を探し、取り出します。

def get_required_neoforge_version():
    url = "https://modrinth.com/mod/blockfront/changelog"
    response = requests.get(url)
    soup = BeautifulSoup(response.text, "html.parser")

    matching_tags = soup.find_all(string=lambda text: "NeoForge" in text if text else False)

    required_neoforge_version = ""
    for tag in matching_tags:
        if tag.find("Updated to the latest") != -1:
            open_parenthesis_index = tag.find("(")
            close_parenthesis_index = tag.find(")")
            required_neoforge_version = tag[open_parenthesis_index+1:close_parenthesis_index]
            break
    return required_neoforge_version

これで最新のBlockFrontがサポートするNeoForgeのバージョンを得ることが出来ました。

あとはPCにあるNeoForgeのインストーラーのファイル名(neoforge-21.1.77-installer.jarのような形式)から現在のバージョンを推測します。そしてmodrinthからとってきたバージョンと比較します。

Blockfrontのバージョン比較機能と、Neoforgeのバージョン比較機能を合わせると、最終的にこのように動作するようになりました。

$ python3 ./main.py status
latest BlockFront URL: https://cdn.modrinth.com/data/hTexWmdS/versions/4fh84LES/BlockFront-1.21.1-0.6.0.2b-RELEASE.jar
BlockFront latest file:  BlockFront-1.21.1-0.6.0.2b-RELEASE.jar
BlockFront latest version:  0.6.0.2b

BlockFront requires NeoForge version: 21.1.77
required NeoForge URL: https://maven.NeoForged.net/releases/net/NeoForged/NeoForge/21.1.77/NeoForge-21.1.77-installer.jar
required NeoForge filename: NeoForge-21.1.77-installer.jar

system BlockFront version: 0.6.0.2b
system NeoForge version: 21.1.77

BlockFront is up to date
NeoForge is up to date

おわりに

今回作ったものの概要は以上になります。実はpythonはCTFぐらいでしか使わなかったので、しっかり使ったのはこれが初めてでした。勘で書いたのでだいぶ汚いコードになってしまいました。

ただ、スクレイピング・httpリクエストなどの処理を少しだけ触れたのは良かったです。普通に自分が使えるものが作れたのも大きいです。

明日(12/23)はnamorさんの記事です。乞うご期待!