Skip to content

Add AVP-INSTALL.md (AVP Ports Index) - #5

Open
edgytoast wants to merge 2 commits into
iChris4:vision-profrom
edgytoast:avp-ports-index
Open

edgytoast wants to merge 2 commits into
iChris4:vision-profrom
edgytoast:avp-ports-index

Conversation

@edgytoast

Copy link
Copy Markdown

Hi! I run the AVP Ports Index, a curated, link-only index of game ports that run natively on Apple Vision Pro, and I'd love to list WiiCompiled Vision.

This adds AVP-INSTALL.md, a short Vision Pro install guide. I drafted it with an AI coding assistant from your README and build scripts, then checked it against them. It's the only file the index needs: docs only, nothing else in your repo changes.

Your CONTRIBUTING, carried over from WiiCompiled, asks for PR descriptions written by the submitter rather than generated, so to be upfront: this description was drafted with the same assistant. I've read and stand behind every line of it and of the guide, and the guide's .NET and bundle-identifier steps come from my own build of WiiCompiled Vision, which I've raced on my Vision Pro, so I can answer questions about any of it. I use an assistant for these because the index is a one-person project in a fast-growing niche, and writing every guide by hand would mean most developers never get one. If that's still a no, close it, no hard feelings; you're welcome to add your own AVP-INSTALL.md instead, and the index will pick it up.

  • Your listing is ready to go: Add WiiCompiled Vision (Mario Kart Wii) edgytoast/avp-ports-index#51. Its checks show a failure until this file lands; that's expected. Once this merges, the index re-checks it, runs an automated security review of your source and, if that passes, lists it, credited to you and linked here.
  • The index hosts nothing and you stay in full control. If a listed repo later fails a basic check (the install guide disappearing, say), a bot opens an issue here.
  • Edit anything that's off, or close this if you'd rather not be listed.

Notes from writing it:

  • The listing sets source_ref: vision-pro, so the index follows that branch, and this guide goes at the root of vision-pro. Its steps come from docs/visionos-getting-started.md, docs/visionos-port.md and the visionOS scripts.
  • org.wiicompiled.vision is already registered to a team, so other builders need their own bundle identifier. The scripts don't take one yet, so the guide has them edit MKW_VISIONOS_BUNDLE_ID in visionos/CMakeLists.txt and bundle= in visionos/Make-VisionOS-App.command. You may want to add a --bundle-id option to both scripts, passed through as MKW_VISIONOS_BUNDLE_ID.
  • The translator targets .NET 8 with no roll-forward, and Homebrew's dotnet-sdk cask is now .NET 10, which builds it but can't run it, so the guide installs dotnet-sdk@8. The tutorial and the script's install hints still say dotnet-sdk; <RollForward>Major</RollForward> in Translator.Cli.csproj would also fix it.
  • The entry lists the races as 3D immersive, plus 6DoF immersive for the life-size cockpit; tell me if you'd describe them differently and I'll update it.

Thanks for building this!

Trevor (Trevorbilt)

@iChris4

iChris4 commented Oct 6, 2026

Copy link
Copy Markdown
Owner

Thanks Trevor,

I checked the guide against the scripts, the launcher and the docs on vision-pro, and it's accurate. You also found two real bugs that anyone but me hits when following the tutorial. I'd rather fix those in the scripts than have the guide work around them:

  1. Bundle identifier. You're right: org.wiicompiled.vision is registered to my team, so nobody else can sign with it. I'll add the --bundle-id option you suggested to Make-VisionOS-App.command and Build-VisionOS.sh. It's passed through as MKW_VISIONOS_BUNDLE_ID and also used for the disc copy and the launch.
  2. .NET 8. Also right: with only Homebrew's current dotnet-sdk (10.x), the script's "SDK 8 or newer" check passes, but the translator then can't run. I'll add <RollForward>Major</RollForward> to Translator.Cli.csproj, so any SDK from 8 up works and brew install --cask dotnet-sdk is correct again.

Once that's on vision-pro, could you update the guide?

  • Replace Your own bundle identifier and the git stash line with passing --bundle-id com.yourname.wiicompiled to the script.
  • Go back to brew install --cask dotnet-sdk.

I'll post here when the fixes land, and merge after your update.

On the listing description: every immersive race view tracks head position, not only the cockpit. The chase camera is 6DoF too, at game scale, while the cockpit is the life-size one. I'd describe it as "6DoF immersive stereo races, from the chase camera or a life-size cockpit, with menus on a virtual screen". There are also an Immersive window mode and a Flat screen mode for races.

iChris4 added a commit that referenced this pull request Oct 6, 2026
org.wiicompiled.vision is registered to the project's team, and an App ID
belongs to one team only, so the app could not be signed by anyone else.
The identifier now defaults to org.wiicompiled.vision.<team id>; a CMake
cache from before keeps the identifier it holds. --bundle-id on
Build-VisionOS.sh and Make-VisionOS-App.command chooses another, and
Make-VisionOS-App.command reads the built app's identifier back for the disc
copy and the launch instead of assuming the default.

Make-VisionOS-App.command also reads the signed-in teams from current Xcode
(IDEProvisioningTeamByIdentifier, beside the older IDEProvisioningTeams),
no longer ends silently under pipefail when neither key exists, and asks in
the Terminal for a team number or a pasted Team ID when it does not find
exactly one, so a double-clicked first build works.

Found while reviewing the AVP Ports Index install guide (#5).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@edgytoast

Copy link
Copy Markdown
Author

Tracking! I'll watch for the fix and get back to you on the view type. I want to think about it before returning a decision because it needs to balance a) accuracy on the view type for gamers and b) reusability across games so the field is a useful filter when users are looking for specific types of experiences. Please let me know if there's anything you need from me, and thank you for bringing this game to the people!

@edgytoast

Copy link
Copy Markdown
Author

The guide now uses --bundle-id and the current dotnet-sdk (db0604b), so it's ready to merge whenever you are. On the view type: the listing uses 6DoF immersive (races), 3D immersive (immersive window), and 2D (flat screen). Anything else you need from me to get this merged? Apologies for the few weeks of silence, my memory slipped and I forgot you were waiting on something from me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants