every_holiday/VRCT
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'build' into develop

Browse Source
This commit is contained in:
misyaguziya
2025-11-25 21:47:14 +09:00
parent 318928d049 3ce8590ce2
commit 592149afed
16 changed files with 524 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
bat/build.bat Normal file
View File

@@ -0,0 +1,2 @@
call .venv/Scripts/activate
pyinstaller spec/backend.spec --distpath src-tauri/bin --clean --noconfirm --log-level ERROR

2
bat/build_cuda.bat Normal file
View File

@@ -0,0 +1,2 @@
call .venv_cuda/Scripts/activate
pyinstaller spec/backend_cuda.spec --distpath src-tauri/bin --clean --noconfirm --log-level ERROR

0
install.bat → bat/install.bat
View File

2
build.bat
View File

@@ -1,2 +0,0 @@
call .venv/Scripts/activate
pyinstaller backend.spec --distpath src-tauri/bin --clean --noconfirm --log-level ERROR

2
build_cuda.bat
View File

@@ -1,2 +0,0 @@
call .venv_cuda/Scripts/activate
pyinstaller backend_cuda.spec --distpath src-tauri/bin --clean --noconfirm --log-level ERROR

6
clean.py
View File

@@ -1,6 +0,0 @@
import shutil
shutil.rmtree('build', ignore_errors=True)
shutil.rmtree('dist', ignore_errors=True)
shutil.rmtree('src-tauri\\bin', ignore_errors=True)
shutil.rmtree('src-tauri\\target', ignore_errors=True)

422
docs/readme_build.md Normal file
View File

