Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
5610006
マルチバージョン対応の土台を追加
malken21 Oct 13, 2026
363d1fa
チャットの多言語対応と色付け、検証スクリプトの改善
malken21 Oct 13, 2026
24e8b8e
Minecraft 1.7.10 に対応 (Forge / LiteLoader)
malken21 Oct 13, 2026
96b8bac
Minecraft 1.8 - 1.12.1 に対応 (Forge / LiteLoader)
malken21 Oct 13, 2026
6bf27bf
Minecraft 26.1 - 26.3 向けの実装を追加 (Fabric / Forge / NeoForge)
malken21 Oct 13, 2026
c8819a4
1.21.9 以降の実装を共通部分とバージョン別の差分に整理し、1.21.11 を追加
malken21 Oct 13, 2026
69bf6a7
画像を陰影なしで描くように変更し、検証スクリプトと README を更新
malken21 Oct 13, 2026
5bb51df
Minecraft 1.20 - 1.21.8 向けの実装を追加し、1.14 以降の構成を層に分けて整理
malken21 Oct 13, 2026
c72d066
動画と音声の再生に対応 (core)
malken21 Oct 13, 2026
b2798d0
3D モデル (glTF / GLB) に対応し、Minecraft 1.14 - 1.19.4 と 1.21.9 - 1.21.10 向…
malken21 Oct 13, 2026
18f3428
3D モデルの描画が Java 8 で動かない問題を修正し、まとまりを描く処理を再利用できる形に整理
malken21 Oct 13, 2026
a5a29f0
Minecraft 1.21.2 - 1.21.3 向けのビルドを 1.21.4 から分離
malken21 Oct 13, 2026
aead7ca
看板の文字を持つ看板アイテムの見た目を、看板と同じ内容で描くように変更 (1.14 - 1.16.5 を除く)
malken21 Oct 13, 2026
154c5a6
Forge 1.15 - 1.19.4 で、カメラの向きが軸にぴったり沿うと看板の絵が消える問題を回避
malken21 Oct 13, 2026
bde67bb
Minecraft 26.2 以降で看板の板が隠れない問題を修正し、ワールドに入る前にアイテムの情報を読んでエラーになる問題を修正
malken21 Oct 13, 2026
d8230ed
Minecraft 1.14 - 1.16.5 でも、看板の文字を持つ看板アイテムの見た目を看板と同じ内容で描くように変更
malken21 Oct 13, 2026
05465da
1.7.10 の LiteLoader で看板アイテムの差し替えに失敗する問題と、1.9 - 1.12.2 で手持ちの枠に反映されない問題を修正
malken21 Oct 13, 2026
eae5fbb
1.7.10 の LiteLoader と 1.8 系の看板アイテムの表示を修正し、確認スクリプトの判定範囲を調整
malken21 Oct 13, 2026
d292cd5
影 Mod を入れた状態での確認を追加し、26.2 以降でワールドに入る前にブロックのモデルを読んでエラーになる問題を修正
malken21 Oct 13, 2026
4250bbf
OptiFine のシェーダーが有効なときに、看板の絵が白くにじむ問題を修正 (1.7.10 - 1.12.2) し、影 Mod 入りの確…
malken21 Oct 13, 2026
e59e966
影 Mod 入りの確認で、影 Mod が必要とする Mod の版を jar の指定に合わせて選ぶように変更し、ワールドに入るまでの待ち時間を延長
malken21 Oct 13, 2026
8544655
同梱のリソースパックの対応バージョンを全バージョンに広げ、Fabric API がある環境で非対応として外される警告を解消
malken21 Oct 13, 2026
873d566
影 Mod が光の計算に使えるように、絵の面の向きを指定 (1.7.10 - 1.14.4)
malken21 Oct 13, 2026
648c4f2
影 Mod 入りの確認結果を報告に含め、README に影 Mod との併用について追記
malken21 Oct 13, 2026
4e29bfe
影 Mod 入りの確認で、シェーダーパックと影 Mod (OptiFine) を選べるように変更
malken21 Oct 13, 2026
66d8eab
書き直す前の Fabric 専用の実装 (src フォルダ) を削除
malken21 Oct 13, 2026
ace5d35
影 Mod が光の計算に使えるように、3D モデルの面の向きを指定 (1.7.10 - 1.14.4)
malken21 Oct 13, 2026
d4382c2
影 Mod 入りの確認に LiteLoader と OptiFine の組み合わせを追加し、README に確認方法と FFmpeg で表…
malken21 Oct 13, 2026
e45cef7
同梱のリソースパックの対応バージョンの書き方を修正し、Minecraft 1.21.9 以降で Fabric API があると出る読み込み…
malken21 Oct 13, 2026
5df4149
影 Mod 入りの確認で、LiteLoader と OptiFine を一緒に読み込むときの入口を修正
malken21 Oct 13, 2026
ed04ab4
実機での確認で、Minecraft 1.14 への接続を待たせる中継と、Forge 1.14.2 / 1.14.3 のインストールの回避策を追加
malken21 Oct 13, 2026
d62304e
Minecraft 1.15 / 1.15.1 と 1.19.3 で落ちる問題を修正し、対応する全バージョンとのつながりを起動せずに確かめ…
malken21 Oct 13, 2026
7ca6028
動作確認で、タイトル画面が出てから Mod 自身がサーバーへ接続する方式を追加 (起動と同時の接続では入れない 1.14 - 1.15.1…
malken21 Oct 13, 2026
fa315e5
Forge 1.19.3 で看板の絵が描かれないことがある問題を修正 (視線の向きを軸からずらす量を増やした)
malken21 Oct 13, 2026
a5eebfc
動作確認で、Minecraft 1.17 でも起動が済んでから接続するように変更し、確認済みかどうかを組み合わせごとの内容で判定するように変更
malken21 Oct 14, 2026
8de372a
確認ツール: 途中で終わった起動を基準に残さない、基準の取得を 1 回やり直す、ログの比較でスレッド名や行の長さの違いを無視するように変更
malken21 Oct 14, 2026
a761f05
影 Mod (Iris / Oculus) を使っているとき、画面を閉じた直後などに OpenGL のエラーが出る問題を修正 (テクスチャ…
malken21 Oct 14, 2026
28a9145
全バージョンの実機動作確認結果ドキュメントを追加し、確認ツールの基準取得失敗時の対象外処理や例外処理を改善
malken21 Oct 15, 2026
ae38062
確認ツール: 画面を撮る前に、ウィンドウが前面に出るのを待つ処理を戻した
malken21 Oct 15, 2026
38949dd
CI を追加し、main に入ったとき mod_version のタグがなければ自動でリリースするようにした (FFmpeg が jar …
malken21 Oct 15, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/scripts/check-no-ffmpeg.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
#!/usr/bin/env bash
# 配布する jar / litemod に FFmpeg の実行ファイルが入っていないことを確かめる
set -euo pipefail

dir="${1:?usage: check-no-ffmpeg.sh <directory>}"
status=0
found=0

for archive in "$dir"/*.jar "$dir"/*.litemod; do
[ -e "$archive" ] || continue
found=1
# クラスファイル (Ffmpeg.class) は実行ファイルではないので除く。
# jar の中の jar (Fabric 用) も調べる
if unzip -Z1 "$archive" | grep -Ei '(^|/)(ffmpeg|ffprobe)(\.exe)?$|\.(exe|dll|so|dylib)$'; then
echo "::error::$archive に実行ファイルが入っています"
status=1
fi
nested="$(mktemp -d)"
unzip -q -o "$archive" 'META-INF/jars/*.jar' -d "$nested" 2>/dev/null || true
for inner in "$nested"/META-INF/jars/*.jar; do
[ -e "$inner" ] || continue
if unzip -Z1 "$inner" | grep -Ei '(^|/)(ffmpeg|ffprobe)(\.exe)?$|\.(exe|dll|so|dylib)$'; then
echo "::error::$archive の中の $(basename "$inner") に実行ファイルが入っています"
status=1
fi
done
rm -rf "$nested"
done

if [ "$found" -eq 0 ]; then
echo "::error::$dir に jar も litemod もありません"
exit 1
fi
exit "$status"
50 changes: 50 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: CI

on:
pull_request:
push:
branches-ignore:
- main

permissions:
contents: read

concurrency:
group: ci-${{ github.ref }}
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Set up JDK 25
uses: actions/setup-java@v4
with:
java-version: '25'
distribution: 'temurin'

- name: Setup Gradle
uses: gradle/actions/setup-gradle@v4

- name: Make gradle wrapper executable
run: chmod +x gradlew

# 対応するすべてのバージョンの Minecraft を取得するため、時間がかかる
- name: Build with Gradle
run: ./gradlew :dist:assemble

# FFmpeg は jar に入れない (利用者が自分で用意する)
- name: Check that FFmpeg is not bundled
run: bash .github/scripts/check-no-ffmpeg.sh dist/build/libs

- name: Upload build output
uses: actions/upload-artifact@v4
with:
name: MarumaSign
path: |
dist/build/libs/*.jar
dist/build/libs/*.litemod
if-no-files-found: error
55 changes: 44 additions & 11 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,48 +1,81 @@
name: Release Mod

# main に入った時点で、gradle.properties の mod_version と同じ名前のタグ (v4.0.0 など) がまだなければ、
# ビルドして GitHub Release を作る。バージョンを上げずに main へ入れた場合は何もしない。
on:
push:
tags:
- 'v*'
- '[0-9]+.[0-9]+.[0-9]+*'
branches:
- main
workflow_dispatch:

permissions:
contents: write

concurrency:
group: release
cancel-in-progress: false

jobs:
build-and-release:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Read version from gradle.properties
id: version
shell: bash
run: |
VERSION=$(grep -E '^mod_version' gradle.properties | cut -d'=' -f2 | tr -d '[:space:]')
if [ -z "$VERSION" ]; then
echo "::error::gradle.properties に mod_version がありません"
exit 1
fi
echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
if git ls-remote --exit-code --tags origin "refs/tags/v${VERSION}" >/dev/null 2>&1; then
echo "Tag v${VERSION} already exists. Skipping release."
echo "release=false" >> "$GITHUB_OUTPUT"
else
echo "release=true" >> "$GITHUB_OUTPUT"
fi

- name: Set up JDK 25
if: steps.version.outputs.release == 'true'
uses: actions/setup-java@v4
with:
java-version: '25'
distribution: 'temurin'

- name: Setup Gradle
if: steps.version.outputs.release == 'true'
uses: gradle/actions/setup-gradle@v4

- name: Make gradle wrapper executable
if: steps.version.outputs.release == 'true'
run: chmod +x gradlew

# 対応するすべてのバージョンの Minecraft を取得するため、時間がかかる
- name: Build with Gradle
run: ./gradlew build
if: steps.version.outputs.release == 'true'
run: ./gradlew :dist:assemble

- name: Get version from gradle.properties
id: get_version
run: |
VERSION=$(grep "mod_version" gradle.properties | cut -d'=' -f2 | tr -d '[:space:]')
echo "version=${VERSION}" >> $GITHUB_OUTPUT
shell: bash
# FFmpeg は jar に入れない (利用者が自分で用意する)
- name: Check that FFmpeg is not bundled
if: steps.version.outputs.release == 'true'
run: bash .github/scripts/check-no-ffmpeg.sh dist/build/libs

- name: Create GitHub Release
if: steps.version.outputs.release == 'true'
uses: softprops/action-gh-release@v2
with:
tag_name: v${{ steps.version.outputs.version }}
target_commitish: ${{ github.sha }}
name: MarumaSign ${{ steps.version.outputs.version }}
generate_release_notes: true
files: |
build/libs/marumasa_sign-${{ steps.get_version.outputs.version }}.jar
dist/build/libs/*.jar
dist/build/libs/*.litemod
fail_on_unmatched_files: true
draft: false
prerelease: false
env:
Expand Down
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -121,3 +121,7 @@ run/

# Decompiled Minecraft/mapping sources (generated locally by Loom, not project source)
decompiled/

# Generated per-target Gradle project directories
/targets/

178 changes: 162 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,187 @@
# MarumaSign

看板に画像を表示する Minecraft の Mod です。
看板に画像・動画・音声・3D モデルを表示する Minecraft の Mod です。

https://www.curseforge.com/minecraft/mc-mods/marumasign

解説動画:
<https://www.youtube.com/watch?v=N-Q-Vtz7m-0>

サーバーに、このModを導入する必要はありません。すべてクライアント側で動作します。
バニラのサーバーでも、サバイバルモードでも使えます。

## ダウンロードするファイル

使っているローダーに合わせて、次のどちらかを `mods` フォルダに入れてください。

| ローダー | ファイル | 備考 |
| --- | --- | --- |
| Fabric / Forge / NeoForge | `MarumaSign-<バージョン>.jar` | Minecraft のどのバージョンでも同じファイルです |
| LiteLoader | `MarumaSign-<バージョン>-liteloader-mc<Minecraft のバージョン>.litemod` | Minecraft のバージョンに合ったものを選んでください |

LiteLoader だけファイルが分かれているのは、LiteLoader が Mod ごとに対応する Minecraft のバージョンを 1 つしか指定できないためです。

## 前提環境

各ローダー本体だけで動作します。Fabric API などの前提 Mod は必要ありません。

対応している Minecraft のバージョンとローダーの組み合わせ、および実機での動作確認の結果は
[docs/verification.md](docs/verification.md) を参照してください。

## 使用方法

1. ゲーム中、B キー を押します。( "キーの割り当て" で Bキー以外に変更できます)
2. 起動したブラウザから画像のアドレスや画像の大きさなどを設定します。
3. "giveコマンド実行" ボタンを押すことで、Minecraftで MarumaSign の看板の give コマンドが実行されます。
4. 看板を設置して完了です。
1. ゲーム中、B キー を押します。( "キーの割り当て" の「その他」にある "MarumaSign" で変更できます)
2. 開いたウィンドウで、ファイルを選ぶか、URL を入力します。
- 「参照...」ボタンでファイルを選べます。
- Minecraft 1.14 以降では、ウィンドウにファイルをドロップすることもできます。
3. 大きさ・位置・回転を設定して、「看板に書き込む」ボタンを押します。
4. 看板を設置します。設置した看板に、表示するための文字が自動で書き込まれます。

### 対応している拡張子
ファイルを選んだ場合、ファイルは [Catbox](https://catbox.moe/) にアップロードされ、誰でもアクセスできる URL になります。
公開したくないファイルは選ばないでください。

### 対応している形式

ファイルの種類は、拡張子ではなく内容で判別します。

#### 画像

- `.png` (アニメーション PNG を含む)
- `.gif`
- `.png`
- `.jpg`
- `.jpeg`
- `.jpg` / `.jpeg`
- `.bmp`

#### 動画・音声

[FFmpeg](https://ffmpeg.org/) が読める形式 (`.mp4` `.webm` `.mkv` `.mov` `.avi` `.mp3` `.ogg` `.wav` `.flac` など) を再生できます。
動画に含まれる音声も再生され、看板から離れるほど小さく聞こえます。音量はウィンドウの「動画と音声の音量」で変えられます。
WebP や AVIF、TIFF など、上の「画像」にない形式の画像も、FFmpeg を通して表示します。

再生には FFmpeg が必要です。次のどちらかの方法で用意してください。

- FFmpeg をインストールして、`ffmpeg` と `ffprobe` をコマンドとして実行できる状態 (PATH が通った状態) にする
- ゲームフォルダ (`.minecraft` など) の中に `marumasign/ffmpeg` フォルダを作り、`ffmpeg` と `ffprobe` の実行ファイルを置く

FFmpeg が見つからない場合は、動画や音声の看板を見たときにチャットで知らせます。

#### 3D モデル

glTF 2.0 の `.glb` と `.gltf` を表示できます。
`.gltf` が別のファイル (`.bin` や画像) を参照している場合、アップロードのときに自動で 1 つの `.glb` にまとめます。

モデルは、最も長い辺が画像の長い辺と同じ大きさになるように置かれ、正面 (+Z) が看板の正面を向きます。
壁掛けの看板では、モデルの背面が壁に付きます。

対応している内容:

- ノードの階層、メッシュ (三角形、帯、扇)、疎なアクセサ、整数に量子化された頂点
- アニメーション (移動・回転・拡大・モーフィングの重み、補間は LINEAR / STEP / CUBICSPLINE)。最初のアニメーションを繰り返し再生します
- スキニング (1 頂点につきボーン 8 本まで) とモーフターゲット
- 材質: 色とテクスチャ、頂点の色、金属らしさと粗さ、法線マップ、遮蔽 (オクルージョン)、発光、透明度の扱い (OPAQUE / MASK / BLEND)、両面表示
- テクスチャ: PNG / JPEG、複数のテクスチャ座標、繰り返しの指定 (繰り返し・折り返し・端で止める)
- 拡張: `KHR_materials_unlit` `KHR_materials_emissive_strength` `KHR_texture_transform` `KHR_mesh_quantization` `KHR_materials_pbrSpecularGlossiness`

陰影について:

どのバージョンの Minecraft でも同じ見た目になるように、材質の計算 (シェーダーに相当する処理) は Mod の中で行っています。
照明はモデルに固定で、上面が最も明るく、側面、底面の順に暗くなります。
動かないモデルで、法線マップや金属らしさ・粗さ・発光のテクスチャを使っている材質は、読み込みのときにピクセル単位で計算した結果をテクスチャに焼き込みます。
アニメーションするモデルと、テクスチャの同じ場所を向きの違う多くの面で使い回しているモデルは、頂点単位の計算になり、これらのテクスチャの細かい模様は反映されません。

制限:

- 三角形は 15 万枚まで、ファイルは外部ファイルを含めて 64 MB まで
- Draco と meshopt で圧縮されたモデルは読み込めません
- KTX2 (Basis) と WebP のテクスチャは読み込めず、その材質は色だけで表示されます
- 透過 (transmission) やクリアコートなど、上に挙げていない拡張の材質は、基本の材質として表示されます
- 光源とカメラの定義は使いません

### 看板のフォーマット

`[URL]|[X軸位置]|[Y軸位置]|[Z軸位置]|[高さ]|[横幅]|[X軸回転]|[Y軸回転]|[Z軸回転]`
`[URL]|[X軸位置]|[Y軸位置]|[Z軸位置]|[横幅]|[高さ]|[Z軸回転]|[Y軸回転]|[X軸回転]`

## 注意事項
看板の 4 行 (Minecraft 1.20 以降は表と裏の合計 8 行) をつなげた文字列が、この形式になっていると表示されます。
動画・音声・3D モデルでも同じ形式です。

- URLの長さが`https://` の部分を含めて44文字以上だと看板にURLが入り切らないため動作しません。
### 看板のアイテム

## 前提環境
看板の文字をデータとして持っている看板のアイテム (クリエイティブモードで Ctrl を押しながらブロックを選択したときや、
`/give` でデータ付きの看板を渡されたときなど) は、アイテムの見た目も、その看板と同じ画像・動画・3D モデルになります。
インベントリの枠、手に持ったとき、地面に落ちているとき、額縁に入れたときのどれでも同じです。
アイテムとしての見た目では、看板に書かれた位置・大きさ・回転は使わず、アイテムの大きさに収まるように表示します。

### 影 Mod (シェーダー) との併用

OptiFine、Iris、Oculus などの影 Mod とシェーダーパックを使っていても表示されます。
絵や 3D モデルは、ブロックと同じようにシェーダーの光と影を受けます。
そのため、色の見え方はシェーダーパックによって変わります (日なたでは明るく、日かげや夜は暗くなります)。
確認した影 Mod とシェーダーパックの組み合わせは [docs/verification.md](docs/verification.md) にあります。

## 注意事項

- Minecraft **26.2**
- [Fabric Loader](https://fabricmc.net/use/installer/) 0.19.3 以降
- [Fabric API](https://www.curseforge.com/minecraft/mc-mods/fabric-api) 0.154.2 以降
- 看板に入りきらない長さの URL は、自動で短縮されます。
- Minecraft 1.7.10 のサーバーは看板 1 行につき 15 文字までしか受け付けないため、特に URL が短縮されやすくなります。
- スペクテイターモードでは、画像と一緒に看板そのものも表示されます。
- 画像は 10 MB まで、アップロードできる動画・音声は 200 MB までです。

## 開発者向け

### 構成

| フォルダ | 内容 |
| --- | --- |
| `core` | Minecraft に依存しない共通の処理 (看板のフォーマット、画像の取得、ゲーム内のウィンドウなど) |
| `adapters` | Minecraft のバージョンごとの実装。共通部分と、世代ごとの差分に分かれています |
| `bootstrap` | 各ローダーから呼ばれ、実行中のバージョンに合った実装を選ぶ入口 |
| `dist` | 配布するファイルの組み立て |
| `tools` | 対応表の生成と、実機での動作確認を自動で行うスクリプト |

対応するバージョンの一覧は `targets.json` にあり、`tools/gen_targets.py` から生成します。
Minecraft 1.14 以降向けの実装のうち、バージョンによって細部が違うファイルは `tools/gen_adapters.py` から生成します
(生成したファイルもリポジトリに入っているので、ビルドには必要ありません)。

### ビルド

```bash
./gradlew :dist:assemble
```

配布するファイルは `dist/build/libs` に出力されます。
初回は対応するすべてのバージョンの Minecraft を取得するため、時間がかかります。

### 動作確認

```bash
python tools/verify/matrix.py
```

バニラのサーバーを起動し、各ローダーを入れた実際のクライアントで接続して、
画像・3D モデル・動画を看板に書き込んで表示するまでと、看板の文字を持たせた看板アイテムの見た目を自動で確認します。
[portablemc](https://github.com/mindstorm38/portablemc)、Pillow、FFmpeg が必要です。

```bash
# 影 Mod とシェーダーパックを入れた状態で確認する
python tools/verify/matrix.py --shaders
# シェーダーパックを変える (Modrinth での名前)。Forge 1.16.5 以降で OptiFine を使うときは --shader-mod optifine
python tools/verify/matrix.py --shaders --shader-pack complementary-reimagined
# 結果を docs/verification.md にまとめる
python tools/verify/report.py
```

Minecraft を起動せずに確認できるものもあります。

```bash
# 配布する jar が、対応しているすべてのバージョンの Minecraft と正しくつながるかを確かめる
# (1 つのビルドを近いバージョンでも使っているため、バージョン間の細かな違いをここで見つける)
python tools/check_linkage.py
```

```bash
# ゲーム内のウィンドウの見た目を PNG に書き出す
./gradlew :core:uiPreview
# 3D モデルを PNG に描く (出力先, アニメーションの時刻, モデルのファイル...)
./gradlew :core:gltfCheck -PgltfArgs="build/gltf 0.5 model.glb"
```

## 貢献者

Expand Down
Loading
Loading