Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

9 Commits

Folders and files

Repository files navigation

krkrz_linux — 吉里吉里Z Linux 版

日本語 | English

吉里吉里Z (krkrz) 本体とタイトルのデータをまとめて、Linux 向けの配布物を作るための外枠リポジトリです。 ビルドは Valve の Steam Linux Runtime 3.0 "sniper" SDK のコンテナで行います。

  • エンジン本体とプラグインのソースは krkrz_dev を KRKRZ_BASE 経由で参照します。このリポジトリには Linux 固有のビルドとパッケージングだけを置きます (krkrz_android / krkrz_web / krkrz_ios と同じ構成です)
  • タイトルごとの設定 (linux-config.json) と資材は別のフォルダ (プロジェクトフォルダ) に置けます。 このリポジトリだけでも、同梱のサンプル (krkrz_dev のコアデモ) としてビルドできます
  • cmake (プラグイン構成) と assetPack (資材の取り込み) は krkrz_android / krkrz_ios / krkrz_gdk / krkrz_web と共通の書式です
  • sniper SDK は Debian 11 / glibc 2.31 です。SteamOS・Steam Linux Runtime・glibc 2.31 以降の一般的な ディストリビューションで動くバイナリになります (krkrz_dev の src/core/doc/LinuxBuild.md が基準)
  • 出力は「そのまま動くフォルダ」と、それを固めた tar.gz です。Steam のデポ、itch.io、GOG などは このフォルダをそのまま使えます

配布形式の考え方・RPATH・セーブデータの場所・Steam Deck での確認手順などの解説は、krkrz_dev の ドキュメント Linux 版の配布パッケージ にあります (ソースは krkrz_dev の doc/topics/core/linux_package.md)。

必要なもの

要件 備考
docker ユーザー権限で使えること
sniper ビルドイメージ steamdev の bash deckbuild/deckbuild.sh image で作る deckbuild-sniper (別の名前のイメージを使うときは環境変数 KRKRZ_LINUX_IMAGE)
KRKRZ_BASE krkrz_dev を置いた親フォルダ (krkrz_android と同じ規約)。サブモジュールまで初期化済みのこと
python3 標準ライブラリだけで動きます (コンテナ内の python 3.9 でも動きます)
GNU Make Makefile を使う場合。python3 tools/krkrz_linux.py <コマンド> を直接呼んでも同じです

セットアップ

  1. krkrz_dev とこのリポジトリを同じフォルダに clone します

    <KRKRZ_BASE>/
    ├── krkrz_dev/        ← git clone --recursive https://github.com/wamsoft/krkrz_dev.git
    └── krkrz_linux/      ← このリポジトリ
    
  2. 環境変数 KRKRZ_BASE にその親フォルダを設定します

  3. steamdev の bash deckbuild/deckbuild.sh image で sniper ビルドイメージ (deckbuild-sniper) を作ります

ビルドと実行

export KRKRZ_BASE=~/kirikiri           # ~/kirikiri/krkrz_dev がある場所

# サンプル (krkrz_dev のコアデモ) をパッケージ化
make all
# → build/linux/package/krkrz-sample/            そのまま動くフォルダ
#   build/linux/dist/krkrz-sample-1.0.0-linux-x86_64.tar.gz

./build/linux/package/krkrz-sample/krkrz-sample   # 引数なしで data/ を自動検出して起動

PROJECT_DIR=/path/to/mygame make -C /path/to/krkrz_linux all   # 自分のプロジェクトフォルダ
やること コマンド
ビルド + 組み立て + tar.gz 化 make all
個別の手順 (configure/build/install、パッケージフォルダの組み立て、tar.gz 化) make build / make stage / make package
片付け (ビルドツリーの docker volume も消します) make clean
コンテナを使わず手元のツールチェインでビルド (VCPKG_ROOT が必要) make native

make native で作ったものは手元の glibc に依存したバイナリになるので、動作確認用に限ってください。

プロジェクトフォルダ (PROJECT_DIR)

krkrz_android と同じく、このリポジトリは共通のビルドシステムで、ビルドするタイトルの設定と資材は 別のフォルダに置けます。