@@ -0,0 +1,422 @@
# VRCTビルドガイド
このドキュメントでは、VRCTプロジェクトのビルド方法について説明します。
## 目次
- [必要な環境](#必要な環境)
- [初回セットアップ](#初回セットアップ)
- [ビルドの種類](#ビルドの種類)
- [開発ビルド](#開発ビルド)
- [リリースビルド](#リリースビルド)
- [ビルドプロセスの詳細](#ビルドプロセスの詳細)
- [トラブルシューティング](#トラブルシューティング)
## 必要な環境
### 必須ソフトウェア
- **Node.js** (npm含む)
- **Python 3.x**
- **Rust** (Tauri用)
- **Git**
### 推奨環境
- Windows 10/11
- メモリ: 8GB以上
- ストレージ: 5GB以上の空き容量
## 初回セットアップ
### 1. リポジトリのクローン
```bash
git clone <repository-url>
cd VRCT
```
### 2. Node.js依存関係のインストール
```bash
npm install
```
### 3. Python環境のセットアップ
以下のコマンドで、CPU版とCUDA版の両方の仮想環境を作成します:
```bash
npm run setup-python
```
このコマンドは以下の処理を実行します:
- `.venv` (CPU版) の作成と依存関係のインストール
- `.venv_cuda` (CUDA版) の作成と依存関係のインストール
> **注意**: CUDA版を使用する場合は、NVIDIAのGPUとCUDA Toolkit 12.8が必要です。
## ビルドの種類
VRCTでは、以下の2種類のビルドが可能です:
### CPU版
標準的なCPUで動作するバージョン。GPUは不要。
### CUDA版
NVIDIA GPUを活用した高速処理版。CUDA対応GPUが必要。
## 開発ビルド
開発中にアプリケーションを実行・テストするためのビルドです。
### CPU版の開発ビルド
```bash
npm run dev
```
このコマンドは以下を実行します:
1. 実行中のプロセスを終了 (`task-kill`)
2. ビルドファイルのクリーンアップ (`clean`)
3. バージョン情報の更新 (`update-version`)
4. Pythonバックエンドのビルド (`build-python`)
5. ViteとTauriの開発サーバー起動
### CUDA版の開発ビルド
```bash
npm run dev-cuda
```
CPU版と同様ですが、CUDA対応のPythonバックエンドをビルドします。
### UIのみの開発
バックエンドのビルドをスキップして、UIのみを開発する場合:
```bash
npm run dev-ui
```
## リリースビルド
配布用のインストーラーを作成するビルドです。
### CPU版のリリースビルド
```bash
npm run build
```
または、ZIP形式でパッケージング:
```bash
npm run release
```
生成されるファイル:
- インストーラー: `src-tauri/target/release/bundle/nsis/`
- ZIPファイル: `VRCT.zip` (releaseコマンド使用時)
### CUDA版のリリースビルド
```bash
npm run build-cuda
```
または、ZIP形式でパッケージング:
```bash
npm run release-cuda
```
生成されるファイル:
- インストーラー: `src-tauri/target/release/bundle/nsis/`
- ZIPファイル: `VRCT_cuda.zip` (release-cudaコマンド使用時)
### 両バージョンの同時ビルド
CPU版とCUDA版の両方をビルドする場合:
```bash
npm run release-all
```
## ビルドプロセスの詳細
### バージョン管理
バージョンは `package.json` で一元管理され、以下のファイルに自動で同期されます:
```bash
npm run update-version
```
更新されるファイル:
- `src-tauri/tauri.conf.json`
- `src-python/config.py`
### どこにバージョンを設定すればReleaseに反映されるか
- **設定箇所**: `package.json` の `version` が唯一のソース・オブ・トゥルース。
- **反映方法**: `npm run update-version`（`build`/`build-cuda`/`release`コマンド内でも自動実行）により、
- `src-tauri/tauri.conf.json` の `version` に同期（Tauri/NSISインストーラーの表示・メタデータに使用）
- `src-python/config.py` の `self._VERSION` に同期（ランタイム表示等に使用）
- **成果物への影響**:
- インストーラー（NSIS）は `tauri.conf.json` の `version` を取り込み、プロダクトバージョンとして反映。
- ZIPパッケージ名はスクリプト既定では固定（`VRCT.zip`/`VRCT_cuda.zip`）。ファイル名にバージョンを含めたい場合は、`package.json` の `release` スクリプトを調整してください。
### Pythonバックエンドのビルド
#### CPU版
```bash
npm run build-python
```
実行内容:
- `.venv` 環境をアクティベート
- PyInstallerで `spec/backend.spec` を使用してビルド
- 出力先: `src-tauri/bin/`
#### CUDA版
```bash
npm run build-python-cuda
```
実行内容:
- `.venv_cuda` 環境をアクティベート
- PyInstallerで `spec/backend_cuda.spec` を使用してビルド
- 出力先: `src-tauri/bin/`
### フロントエンドのビルド
```bash
npm run vite-build
```
Viteを使用してフロントエンド（React）をビルドし、`dist/` ディレクトリに出力します。
### Tauriアプリケーションのビルド
```bash
npm run tauri build
```
Tauriを使用して最終的なデスクトップアプリケーションをビルドします。
## GitHub ActionsでのRelease自動化
Windows用のReleaseをGitHub Actionsで自動生成・公開する例です。`package.json` のバージョンをタグ・リリース名に使い、TauriのNSISインストーラーとZIPを添付します。
### 推奨トリガー
- タグプッシュ（例: `v*`）または手動実行（`workflow_dispatch`）
### サンプルワークフロー（Windows）
```yaml
name: Release (Windows)
on:
workflow_dispatch: {}
push:
tags:
- 'v*'
jobs:
build-release-windows:
runs-on: windows-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: '20'
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Setup Rust
uses: dtolnay/rust-toolchain@stable
- name: Install dependencies
run: |
npm ci
- name: Setup Python envs (.venv/.venv_cuda)
run: |
npm run setup-python
- name: Sync versions from package.json
run: |
npm run update-version
- name: Build (CPU)
run: |
npm run build
- name: Package ZIP (CPU)
run: |
python utils/zip.py --zip_name VRCT.zip
- name: Read version from package.json
id: pkg
shell: pwsh
run: |
$version = (Get-Content package.json | ConvertFrom-Json).version
echo "version=$version" >> $env:GITHUB_OUTPUT
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: VRCT-windows-${{ steps.pkg.outputs.version }}
path: |
src-tauri/target/release/bundle/nsis/**/*
VRCT.zip
- name: Create GitHub Release
uses: softprops/action-gh-release@v2
with:
tag_name: v${{ steps.pkg.outputs.version }}
name: VRCT v${{ steps.pkg.outputs.version }}
files: |
src-tauri/target/release/bundle/nsis/**/*
VRCT.zip
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
### ポイント
- ビルド前に必ず `npm run update-version` を実行して、`tauri.conf.json` と `config.py` にバージョンを同期します。
- アーティファクトのパスは既定構成に合わせています：
- インストーラー: `src-tauri/target/release/bundle/nsis/`
- ZIP: ルート直下の `VRCT.zip`
- CUDA版も同様にビルドする場合は、`npm run build-cuda` と `python utils/zip.py --zip_name VRCT_cuda.zip` を追加して、別アーティファクト名でアップロード・添付してください。
## ユーティリティコマンド
### クリーンアップ
```bash
npm run clean
```
以下のディレクトリを削除します:
- `build/`
- `dist/`
- `src-tauri/bin/`
- `src-tauri/target/`
### プロセスの強制終了
```bash
npm run task-kill
```
VRCTに関連する実行中のプロセスを終了します。
## ディレクトリ構成
```
VRCT/
├── bat/ # バッチスクリプト
│ ├── build.bat # CPU版Pythonビルド
│ ├── build_cuda.bat # CUDA版Pythonビルド
│ └── install.bat # Python環境セットアップ
├── spec/ # PyInstallerスペックファイル
│ ├── backend.spec # CPU版ビルド設定
│ └── backend_cuda.spec # CUDA版ビルド設定
├── src-python/ # Pythonバックエンドソースコード
├── src-tauri/ # Tauriアプリケーション設定
│ ├── bin/ # ビルド済みPythonバイナリ（生成）
│ └── target/ # Tauriビルド出力（生成）
├── src-ui/ # Reactフロントエンドソースコード
├── utils/ # ユーティリティスクリプト
│ ├── clean.py # クリーンアップスクリプト
│ ├── task_kill.py # プロセス終了スクリプト
│ ├── update_version.py # バージョン更新スクリプト
│ └── zip.py # ZIPパッケージング
├── package.json # Node.js設定とバージョン管理
├── requirements.txt # Python依存関係（CPU版）
└── requirements_cuda.txt # Python依存関係（CUDA版）
```
## トラブルシューティング
### Python環境のエラー
仮想環境を再作成してください:
```bash
npm run setup-python
```
### ビルドが失敗する
1. クリーンアップを実行:
```bash
npm run clean
```
2. Node.js依存関係を再インストール:
```bash
npm install
```
3. 再度ビルド:
```bash
npm run build
```
### CUDA版が動作しない
- CUDA Toolkit 12.8がインストールされているか確認
- NVIDIA GPUドライバーが最新か確認
- `requirements_cuda.txt` の依存関係が正しくインストールされているか確認
### プロセスが残っている
```bash
npm run task-kill
```
を実行して、すべてのVRCTプロセスを終了してください。
## 参考情報
### PyInstallerスペックファイル
- `spec/backend.spec` - CPU版の設定
- `spec/backend_cuda.spec` - CUDA版の設定
これらのファイルでは、以下を設定しています:
- エントリーポイント: `src-python/mainloop.py`
- データファイル（フォント、プロンプト、言語ファイル等）のパス
- 依存ライブラリのパス
### バージョン管理フロー
1. `package.json` のバージョンを更新
2. `npm run update-version` を実行
3. 自動的に `tauri.conf.json` と `config.py` が更新される
### リリースパッケージの内容
ZIPファイルには以下が含まれます:
- `VRCT.exe` - メインアプリケーション
- `VRCT-sidecar.exe` - Pythonバックエンド
- `_internal/` - 必要な依存ファイル
## ライセンス
プロジェクトのライセンスについては、`LICENSE` ファイルを参照してください。

29
package.json
View File

@@ -1,27 +1,28 @@
{
"name": "vrct",
"private": true,
"version": "0.0.0",
"version": "3.3.2",
"type": "module",
"scripts": {
"setup-python": "install.bat",
"build-python": "build.bat",
"build-python-cuda": "build_cuda.bat",
"setup-python": "bat\\install.bat",
"build-python": "bat\\build.bat",
"build-python-cuda": "bat\\build_cuda.bat",
"vite": "vite",
"vite-build": "vite build",
"vite-preview": "vite preview",
"tauri": "tauri",
"tauri-dev": "tauri dev",
"task-kill": "python task_kill.py",
"clean": "python clean.py",
"dev": "npm run task-kill && npm run build-python && npm run dev-ui",
"dev-cuda": "npm run task-kill && npm run build-python-cuda && npm run dev-ui",
"dev-ui": "npm-run-all --parallel vite tauri-dev",
"build": "npm run clean && npm run build-python && npm run vite-build && npm run tauri build",
"build-cuda": "npm run clean && npm run build-python-cuda && npm run vite-build && npm run tauri build",
"release": "npm run build && python zip.py --zip_name VRCT.zip",
"release-cuda": "npm run build-cuda && python zip.py --zip_name VRCT_cuda.zip",
"release-all": "npm run release && npm run release-cuda"
"task-kill": "python utils\\task_kill.py",
"clean": "python utils\\clean.py",
"update-version": "python utils\\update_version.py",
"dev": "npm run task-kill && npm run clean && npm run update-version && npm run build-python && npm run dev-ui",
"dev-cuda": "npm run task-kill && npm run clean && npm run update-version && npm run build-python-cuda && npm run dev-ui",
"dev-ui": "npm run task-kill && npm-run-all --parallel vite tauri-dev",
"build": "npm run task-kill && npm run clean && npm run update-version && npm run build-python && npm run vite-build && npm run tauri build",
"build-cuda": "npm run task-kill && npm run clean && npm run update-version && npm run build-python-cuda && npm run vite-build && npm run tauri build",
"release": "npm run update-version && npm run build && python utils\\zip.py --zip_name VRCT.zip",
"release-cuda": "npm run update-version && npm run build-cuda && python utils\\zip.py --zip_name VRCT_cuda.zip",
"release-all": "npm run update-version && npm run release && npm run release-cuda"
},
"dependencies": {
"@babel/standalone": "7.27.0",

16
backend_cuda.spec → spec/backend.spec
View File

@@ -2,17 +2,17 @@
a = Analysis(
['src-python\\mainloop.py'],
['..\\src-python\\mainloop.py'],
pathex=[],
binaries=[],
datas=[
('./src-python/models/overlay/fonts', 'fonts/'),
('./src-python/models/translation/prompt', 'prompt/'),
('./src-python/models/translation/languages', 'languages/'),
('.venv_cuda/Lib/site-packages/zeroconf', 'zeroconf/'),
('.venv_cuda/Lib/site-packages/openvr', 'openvr/'),
('.venv_cuda/Lib/site-packages/faster_whisper', 'faster_whisper/'),
('.venv/Lib/site-packages/hf_xet', 'hf_xet/')
('./../src-python/models/overlay/fonts', 'fonts/'),
('./../src-python/models/translation/prompt', 'prompt/'),
('./../src-python/models/translation/languages', 'languages/'),
('./../.venv/Lib/site-packages/zeroconf', 'zeroconf/'),
('./../.venv/Lib/site-packages/openvr', 'openvr/'),
('./../.venv/Lib/site-packages/faster_whisper', 'faster_whisper/'),
('./../.venv/Lib/site-packages/hf_xet', 'hf_xet/')
],
hiddenimports=[],
hookspath=[],

16
backend.spec → spec/backend_cuda.spec
View File

@@ -2,17 +2,17 @@
a = Analysis(
['src-python\\mainloop.py'],
['..\\src-python\\mainloop.py'],
pathex=[],
binaries=[],
datas=[
('./src-python/models/overlay/fonts', 'fonts/'),
('./src-python/models/translation/prompt', 'prompt/'),
('./src-python/models/translation/languages', 'languages/'),
('.venv/Lib/site-packages/zeroconf', 'zeroconf/'),
('.venv/Lib/site-packages/openvr', 'openvr/'),
('.venv/Lib/site-packages/faster_whisper', 'faster_whisper/'),
('.venv/Lib/site-packages/hf_xet', 'hf_xet/')
('./../src-python/models/overlay/fonts', 'fonts/'),
('./../src-python/models/translation/prompt', 'prompt/'),
('./../src-python/models/translation/languages', 'languages/'),
('./../.venv_cuda/Lib/site-packages/zeroconf', 'zeroconf/'),
('./../.venv_cuda/Lib/site-packages/openvr', 'openvr/'),
('./../.venv_cuda/Lib/site-packages/faster_whisper', 'faster_whisper/'),
('./../.venv/Lib/site-packages/hf_xet', 'hf_xet/')
],
hiddenimports=[],
hookspath=[],

2
src-python/config.py
View File

@@ -757,7 +757,7 @@ class Config:
def init_config(self):
# Read Only
self._VERSION = "3.3.1"
self._VERSION = "3.3.2"
if getattr(sys, 'frozen', False):
self._PATH_LOCAL = os_path.dirname(sys.executable)
else:

13
src-tauri/tauri.conf.json
View File

@@ -1,7 +1,7 @@
{
"$schema": "https://schema.tauri.app/config/2",
"productName": "VRCT",
"version": "3.3.1",
"version": "3.3.2",
"identifier": "com.vrct.app",
"build": {
"beforeDevCommand": "",
@@ -11,7 +11,8 @@
},
"app": {
"enableGTKAppId": false,
"windows": [{
"windows": [
{
"title": "VRCT",
"center": true,
"width": 450,
@@ -21,10 +22,14 @@
"transparent": true,
"decorations": false,
"shadow": false
}],
}
],
"security": {
"csp": null,
"capabilities": ["default", "vrct-capability"]
"capabilities": [
"default",
"vrct-capability"
]
}
},
"bundle": {

8
utils/clean.py Normal file
View File

@@ -0,0 +1,8 @@
import os
import shutil
root = os.path.dirname(os.path.dirname(__file__))
shutil.rmtree(os.path.join(root, 'build'), ignore_errors=True)
shutil.rmtree(os.path.join(root, 'dist'), ignore_errors=True)
shutil.rmtree(os.path.join(root, 'src-tauri', 'bin'), ignore_errors=True)
shutil.rmtree(os.path.join(root, 'src-tauri', 'target'), ignore_errors=True)

0
task_kill.py → utils/task_kill.py
View File

39
utils/update_version.py Normal file
View File

@@ -0,0 +1,39 @@
import os
import json
def update_versions():
root = os.path.join(os.path.dirname(os.path.dirname(__file__)))
# package.jsonからバージョンを読み取る
with open(os.path.join(root, "package.json"), "r", encoding="utf-8") as f:
package_json = json.load(f)
version = package_json["version"]
# tauri.conf.jsonを更新
tauri_conf_path = os.path.join(root, "src-tauri", "tauri.conf.json")
with open(tauri_conf_path, "r", encoding="utf-8") as f:
tauri_conf = json.load(f)
tauri_conf["version"] = version
with open(tauri_conf_path, "w", encoding="utf-8") as f:
json.dump(tauri_conf, f, indent=4, ensure_ascii=False)
# config.pyを更新
config_path = os.path.join(root, "src-python", "config.py")
with open(config_path, "r", encoding="utf-8") as f:
content = f.read()
# VERSION行を置換
import re
pattern = r'(self\._VERSION = ")[^"]+(")'
replacement = rf'\g<1>{version}\g<2>'
new_content = re.sub(pattern, replacement, content)
with open(config_path, "w", encoding="utf-8") as f:
f.write(new_content)
print(f"updated to version {version}")
if __name__ == "__main__":
update_versions()

0
zip.py → utils/zip.py
View File