Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 22 additions & 2 deletions .github/workflows/desktop.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,25 @@ env:
BUILD_VERSION: ${{ (startsWith(github.ref, 'refs/tags/v') && github.ref_name) || inputs.version || (github.event_name == 'pull_request' && format('pr-{0}', github.event.number)) || (github.ref == 'refs/heads/main' && format('v0.1.0-preview.main.{0}', github.run_number)) || github.ref_name }}

jobs:
build_tools:
strategy:
fail-fast: false
matrix:
os: [ubuntu-22.04, windows-2022, macos-15]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v5
with:
persist-credentials: false
sparse-checkout-cone-mode: false
sparse-checkout: |
/tools/release.py
/tests/release/
- uses: actions/setup-python@v6
with:
python-version: '3.12'
- name: Check release preflight and source-ZIP provenance without exporting
run: python -m unittest discover -s tests/release -v
gameplay:
strategy:
fail-fast: false
Expand All @@ -38,16 +57,17 @@ jobs:
sparse-checkout-cone-mode: false
sparse-checkout: |
/global.json
/Directory.Build.props
/gameplay/
/tests/gameplay/
/addons/wol_engine/portable/
/addons/wol_engine/platforms/*/portable/
- uses: actions/setup-dotnet@v5
with:
dotnet-version: '10.0.403'
- name: Check gameplay with only the portable core and no Godot backend
run: dotnet run --project tests/gameplay/GameplayContracts.csproj -c Release
player:
needs: gameplay
needs: [gameplay, build_tools]
strategy:
fail-fast: false
matrix:
Expand Down
1 change: 1 addition & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

- Project Vagrant is a C# game consumer of `RakuenSoftware/wol-engine`, whose binary release is vendored at `addons/wol_engine`. Runtime code is C# on Godot 4.7.2 .NET; no GDScript. Reusable engine behaviour belongs in wol-engine with one owner; game rules, content adapters and scenes belong here.
- Extracted game rules belong in `gameplay/Vagrant.Gameplay.csproj`, an ordinary .NET library with no Godot or backend references; it may reference the plain .NET `WolEngine.Core` contracts. Host scenes compose it through .NET-typed boundaries; reusable device and presentation operations belong in wol-engine. Keep Vagrant-specific rules here and remove displaced host calls as each boundary is extracted.
- Retail catalog and installation rules live in the plain gameplay library; its catalog is an embedded .NET resource. Disc I/O and content-pack mechanisms belong to `WolEngine.Core`; Godot executable discovery and media processes belong to the engine backend. Host resource-cache preparation stays in `RetailContent` until its rendering dependencies are extracted.
- Only players with their own US Vagrant Story disc (SLUS-01040) can play. There is one installation: the disc's files, verified against the retail digest and kept byte for byte (`disc/`, with `install.json` recording where each starts on the disc). It is never versioned or converted. The game decodes what it needs from those files at runtime; what is slow to decode may be kept in `cache/`, which can always be made again.
- Every behaviour is implemented exactly once: one decoder per disc format, one handler per script opcode, one owner for each piece of logic. Reuse and move existing code to its owner rather than writing a second copy. Never commit, ship, download or bundle anything from the disc, and never add fallback content that lets the game run without a verified disc.
- This is not a decompilation project. ser-pounce/rood-reverse is reference material for formats and behaviour only: do not copy its code, tooling, data, tables or text. Write independent implementations.
Expand Down
8 changes: 8 additions & 0 deletions Directory.Build.props
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<Project>
<PropertyGroup>
<WolEngineTarget Condition="'$(WolEngineTarget)' == '' and $([MSBuild]::IsOSPlatform('Windows'))">windows-x64</WolEngineTarget>
<WolEngineTarget Condition="'$(WolEngineTarget)' == '' and $([MSBuild]::IsOSPlatform('OSX'))">macos-universal</WolEngineTarget>
<WolEngineTarget Condition="'$(WolEngineTarget)' == ''">linux-x64</WolEngineTarget>
<WolEngineCoreRoot Condition="'$(WolEngineCoreRoot)' == ''">$(MSBuildThisFileDirectory)addons/wol_engine/platforms/$(WolEngineTarget)/portable</WolEngineCoreRoot>
</PropertyGroup>
</Project>
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,12 @@ or port. A separate Unreal Engine 5 backend is not currently supplied. The work
here establishes the gameplay behavior that future engine implementations can
preserve and reuse.

## Acknowledgements

Thanks to [ser-pounce/rood-reverse](https://github.com/ser-pounce/rood-reverse) and
its contributors for documenting Vagrant Story's data structures and file formats.
Their work provides a reference for Project Vagrant's independent implementations.

## Current state

The title presents the publisher and developer logos, opening movie, title screen and menu wheel. New Game enters the prologue and then field play; Continue loads a memory-card save. The retail Sound and Vibration options and the added Settings panel control audio, controller vibration, display and graphics settings.
Expand Down Expand Up @@ -76,7 +82,28 @@ FFmpeg and ffprobe are bundled for first-time disc conversion; player downloads

The wol-engine binaries are already checked into this repository. No private
engine access, submodule initialization, SCons or C++ compiler is needed. Install
Python 3.12+ and .NET SDK 10.0.403, then build a player on its native host:
Python 3.12+ and the pinned .NET SDK **10.0.403**. Release builds use
`global.json`'s SDK resolver; an earlier .NET 10 feature band such as 10.0.301
does not satisfy this pin. The build script reports an incompatible SDK before
it downloads Godot or creates player output.

Building bundled FFmpeg/ffprobe also needs a native C toolchain:

- **Windows:** install [MSYS2](https://www.msys2.org/), open its **MINGW64** terminal
and run `pacman -S --needed make pkgconf diffutils mingw-w64-x86_64-gcc`.
The default location is `C:/msys64`; set `MSYS2_ROOT` to your installation root
if it is elsewhere. Git Bash alone does not supply this toolchain.
- **Linux:** install `build-essential pkg-config diffutils curl` (Debian/Ubuntu
names, or your distribution's equivalents).
- **macOS:** install Xcode Command Line Tools (`xcode-select --install`) and
`pkg-config` (for example with Homebrew). The build uses the native tools to
produce both architectures.

Git clones and GitHub **Download ZIP** source archives are supported. ZIP builds
need no Git installation; `BUILD.json` records their revision and dirty state as
unknown. A Git checkout requires Git on PATH to record its actual provenance.
Missing prerequisites are listed together before export or media compilation.
Then build a player on its native host:

```sh
python tools/release.py linux-x64 --version development
Expand Down
4 changes: 0 additions & 4 deletions Vagrant.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,7 @@
<RootNamespace>Wol.Games.Vagrant</RootNamespace>
<AssemblyName>Vagrant</AssemblyName>
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
<WolEngineTarget Condition="'$(WolEngineTarget)' == '' and $([MSBuild]::IsOSPlatform('Windows'))">windows-x64</WolEngineTarget>
<WolEngineTarget Condition="'$(WolEngineTarget)' == '' and $([MSBuild]::IsOSPlatform('OSX'))">macos-universal</WolEngineTarget>
<WolEngineTarget Condition="'$(WolEngineTarget)' == ''">linux-x64</WolEngineTarget>
<WolEngineSdkRoot>$(MSBuildProjectDirectory)/addons/wol_engine/platforms/$(WolEngineTarget)</WolEngineSdkRoot>
<WolEngineCoreRoot Condition="'$(WolEngineCoreRoot)' == ''">$(MSBuildProjectDirectory)/addons/wol_engine/portable</WolEngineCoreRoot>
<GodotApiConfiguration Condition="'$(Configuration)' == 'Release'">Release</GodotApiConfiguration>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)' == 'Release' or '$(Configuration)' == 'ExportRelease'">
Expand Down
Loading
Loading