変数 意味
BUILD_SYSTEM_DIR このリポジトリ (固定)
PROJECT_DIR プロジェクトフォルダ。${PROJECT_DIR}/linux-config.json を読み、${PROJECT_DIR}/build/linux/ に出力します。未設定ならこのリポジトリ自身 (サンプル)
KRKRZ_BASE krkrz_dev の親フォルダ

linux-config.json の ${...} と相対パスは PROJECT_DIR 基準です。

linux-config.json

リポジトリ直下のファイルがサンプル兼ひな形です。

キー 意味
name / version 表示名 / 版 (tar.gz の名前に入ります)
exeName 実行ファイル名 (krkrz の KRKRZ_EXE_NAME)。<exeName>.cf もこの名前です
orgName / appName セーブデータの場所 を決める組織名 / アプリ名。<exeName>.cf に orgname / appname として書かれます (セーブデータの場所)
arch x64 (既定) / arm64 (arm64)
cmake.buildType Release (既定) / Debug
cmake.options 追加の CMake 変数 ({"MASTER": "ON"} など)
cmake.pluginFolders / plugins / staticPlugins プラグインの検索フォルダ / ビルドするプラグイン (フォルダ名) / 静的リンクするもの (外枠共通の書式)
config.options <exeName>.cf に書く追加オプション (先頭の - を除いた名前)
desktop freedesktop の .desktop とアイコン (id / comment / categories / icon)
assetPack 資材の取り込み (外枠共通の書式。mirror / flatten、include / exclude、先勝ち)
package.formats dir / tar (AppImage などは未実装)

cmake / assetPack / パスの ${...} 展開の書式は、公開サイトの 外枠リポジトリの共通設定 を参照してください。

パッケージの中身

