Skip to content

Commit db4d67f

Browse files
committed
Add GitHub Releases distribution workflow for sample project
- Set Installed: false in TransitionFX.uplugin (project-local plugin, not an engine-installed plugin) - Remove Android leftover block and duplicate DefaultGraphicsRHI line from DefaultEngine.ini - Add .github/workflows/release.yml: triggers on v* tags, creates a clean zip (LFS-aware via actions/checkout lfs:true, excludes Binaries/Intermediate/Saved etc.), uploads to GitHub Release with CHANGELOG notes - Add Sample Project download section to README.md and README.ja.md https://claude.ai/code/session_01AhXf5f3aGJ3Ni4w8ptDzGa
1 parent 3273960 commit db4d67f

5 files changed

Lines changed: 88 additions & 16 deletions

File tree

.github/workflows/release.yml

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Release Sample Project
2+
3+
on:
4+
push:
5+
tags:
6+
- 'v*'
7+
8+
jobs:
9+
create-release:
10+
runs-on: ubuntu-latest
11+
permissions:
12+
contents: write
13+
14+
steps:
15+
- name: Checkout with LFS
16+
uses: actions/checkout@v4
17+
with:
18+
lfs: true
19+
fetch-depth: 0
20+
21+
- name: Create distribution zip
22+
run: |
23+
TAG_NAME="${GITHUB_REF_NAME}"
24+
ZIP_NAME="TransitionFX_SampleProject_${TAG_NAME}.zip"
25+
26+
rsync -a \
27+
--exclude='.git' \
28+
--exclude='.github' \
29+
--exclude='Binaries/' \
30+
--exclude='Intermediate/' \
31+
--exclude='Saved/' \
32+
--exclude='DerivedDataCache/' \
33+
--exclude='Build/' \
34+
--exclude='Plugins/*/Binaries/' \
35+
--exclude='Plugins/*/Intermediate/' \
36+
--exclude='.vs/' \
37+
--exclude='*.sln' \
38+
--exclude='CONTRIBUTING.md' \
39+
. /tmp/TransitionFX_SampleProject/
40+
41+
cd /tmp
42+
zip -r "${ZIP_NAME}" TransitionFX_SampleProject/
43+
mv "${ZIP_NAME}" "${GITHUB_WORKSPACE}/"
44+
echo "ZIP_NAME=${ZIP_NAME}" >> $GITHUB_ENV
45+
46+
- name: Extract changelog notes
47+
run: |
48+
VERSION="${GITHUB_REF_NAME#v}"
49+
awk "/^## \[${VERSION}\]/{found=1; next} found && /^## /{exit} found{print}" CHANGELOG.md > release_notes.txt
50+
51+
- name: Create GitHub Release
52+
env:
53+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
54+
run: |
55+
gh release create "${GITHUB_REF_NAME}" \
56+
"${ZIP_NAME}" \
57+
--title "TransitionFX ${GITHUB_REF_NAME}" \
58+
--notes-file release_notes.txt

Config/DefaultEngine.ini

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ r.DefaultFeature.LocalExposure.ShadowContrastScale=0.8
2727

2828
[/Script/WindowsTargetPlatform.WindowsTargetSettings]
2929
DefaultGraphicsRHI=DefaultGraphicsRHI_DX12
30-
DefaultGraphicsRHI=DefaultGraphicsRHI_DX12
3130
-D3D12TargetedShaderFormats=PCD3D_SM5
3231
+D3D12TargetedShaderFormats=PCD3D_SM6
3332
-D3D11TargetedShaderFormats=PCD3D_SM5
@@ -73,17 +72,3 @@ FontDPI=72
7372
+ActiveGameNameRedirects=(OldGameName="TP_Blank",NewGameName="/Script/TransitionFX_Dev")
7473
+ActiveGameNameRedirects=(OldGameName="/Script/TP_Blank",NewGameName="/Script/TransitionFX_Dev")
7574

76-
[/Script/AndroidFileServerEditor.AndroidFileServerRuntimeSettings]
77-
bEnablePlugin=True
78-
bAllowNetworkConnection=True
79-
SecurityToken=42EB5DFC41F5AE1CD9B736A7F62B13A9
80-
bIncludeInShipping=False
81-
bAllowExternalStartInShipping=False
82-
bCompileAFSProject=False
83-
bUseCompression=False
84-
bLogFiles=False
85-
bReportStats=False
86-
ConnectionType=USBOnly
87-
bUseManualIPAddress=False
88-
ManualIPAddress=
89-

Plugins/TransitionFX/TransitionFX.uplugin

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"CanContainContent": true,
1616
"IsBetaVersion": false,
1717
"IsExperimentalVersion": false,
18-
"Installed": true,
18+
"Installed": false,
1919
"Modules": [
2020
{
2121
"Name": "TransitionFX",

README.ja.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,20 @@ TransitionFXでは一部のブループリントに **Latent Action** を採用
5252
* **レンダリング:** PostProcess 対応のレンダリングパイプライン(Deferred または PostProcess 有効の Forward)が必要です。
5353
* **プラットフォーム:** Windows)。コンソールおよびモバイルプラットフォームは公式にはテストされていません。SDF ベースのエフェクトは GPU 負荷が中心のため、低スペック環境でのパフォーマンスは変動する可能性があります。
5454

55+
## サンプルプロジェクト
56+
57+
全22種以上のトランジションエフェクトを確認できるサンプルプロジェクトを [Releases ページ](https://github.com/EmbarrassingMoment/TransitionFX_Dev/releases) から入手できます。
58+
59+
**動作環境:** Unreal Engine 5.5、Windows、DX12 SM6、Visual Studio 2022(C++ によるゲーム開発ワークロード)
60+
61+
1. Releases ページから `TransitionFX_SampleProject_vX.X.X.zip` をダウンロードします。
62+
2. zip を任意のフォルダに展開します(スペースや非 ASCII 文字を含むパスは避けてください)。
63+
3. `TransitionFX_Dev.uproject` を右クリックし、**「Visual Studio プロジェクトファイルを生成」** を選択します。
64+
4. `TransitionFX_Dev.uproject` を開きます。モジュールの再ビルドを促すダイアログが表示されたら **Yes** をクリックしてください。
65+
5. エディタが起動したら `L_ShowCase` レベルで **Play** を押すと、全エフェクトをインタラクティブに確認できます。
66+
67+
> **注意:** 初回起動時はシェーダーコンパイルに数分かかる場合があります。
68+
5569
## Installation
5670
1. リリースページからプラグインをダウンロードします。
5771
2. `TransitionFX`フォルダをプロジェクトの`Plugins`ディレクトリに配置します。

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,21 @@ The manager runs as a **GameInstance Subsystem**, persisting state across level
4040
* **Rendering:** Requires a PostProcess-capable rendering pipeline (Deferred or Forward with PostProcess enabled).
4141
* **Platforms:** Windows (DX12 SM6). Console and mobile platforms have not been officially tested — SDF-based effects are GPU-bound, so performance on low-end devices may vary.
4242

43+
## Sample Project
44+
45+
A ready-to-use sample project is available on the [Releases page](https://github.com/EmbarrassingMoment/TransitionFX_Dev/releases).
46+
It includes the full plugin source and a showcase level demonstrating all 22+ transition effects.
47+
48+
**Requirements:** Unreal Engine 5.5, Windows, DirectX 12 / SM6, Visual Studio 2022 (Game Development with C++ workload)
49+
50+
1. Download `TransitionFX_SampleProject_vX.X.X.zip` from the Releases page.
51+
2. Extract the zip to a folder (avoid paths with spaces or non-ASCII characters).
52+
3. Right-click `TransitionFX_Dev.uproject` and select **"Generate Visual Studio project files"**.
53+
4. Open `TransitionFX_Dev.uproject`. When prompted to rebuild missing modules, click **Yes**.
54+
5. Once the editor opens, press **Play** in the `L_ShowCase` level to explore all effects.
55+
56+
> **Note:** The first launch will compile shaders, which may take several minutes.
57+
4358
## Installation
4459
1. Download the plugin from the release page.
4560
2. Place the `TransitionFX` folder into your project's `Plugins` directory.

0 commit comments

Comments
 (0)