krkrz-sample/
  krkrz-sample              実行ファイル (RPATH = $ORIGIN)
  libSDL3.so.0, libSDL3.so.0.x.y
  plugin/*.so               プラグイン (RPATH = $ORIGIN:$ORIGIN/..)
  krkrz-sample.cf           orgname / appname ほか
  <desktop id>.desktop, <desktop id>.svg
  license.txt, licenses/
  data/ または data.xp3     引数なしで起動すると自動検出される
  • 同梱の SDL3 やプラグインの依存 .so は RPATH ($ORIGIN, DT_RPATH) で解決されるので、 LD_LIBRARY_PATH や起動スクリプトは不要です。Steam から起動しても同梱版が使われます
  • 先勝ちの順は「エンジン一式 → 生成物 (.cf / .desktop / アイコン) → assetPack」です

セーブデータの場所

Linux 版 krkrz の既定のデータ保存場所は ~/.local/share/<orgname>/<appname>/ ($XDG_DATA_HOME があればその下) です。タイトルごとに orgName / appName を決めると <exeName>.cf に入り、タイトルごとのフォルダになります。実行ファイルの隣には書かないので、 読み取り専用の場所 (AppImage、Flatpak、/opt など) に置いても動きます。

Steam Cloud を使う場合は、Steamworks の Auto-Cloud で Linux のルートを LinuxXdgDataHome (= ~/.local/share)、サブディレクトリを <orgname>/<appname> に してください。

この既定は krkrz_dev 2026-10 の変更です (以前は実行ファイルの隣の savedata)。 旧既定のセーブが実行ファイルの隣に残っていると、起動ログに移行を促す警告が出ます。

xp3 アーカイブ

xp3 アーカイブは krkrz_android と同じく タイトル側で事前に作って取り込みます (このリポジトリでは作りません)。作った *.xp3 を archive/ に置けば、サンプルの assetPack の flatten エントリでパッケージ直下に入ります (data.xp3 は自動検出されます)。 暗号化などを含むタイトル独自のツールがあればそれを使います。暗号化なしの通常の xp3 は、 krkrz_dev の標準ツール krkrxp3 (src/tools/krkrz_tools。Linux でもビルドできます) で作れます。

Steam Deck で確かめる

出力フォルダは steamdev でそのまま Deck に送れます。

steamdev -d <deck> deploy --gameid krkrz_sample \
    --dir build/linux/package/krkrz-sample --command "./krkrz-sample" --start

gameid は英数字・_・. だけです (ハイフン不可)。2026-10-06 にサンプルで Steam Deck (SteamOS 3.8.16、ネイティブ実行) の動作を確認済みです (-demotest で全 24 シーン ok、同梱 SDL3 が読まれ、保存場所は /home/deck/.local/share/wamsoft/krkrz-sample/)。

arm64 (携帯機 / hako-os)

Retroid Pocket Mini などで動く hako-os (Debian 13 "trixie" arm64) 向けに、aarch64 のバイナリも作れます。 x86_64 のマシン上で Debian trixie + aarch64 クロスコンパイラのコンテナを使ってビルドします (glibc やシステムのライブラリが実機と同じ版になります)。

準備: steamdev の bash deckbuild/deckbuild.sh -T rpmini image で deckbuild-rpmini イメージを作ります。

export KRKRZ_BASE=~/kirikiri

# サンプル (コアデモ) を arm64 でパッケージ化
make all ARCH=arm64
# → build/linux-arm64/package/krkrz-sample/      そのまま動くフォルダ
#   build/linux-arm64/dist/krkrz-sample-1.0.0-linux-aarch64.tar.gz

# 実機へ送ってアプリとして登録し、起動する
make deploy ARCH=arm64

# 自分のタイトル (linux-config.json に "arch": "arm64" と書いてもよい)
PROJECT_DIR=/path/to/mygame make -C /path/to/krkrz_linux all deploy ARCH=arm64
  • ARCH=arm64 (--arch arm64 / 環境変数 KRKRZ_LINUX_ARCH) は linux-config.json の arch を上書きします。 出力は build/linux-arm64/ で、x64 (build/linux/) と並べて作れます
  • arm64 では CMake に SDL_UNIX_CONSOLE_BUILD=ON と KRKRZ_USE_A11Y=OFF (AccessKit に Linux arm64 の ビルド済みが無いため) を既定で渡します。cmake.options に書けば上書きできます
  • make deploy は package フォルダを root@192.168.7.2:/data/dev/<タイトル>/ へ rsync し、 /data/dev/apps/<タイトル>.app (Name= / Exec= / Args=<data> -fullscreen=yes) を書いて /usr/lib/hako/launch-app <タイトル> で起動します。起動しないときは python3 tools/krkrz_linux.py deploy --arch arm64 --no-run
  • 送り先は linux-config.json の device (host / baseDir / title / args) か、環境変数 KRKRZ_LINUX_DEVICE (例 root@192.168.7.2) / KRKRZ_LINUX_DEVICE_DIR で変えられます。 ssh の鍵などは KRKRZ_LINUX_SSH_OPTS (例 "-i ~/.ssh/hako") で渡します

配布形式の対応状況

形式 状態
フォルダ / tar.gz (Steam デポ・itch.io・GOG) ✅
AppImage 未実装。同じフォルダに AppRun を足して appimagetool で固める予定 (.desktop とアイコンは生成済み)
Flatpak (Flathub) 未定。AppStream メタデータ (metainfo.xml) とマニフェストが要ります

ドキュメント

ドキュメント 内容
Linux 版の配布パッケージ 配布形式の考え方、RPATH、セーブデータの場所、Steam Deck での確認
外枠リポジトリの共通設定 cmake / assetPack / ${...} 展開の書式
krkrz_dev の src/core/doc/LinuxBuild.md Linux ビルドの基準 (sniper SDK)
steamdev sniper ビルドイメージ、Steam Deck への配置

吉里吉里Z 本体のドキュメントは 公開サイト にあります。

ライセンス

このリポジトリ (ビルドスクリプト・ツール・テンプレート) は MIT License です。

ビルド時に参照・取得する以下のものは、それぞれのライセンスに従います。このリポジトリのライセンスは及びません。

  • 吉里吉里Z 本体とプラグイン (krkrz_dev 配下の各 submodule)
  • SDL3 (zlib License) と、vcpkg で取得する依存ライブラリ
  • ビルドに使う Steam Linux Runtime の SDK コンテナ

パッケージには吉里吉里Z のインストール時に書き出される license.txt と licenses/ が入ります。そのほか配布物に必要なライセンスの表記は、使ったエンジン・プラグイン・ライブラリに合わせてタイトル側で同梱してください。

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages